Skip to content

Add a list of observations produced by Spring Framework #30060

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

Closed
dambott opened this issue Mar 1, 2023 · 6 comments
Closed

Add a list of observations produced by Spring Framework #30060

dambott opened this issue Mar 1, 2023 · 6 comments
Assignees
Labels
theme: observability An issue related to observability and tracing type: documentation A documentation task
Milestone

Comments

@dambott
Copy link

dambott commented Mar 1, 2023

Affects: <Spring Framework version>
All versions

Please add a comprehensive list of metrics that are generated by the framework so they can be properly understood by anyone trying to use them.
For reference, please see:
https://kubernetes.io/docs/reference/instrumentation/metrics/
and this:
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing_metrics_with_cloudwatch.html
for the type of thing I am looking for.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Mar 1, 2023
@bclozel
Copy link
Member

bclozel commented Mar 1, 2023

This should be covered by this section in the reference documentation.

https://docs.spring.io/spring-framework/docs/current/reference/html/integration.html#integration.observability.http-server

Please let us know is something is missing.

@bclozel bclozel added status: waiting-for-feedback We need additional information before we can continue theme: observability An issue related to observability and tracing labels Mar 1, 2023
@spring-projects-issues
Copy link
Collaborator

If you would like us to look at this issue, please provide the requested information. If the information is not provided within the next 7 days this issue will be closed.

@spring-projects-issues spring-projects-issues added the status: feedback-reminder We've sent a reminder that we need additional information before we can continue label Mar 8, 2023
@spring-projects-issues
Copy link
Collaborator

Closing due to lack of requested feedback. If you would like us to look at this issue, please provide the requested information and we will re-open the issue.

@spring-projects-issues spring-projects-issues closed this as not planned Won't fix, can't repro, duplicate, stale Mar 15, 2023
@spring-projects-issues spring-projects-issues removed status: waiting-for-feedback We need additional information before we can continue status: feedback-reminder We've sent a reminder that we need additional information before we can continue status: waiting-for-triage An issue we've not yet triaged or decided on labels Mar 15, 2023
@dambott
Copy link
Author

dambott commented Mar 15, 2023

The referenced section does NOT provide the detail I requested. There's no list of metrics or their meanings there. Please provide something like the links I provided.

@bclozel
Copy link
Member

bclozel commented Mar 15, 2023

We're not creating metrics per se, we're creating observations. Those observations can then be exported as timer metrics or traces or anything else really, depending on the ObservationHandler instances configured with your registry.

We don't have much there right now, but we'll expand that in the future. Would the following table fill that need?

Observation name Description
"http.client.requests" Time spent for HTTP client exchanges
"http.server.requests" Processing time for HTTP server exchanges at the Framework level

@bclozel bclozel changed the title Please create a list of metrics and their meanings/use Add a list of observations produced by Spring Framework Mar 17, 2023
@bclozel bclozel added the type: documentation A documentation task label Mar 17, 2023
@bclozel bclozel self-assigned this Mar 17, 2023
@bclozel bclozel added this to the 6.0.7 milestone Mar 17, 2023
@bclozel
Copy link
Member

bclozel commented Mar 17, 2023

Reopening to add a table similar to the one above.

@bclozel bclozel reopened this Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme: observability An issue related to observability and tracing type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

3 participants