This is an automated email from the ASF dual-hosted git repository. astefanutti pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel-k.git
The following commit(s) were added to refs/heads/master by this push: new b9fb481 update prometheus trait doc with quarkus as default runtime b9fb481 is described below commit b9fb481a373fecec7f42952a3401489ba2febb69 Author: Stephen McCarthy <stmcc...@redhat.com> AuthorDate: Tue Oct 20 18:53:25 2020 +0100 update prometheus trait doc with quarkus as default runtime --- deploy/traits.yaml | 2 +- docs/modules/traits/pages/prometheus.adoc | 15 ++++++++------- pkg/trait/prometheus.go | 15 ++++++++------- 3 files changed, 17 insertions(+), 15 deletions(-) diff --git a/deploy/traits.yaml b/deploy/traits.yaml index 517a155..c4783c7 100755 --- a/deploy/traits.yaml +++ b/deploy/traits.yaml @@ -479,7 +479,7 @@ traits: - Kubernetes - Knative - OpenShift - description: 'The Prometheus trait configures a Prometheus-compatible endpoint. It also exposes the integration with a `Service` and a `ServiceMonitor` resources, so that the endpoint can be scraped automatically, when using the Prometheus operator. The metrics exposed vary depending on the configured runtime. With Quarkus, the metrics are exposed using MicroProfile Metrics. While with the default runtime, they are exposed using the Prometheus JMX exporter. WARNING: The creation of the [...] + description: 'The Prometheus trait configures a Prometheus-compatible endpoint. This trait also exposes the integration with `Service` and `ServiceMonitor` resources, so that the endpoint can be scraped automatically, when using the Prometheus Operator. The metrics exposed vary depending on the configured runtime. With the default Quarkus runtime, metrics are exposed using MicroProfile Metrics. While with the Java main runtime, metrics are exposed using the Prometheus JMX exporter. WAR [...] properties: - name: enabled type: bool diff --git a/docs/modules/traits/pages/prometheus.adoc b/docs/modules/traits/pages/prometheus.adoc index 595aa63..90beefd 100755 --- a/docs/modules/traits/pages/prometheus.adoc +++ b/docs/modules/traits/pages/prometheus.adoc @@ -1,18 +1,19 @@ = Prometheus Trait // Start of autogenerated code - DO NOT EDIT! (description) -The Prometheus trait configures a Prometheus-compatible endpoint. It also exposes the integration with a `Service` -and a `ServiceMonitor` resources, so that the endpoint can be scraped automatically, when using the Prometheus -operator. +The Prometheus trait configures a Prometheus-compatible endpoint. This trait also exposes the integration with +`Service` and `ServiceMonitor` resources, so that the endpoint can be scraped automatically, when using the +Prometheus Operator. -The metrics exposed vary depending on the configured runtime. With Quarkus, the metrics are exposed -using MicroProfile Metrics. While with the default runtime, they are exposed using the Prometheus JMX exporter. +The metrics exposed vary depending on the configured runtime. With the default Quarkus runtime, metrics are +exposed using MicroProfile Metrics. While with the Java main runtime, metrics are exposed using the Prometheus +JMX exporter. WARNING: The creation of the `ServiceMonitor` resource requires the https://github.com/coreos/prometheus-operator[Prometheus Operator] custom resource definition to be installed. -You can set `service-monitor` to `false` for the Prometheus trait to work without the Prometheus operator. +You can set `service-monitor` to `false` for the Prometheus trait to work without the Prometheus Operator. -It's disabled by default. +The Prometheus trait is disabled by default. This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**. diff --git a/pkg/trait/prometheus.go b/pkg/trait/prometheus.go index 8db0f0e..fc7d91e 100644 --- a/pkg/trait/prometheus.go +++ b/pkg/trait/prometheus.go @@ -34,18 +34,19 @@ import ( "github.com/apache/camel-k/pkg/util" ) -// The Prometheus trait configures a Prometheus-compatible endpoint. It also exposes the integration with a `Service` -// and a `ServiceMonitor` resources, so that the endpoint can be scraped automatically, when using the Prometheus -// operator. +// The Prometheus trait configures a Prometheus-compatible endpoint. This trait also exposes the integration with +//`Service` and `ServiceMonitor` resources, so that the endpoint can be scraped automatically, when using the +// Prometheus Operator. // -// The metrics exposed vary depending on the configured runtime. With Quarkus, the metrics are exposed -// using MicroProfile Metrics. While with the default runtime, they are exposed using the Prometheus JMX exporter. +// The metrics exposed vary depending on the configured runtime. With the default Quarkus runtime, metrics are +// exposed using MicroProfile Metrics. While with the Java main runtime, metrics are exposed using the Prometheus +// JMX exporter. // // WARNING: The creation of the `ServiceMonitor` resource requires the https://github.com/coreos/prometheus-operator[Prometheus Operator] // custom resource definition to be installed. -// You can set `service-monitor` to `false` for the Prometheus trait to work without the Prometheus operator. +// You can set `service-monitor` to `false` for the Prometheus trait to work without the Prometheus Operator. // -// It's disabled by default. +// The Prometheus trait is disabled by default. // // +camel-k:trait=prometheus type prometheusTrait struct {