Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The A1 Policy Management Service Spring Boot application exposes some management endpoints including loggers, metrics, Prometheus, and so on...
All these endpoints are enabled by Spring Boot Actuator dependency. When this dependency is added in pom.xml, it will expose counters and statistics, which can then be managed from application.yaml
(See Montreal New Delhi - Component configuration) for more details on configuration, and the application.yaml file)

Code Block
languageyml
titleSnippet from application.yaml
......
management:
  endpoints:
    web:
      exposure:
        # Enabling of springboot actuator features. See springboot documentation.
        include: "loggers,logfile,health,info,metrics,threaddump,heapdump,prometheus"
......

Note: By default Prometheus endpoint is disabled. To enable it add ",prometheus" in the application.yaml of a1pms.

The metrics actuator makes several metrics available. These metrics include numerous built-in springboot metrics, and several new A1-specific metrics.
In order to access the exposed metrics, you need to form an URL and append metric's name end of the URL like below:

Prometheus Statistics

Prometheus is time-series database, which stores a sequence of data points, across time. It’s generally used to store metrics and performance data from your applications.

...

An example of Prometheus statistics:

Prometheus UI


If you want to collect and visualize Prometheus' statistics in Prometheus GUI, this can be configured in a  'prometheus.yml' Prometheus configuration file, similar to the example below.
This sample shows how Prometheus can periodically scrape the available metrics and make them available.

...