diff --git a/instrumentation/events-redesign.md b/instrumentation/events-redesign.md index 4355e1adadb..6540d61fb09 100644 --- a/instrumentation/events-redesign.md +++ b/instrumentation/events-redesign.md @@ -100,13 +100,13 @@ We'd like to propose following structure in Events object in the new events API ```golang type Event struct { -// + // // Time when this Event was first observed. EventTime metav1.MicroTime // Data about the Event series this event represents or nil if it's -// a singleton Event. + // a singleton Event. // +optional Series *EventSeries @@ -123,7 +123,7 @@ type Event struct { Reason string // The object this Event is “about”. In most cases it's the object that the -// given controller implements. + // given controller implements. // +optional Regarding ObjectReference @@ -132,24 +132,24 @@ type Event struct { Related *ObjectReference // Human readable description of the Event. Possibly discarded when and -// Event series is being deduplicated. + // Event series is being deduplicated. // +optional Note string // Type of this event (Normal, Warning), new types could be added in the -// future. -// +optional -Type string + // future. + // +optional + Type string } type EventSeries struct { -Count int32 -LastObservedTime MicroTime -State EventSeriesState + Count int32 + LastObservedTime MicroTime + State EventSeriesState } const ( -EventSeriesStateOngoing = "Ongoing" + EventSeriesStateOngoing = "Ongoing" EventSeriesStateFinished = "Finished" EventSeriesStateUnknown = "Unknown" )