events/jsonmessage: add and prefer TimeNano for events
This way provide both Time and TimeNano in the event. For the display of the JSONMessage, use either, but prefer TimeNano Proving only TimeNano would break Subscribers that are using the `Time` field, so both are set for backwards compatibility. The events logging uses nano formatting, but only provides a Unix() time, therefor ordering may get lost in the output. Example: ``` 2015-09-15T14:18:51.000000000-04:00 ee46febd64ac629f7de9cd8bf58582e6f263d97ff46896adc5b508db804682da: (from busybox) resize 2015-09-15T14:18:51.000000000-04:00 a78c9149b1c0474502a117efaa814541926c2ae6ec3c76607e1c931b84c3a44b: (from busybox) resize ``` By having a field just for Nano time, when set, the marshalling back to `time.Unix(sec int64, nsec int64)` has zeros exactly where it needs to. This does not break any existing use of jsonmessage.JSONMessage, but now allows for use of `UnixNano()` and get event formatting that has distinguishable order. Example: ``` 2015-09-15T15:37:23.810295632-04:00 6adcf8ed9f5f5ec059a915466cd1cde86a18b4a085fc3af405e9cc9fecbbbbaf: (from busybox) resize 2015-09-15T15:37:23.810412202-04:00 6b7c5bfdc3f902096f5a91e628f21bd4b56e32590c5b4b97044aafc005ddcb0d: (from busybox) resize ``` Including tests for TimeNano and updated event API reference doc. Signed-off-by: Vincent Batts <vbatts@redhat.com>
This commit is contained in:
parent
8b9b50396c
commit
511ee61980
2 changed files with 29 additions and 5 deletions
|
@ -99,6 +99,7 @@ type JSONMessage struct {
|
||||||
ID string `json:"id,omitempty"`
|
ID string `json:"id,omitempty"`
|
||||||
From string `json:"from,omitempty"`
|
From string `json:"from,omitempty"`
|
||||||
Time int64 `json:"time,omitempty"`
|
Time int64 `json:"time,omitempty"`
|
||||||
|
TimeNano int64 `json:"timeNano,omitempty"`
|
||||||
Error *JSONError `json:"errorDetail,omitempty"`
|
Error *JSONError `json:"errorDetail,omitempty"`
|
||||||
ErrorMessage string `json:"error,omitempty"` //deprecated
|
ErrorMessage string `json:"error,omitempty"` //deprecated
|
||||||
}
|
}
|
||||||
|
@ -121,7 +122,9 @@ func (jm *JSONMessage) Display(out io.Writer, isTerminal bool) error {
|
||||||
} else if jm.Progress != nil && jm.Progress.String() != "" { //disable progressbar in non-terminal
|
} else if jm.Progress != nil && jm.Progress.String() != "" { //disable progressbar in non-terminal
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if jm.Time != 0 {
|
if jm.TimeNano != 0 {
|
||||||
|
fmt.Fprintf(out, "%s ", time.Unix(0, jm.TimeNano).Format(timeutils.RFC3339NanoFixed))
|
||||||
|
} else if jm.Time != 0 {
|
||||||
fmt.Fprintf(out, "%s ", time.Unix(jm.Time, 0).Format(timeutils.RFC3339NanoFixed))
|
fmt.Fprintf(out, "%s ", time.Unix(jm.Time, 0).Format(timeutils.RFC3339NanoFixed))
|
||||||
}
|
}
|
||||||
if jm.ID != "" {
|
if jm.ID != "" {
|
||||||
|
|
|
@ -53,7 +53,7 @@ func TestProgress(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestJSONMessageDisplay(t *testing.T) {
|
func TestJSONMessageDisplay(t *testing.T) {
|
||||||
now := time.Now().Unix()
|
now := time.Now()
|
||||||
messages := map[JSONMessage][]string{
|
messages := map[JSONMessage][]string{
|
||||||
// Empty
|
// Empty
|
||||||
JSONMessage{}: {"\n", "\n"},
|
JSONMessage{}: {"\n", "\n"},
|
||||||
|
@ -66,13 +66,34 @@ func TestJSONMessageDisplay(t *testing.T) {
|
||||||
},
|
},
|
||||||
// General
|
// General
|
||||||
JSONMessage{
|
JSONMessage{
|
||||||
Time: now,
|
Time: now.Unix(),
|
||||||
ID: "ID",
|
ID: "ID",
|
||||||
From: "From",
|
From: "From",
|
||||||
Status: "status",
|
Status: "status",
|
||||||
}: {
|
}: {
|
||||||
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(now, 0).Format(timeutils.RFC3339NanoFixed)),
|
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(now.Unix(), 0).Format(timeutils.RFC3339NanoFixed)),
|
||||||
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(now, 0).Format(timeutils.RFC3339NanoFixed)),
|
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(now.Unix(), 0).Format(timeutils.RFC3339NanoFixed)),
|
||||||
|
},
|
||||||
|
// General, with nano precision time
|
||||||
|
JSONMessage{
|
||||||
|
TimeNano: now.UnixNano(),
|
||||||
|
ID: "ID",
|
||||||
|
From: "From",
|
||||||
|
Status: "status",
|
||||||
|
}: {
|
||||||
|
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(0, now.UnixNano()).Format(timeutils.RFC3339NanoFixed)),
|
||||||
|
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(0, now.UnixNano()).Format(timeutils.RFC3339NanoFixed)),
|
||||||
|
},
|
||||||
|
// General, with both times Nano is preferred
|
||||||
|
JSONMessage{
|
||||||
|
Time: now.Unix(),
|
||||||
|
TimeNano: now.UnixNano(),
|
||||||
|
ID: "ID",
|
||||||
|
From: "From",
|
||||||
|
Status: "status",
|
||||||
|
}: {
|
||||||
|
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(0, now.UnixNano()).Format(timeutils.RFC3339NanoFixed)),
|
||||||
|
fmt.Sprintf("%v ID: (from From) status\n", time.Unix(0, now.UnixNano()).Format(timeutils.RFC3339NanoFixed)),
|
||||||
},
|
},
|
||||||
// Stream over status
|
// Stream over status
|
||||||
JSONMessage{
|
JSONMessage{
|
||||||
|
|
Loading…
Reference in a new issue