Prometheus provider
Last updated
Was this helpful?
Last updated
Was this helpful?
The Prometheus provider collects metrics from a Prometheus instance and makes them available to Akamas.
This provider includes support for several technologies. In any case, you can specify your own queries to gather any metric you want.
This section provides the minimum requirements that you should match before using the Prometheus provider.
Prometheus 1.x and 2.x.
Prometheus is reachable at a provided URL or IP address and port (the default Prometheus port is 9090)
(Linux system metrics)
(Java metrics)
(Docker container metrics)
exporter (AWS resources metrics)
(Web application metrics)
Versions < 2.0.0 are compatibile with Akamas untill version 1.8.0
Versions >= 2.0.0 are compatible with Akamas from version 1.9.0
Ubuntu-16.04, Rhel-7.6
java-openjdk-8, java-openjdk-11
java-ibm-j9vm-6, java-ibm-j9vm-8, java-eclipse-openj9-11
Container
ec2
Web Application
The Prometheus provider does not require a specific configuration of the Prometheus instance it uses, except for the need for setting the value of the instance
label of each data point so that it matches the value of the instance
property in a component; in this way, the Prometheus provider can know which data point refers to which component in a system.
Here’s an example configuration for Prometheus that sets the instance
label:
Akamas reasons in terms of a system to be optimized and in terms of parameters and metrics of components of that system. To understand which metrics collected from Prometheus should refer to which component, the Prometheus provider looks up some properties in the components of a system grouped under prometheus
property. These properties are:
instance
, which tells the provider "where" a component is
job
(optional), which filters the imported metrics by exporter identifier, useful when different components run on the same instance. If not provided, this value defaults to the one configured globally in the telemetry-instance definition.
Nested under this property you can also include any additional field your use case may require to further filter the imported metrics. These fields will be appended in queries to the list of label matches in the form field_name=~'field_value'
, and can specify either exact values or patterns.
It is important that you add instance
and, optionally, the job
properties to the components of a system so that the Prometheus provider can gather metrics from them:
You can check to see how component-types metrics are extracted by this provider
Notice: you should configure your Prometheus instances so that the Prometheus provider can leverage the instance
property of components, as described in the section here above.