-
Notifications
You must be signed in to change notification settings - Fork 496
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add CallCounter details in telemetry docs #3515
Conversation
Signed-off-by: Andrew Harding <[email protected]>
doc/telemetry.md
Outdated
- A counter representing the number of calls using the call counter key | ||
- A sample of the elapsed time for the call using the call counter key+`".elapsed_time"` | ||
|
||
Additionally, the metrics emitted above each carry a `status` label (in addition to any other labels for specific to the individual call counter) that holds the gRPC status of the call. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be a good enhancement to add a link to the gRPC status documentation (https://pkg.go.dev/google.golang.org/[email protected]/codes#Code I think).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good suggestion!
For the available RPCs, I think we should refer to the (currently lacking) documentation in the SPIRE API SDK. I'll update this change with a link to that repository, but in my opinion that is the place where we should focus documentation efforts for the API. |
Signed-off-by: Andrew Harding <[email protected]>
That'd be awesome. I suggested those only because I was unaware of where else to look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @azdagron!
Signed-off-by: Andrew Harding <[email protected]>
No description provided.