add comments

This commit is contained in:
Shreyas Goenka 2025-01-28 11:47:43 +01:00
parent bc5167392d
commit 6423fbb4aa
No known key found for this signature in database
GPG Key ID: 92A07DF49CCB0622
1 changed files with 14 additions and 3 deletions

View File

@ -2,9 +2,20 @@ package telemetry
// RequestBody is the request body type bindings for the /telemetry-ext API endpoint. // RequestBody is the request body type bindings for the /telemetry-ext API endpoint.
type RequestBody struct { type RequestBody struct {
UploadTime int64 `json:"uploadTime"` UploadTime int64 `json:"uploadTime"`
Items []string `json:"items"`
ProtoLogs []string `json:"protoLogs"` // DO NOT USE. This is the legacy field for logging in usage logs (not lumberjack).
// We keep this around because the API endpoint works only if this field is serialized
// to an empty array.
Items []string `json:"items"`
// JSON encoded strings containing the proto logs. Since it's represented as a
// string here, the values here end up being double JSON encoded in the final
// request body.
//
// Any logs here will be logged in our lumberjack tables as long as a corresponding
// protobuf is defined in universe.
ProtoLogs []string `json:"protoLogs"`
} }
// ResponseBody is the response body type bindings for the /telemetry-ext API endpoint. // ResponseBody is the response body type bindings for the /telemetry-ext API endpoint.