The Prometheus Observability Extension is one of the metrics extensions of the Ballerina language.

It provides an implementation for exporting metrics to a Prometheus Server.

To package the Prometheus extension into the Jar, follow the following steps.

1. Add the following import to your program.

import ballerinax/prometheus as _;

2. Add the following to the Ballerina.toml when building your program.

[package]
org = "my_org"
name = "my_package"
version = "1.0.0"

[build-options]
observabilityIncluded=true

To enable the extension and export metrics to Prometheus, add the following to the Config.toml when running your program.

[ballerina.observe]
metricsEnabled=true
metricsReporter="prometheus"

[ballerinax.prometheus]
host="127.0.0.1"  # Optional Configuration. Default value is localhost
port=9797         # Optional Configuration. Default value is 9797

1. Download and install Java SE Development Kit (JDK) version 11 (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.

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
   

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

For more information, go to the contribution guidelines.

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

• Discuss about code changes of the Ballerina project in [email protected].
• Chat live with us via our Slack channel.
• Post all technical questions on Stack Overflow with the #ballerina tag.
• View the Ballerina performance test results.