Skip to content
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

Merged
merged 2 commits into from
Oct 20, 2022

Conversation

azdagron
Copy link
Member

No description provided.

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.
Copy link
Contributor

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).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion!

@azdagron
Copy link
Member Author

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]>
@keeganwitt
Copy link
Contributor

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.

That'd be awesome. I suggested those only because I was unaware of where else to look.

@azdagron azdagron added this to the 1.5.0 milestone Oct 20, 2022
Copy link
Member

@amartinezfayo amartinezfayo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @azdagron!

@azdagron azdagron merged commit dc64066 into spiffe:main Oct 20, 2022
@azdagron azdagron deleted the embellish-call-counter-docs branch October 20, 2022 22:26
stevend-uber pushed a commit to stevend-uber/spire that referenced this pull request Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants