Скачать или смотреть Adding Custom Labels to Default Spring Boot Actuator Metrics

Learn how to enhance your Spring Boot application metrics by adding custom labels to existing actuator metrics. Follow our detailed guide for Spring MVC and WebFlux.
---
This video is based on the question https://stackoverflow.com/q/70895802/ asked by the user 'JustAnotherDev' ( https://stackoverflow.com/u/18041255/ ) and on the answer https://stackoverflow.com/a/72131094/ provided by the user 'JustAnotherDev' ( https://stackoverflow.com/u/18041255/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Add custom labels to default spring boot actuator metrics

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Adding Custom Labels to Default Spring Boot Actuator Metrics

In the world of application monitoring, metrics play a crucial role in understanding application behavior and performance. For Spring Boot applications, the Actuator framework provides a convenient way to expose these metrics via endpoints, such as /actuator/prometheus. However, sometimes the default metrics do not meet all of our needs. A common requirement is to add custom labels to existing metrics. In this guide, we will explore how to add a custom label (e.g., challenge) based on the request payload to default actuator metrics.

The Problem

You might have encountered a scenario where your Spring Boot application exposes metrics with default configurations. For example, you see metrics like http_server_requests_seconds_bucket which already include various labels such as:

[[See Video to Reveal this Text or Code Snippet]]

Now, you want to add a custom label named challenge, which is dependent on the payload of the request, such as:

[[See Video to Reveal this Text or Code Snippet]]

To summarize, you want your metric to look like this:

[[See Video to Reveal this Text or Code Snippet]]

Given that the number of possible values for "type" is limited, we can safely add this tag without overwhelming the metrics. So how can you accomplish this in your Spring Boot application?

The Solution

To add custom labels to your actuator metrics, you need to extend existing classes that handle the tagging of metrics in Spring. The approach differs slightly depending on whether you are using Spring MVC or Spring WebFlux.

For Spring MVC Projects

If you are using Spring MVC, you can extend the DefaultWebMvcTagsProvider. Below is a step-by-step guide on how to implement this:

Create a custom class that extends DefaultWebMvcTagsProvider. This is where you will override the getTags method.

Add your custom tags within the getTags method. Here’s a basic example:

[[See Video to Reveal this Text or Code Snippet]]

Extracting Payload Information: You will need to implement a method to get the type from your request payload depending on how your application is set up. It can vary based on whether it’s a JSON request or form data.

For Spring WebFlux Projects

If your project is based on Spring WebFlux, the implementation is quite similar; instead of extending DefaultWebMvcTagsProvider, you will extend DefaultWebFluxTagsProvider. Here's how:

[[See Video to Reveal this Text or Code Snippet]]

Summary of Steps

Extend DefaultWebMvcTagsProvider or DefaultWebFluxTagsProvider depending on your framework.

Override the getTags method to add your custom tags based on the request payload.

Ensure you successfully extract the required information from the request payload.

Conclusion

Adding custom labels to default Spring Boot Actuator metrics allows for more tailored and insightful monitoring of your applications. By following the outlined steps for either Spring MVC or WebFlux, you can effectively enrich your monitoring experience by including relevant information from request payloads.

We hope this guide helps you to enhance your Spring Boot metrics. Happy coding!