Kamon Prometheus is currently available for Scala 2.10, 2.11 and 2.12.
Supported releases and dependencies are shown below.
| kamon | status | jdk | scala |
|---|---|---|---|
| 1.0.0 | stable | 1.8+ | 2.10, 2.11, 2.12 |
First, add the dependency to your build. For SBT that would look like this:
libraryDependencies += "io.kamon" %% "kamon-prometheus" % "1.0.0"and for Maven:
<dependency>
<groupId>io.kamon</groupId>
<artifactId>kamon-prometheus_2.12</artifactId>
<version>1.0.0/version>
</dependency>Then, start the reporter when your application starts:
import kamon.prometheus.PrometheusReporter
Kamon.addReporter(new PrometheusReporter())
That's it! You can now go to `http://localhost:9095 and see the metrics. Check the reference.conf file for more details on what settings can be configured for the module.
Finally, all you need to do is configure a scrape configuration in Prometheus. The following snippet is a minimal example that shold work with the minimal server from the previous section.
A minimal Prometheus configuration snippet
------------------------------------------------------------------------------
scrape_configs:
- job_name: kamon-prometheus
static_configs:
- targets: ['localhost:9095']
------------------------------------------------------------------------------Kamon allows you to provide custom environment tags to all your metrics by configuring kamon.environment.tags in your application.conf, e.g.
kamon.environment.tags {
custom.id = "test1"
env = staging
}
In order to include these tags in your Prometheus metrics as well, you need to activate this feature for the PrometheusReporter by setting
kamon.prometheus.include-environment-tags = yes
in your application.conf as well, yielding, for example
# TYPE some_metric_seconds_total counter
some_metric_seconds_total{custom_id="test1",env="staging"} 10.0
# TYPE some_metric_seconds gauge
some_metric_seconds{custom_id="test1",env="staging"} 10.0
Note that environment tags always have precedence over any other custom tag that may have been set by the application at runtime.