RSDK-8819: FTDC file format. #4432
Conversation
viambot
added
the
safe to test
|
|
||
| // We now have fields, e.g: ["metric1.Foo", "metric1.Bar", "metric2.Foo"]. The `mapOrder` should | ||
| // be ["metric1", "metric2"]. It's undefined behavior for a `mapOrder` metric name key to be | ||
| // split around a different metric name. E.g: ["metric1.Alpha", "metric2.Beta", |
There was a problem hiding this comment.
I don't think I would have parsed that the schema columns MUST have one level of nesting. Can we write that somewhere in the explanation? I would have thought that writing ["alpha", "matric1.beta", "gamma"] would be acceptable.
There was a problem hiding this comment.
Similar where I'd like to talk offline about options. The file format doesn't require this at all. But the usage (being map[string]any) does result in this small translation. Maybe I shouldn't have put it in this "custom format" code and rather left it as part of the caller's responsibility.
There was a problem hiding this comment.
cool, lets chat about this in the in person chat
|
|
||
| // We now have fields, e.g: ["metric1.Foo", "metric1.Bar", "metric2.Foo"]. The `mapOrder` should | ||
| // be ["metric1", "metric2"]. It's undefined behavior for a `mapOrder` metric name key to be | ||
| // split around a different metric name. E.g: ["metric1.Alpha", "metric2.Beta", |
There was a problem hiding this comment.
Similar where I'd like to talk offline about options. The file format doesn't require this at all. But the usage (being map[string]any) does result in this small translation. Maybe I shouldn't have put it in this "custom format" code and rather left it as part of the caller's responsibility.
There was a problem hiding this comment.
It feels like @nicksanford has given this a solid review, and the general concept makes sense to me. I did not give this a solid review (i.e. line-by-line). I could do that, but I would need to meet with you synchronously 😆 , @dgottlieb, to walk through it . I don't want to slow down your development, though, and trust that this is probably fine to start accessing with another, incoming PR. Will approve for now.
| fieldOrder []string | ||
| } | ||
|
|
||
| // writeSchema writes down names for metrics in the form of a json array. All subsequent calls to |
There was a problem hiding this comment.
You could put some of this documentation in a doc.go file for the package. Might be nice to have a more obvious place for the description of the format.
There was a problem hiding this comment.
That's a good idea! Hadn't occurred to me
ftdc/custom_format.go
Outdated
| // - Only write metric names when things change. | ||
| // - Minimize how much space is used to write out a value that hasn't changed. | ||
| // | ||
| // Using a pseudo EBNF notation, an FTDC file is: |
There was a problem hiding this comment.
ENBF
Been a while since I've heard that 😆 . Nice.
viambot
added
safe to test
viambot
added
safe to test
viambot
added
safe to test
viambot
added
safe to test
No description provided.