/module-ballerinax-prometheus

Ballerina Prometheus Observability Extension Module

Primary LanguageJavaApache License 2.0Apache-2.0

Ballerina Prometheus Observability Extension

Build GitHub Last Commit License codecov

Building from the Source

Setting Up the Prerequisites

  1. Download and install Java SE Development Kit (JDK) version 17 (from one of the following locations).

    • Oracle

    • OpenJDK

      Note: Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

Building the Source

Execute the commands below to build from source.

  1. To build the library:

     ./gradlew clean build

  2. To run the integration tests:

     ./gradlew clean test

Available Metrics

The exporter provides the following metrics.

Metric Name Description
response_time_seconds_value Response time of a request in seconds
response_time_seconds_max Maximum response time of a request
response_time_seconds_min Minimum response time of a request
response_time_seconds_mean Average response time of a request
response_time_seconds_stdDev Standard deviation of response time of a request
response_time_seconds Summary of request-response times across various time frames and quantiles
response_time_nanoseconds_total_value Total response time for all requests
requests_total_value Total number of requests
response_errors_total_value Total number of response errors
inprogress_requests_value Total number of inprogress requests
kafka_publishers_value Number of publishers in kafka
kafka_consumers_value Number of consumers in kafka
kafka_errors_value Number of errors happened while publishing in kafka

Contributing to Ballerina

As an open source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of Conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful Links