blob: b372e18fbb82f42a76d40f3f3e48250730f8e6aa [file] [log] [blame]
= Prometheus Trait
// Start of autogenerated code - DO NOT EDIT! (description)
The Prometheus trait configures a Prometheus-compatible endpoint. It also creates a `PodMonitor` resource,
so that the endpoint can be scraped automatically, when using the Prometheus operator.
The metrics are exposed using MicroProfile Metrics.
WARNING: The creation of the `PodMonitor` resource requires the https://github.com/coreos/prometheus-operator[Prometheus Operator]
custom resource definition to be installed.
You can set `pod-monitor` to `false` for the Prometheus trait to work without the Prometheus Operator.
The Prometheus trait is disabled by default.
This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**.
// End of autogenerated code - DO NOT EDIT! (description)
// Start of autogenerated code - DO NOT EDIT! (configuration)
== Configuration
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait prometheus.[key]=[value] --trait prometheus.[key2]=[value2] integration.groovy
----
The following configuration options are available:
[cols="2m,1m,5a"]
|===
|Property | Type | Description
| prometheus.enabled
| bool
| Can be used to enable or disable a trait. All traits share this common property.
| prometheus.pod-monitor
| bool
| Whether a `PodMonitor` resource is created (default `true`).
| prometheus.pod-monitor-labels
| []string
| The `PodMonitor` resource labels, applicable when `pod-monitor` is `true`.
|===
// End of autogenerated code - DO NOT EDIT! (configuration)