From f0bf09d0c09bc8b85336f48415be0c1c9b21a3ab Mon Sep 17 00:00:00 2001 From: Stanislav Khalash Date: Tue, 22 Oct 2024 12:52:17 +0200 Subject: [PATCH] docs: Fix MetricPipeline input docs (#1540) Co-authored-by: Andreas Thaler --- apis/telemetry/v1alpha1/metricpipeline_types.go | 4 ++-- .../bases/telemetry.kyma-project.io_metricpipelines.yaml | 8 ++++---- .../bases/telemetry.kyma-project.io_metricpipelines.yaml | 8 ++++---- docs/user/resources/05-metricpipeline.md | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/apis/telemetry/v1alpha1/metricpipeline_types.go b/apis/telemetry/v1alpha1/metricpipeline_types.go index 56e181bb8..830c142c6 100644 --- a/apis/telemetry/v1alpha1/metricpipeline_types.go +++ b/apis/telemetry/v1alpha1/metricpipeline_types.go @@ -82,7 +82,7 @@ type MetricPipelineInput struct { // MetricPipelinePrometheusInput defines the Prometheus scraping section. type MetricPipelinePrometheusInput struct { - // If enabled, Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. + // If enabled, Services and Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. Enabled bool `json:"enabled,omitempty"` // Describes whether Prometheus metrics from specific namespaces are selected. System namespaces are disabled by default. // +optional @@ -145,7 +145,7 @@ type MetricPipelineRuntimeInputResourceDisabledByDefault struct { // MetricPipelineIstioInput defines the Istio scraping section. type MetricPipelineIstioInput struct { - // If enabled, metrics for istio-proxy containers are scraped from Pods that have had the istio-proxy sidecar injected. The default is `false`. + // If enabled, istio-proxy metrics are scraped from Pods that have the istio-proxy sidecar injected. The default is `false`. Enabled bool `json:"enabled,omitempty"` // Describes whether istio-proxy metrics from specific namespaces are selected. System namespaces are enabled by default. // +optional diff --git a/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml b/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml index b54a257a6..36fd9baca 100644 --- a/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml +++ b/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml @@ -74,9 +74,9 @@ spec: type: boolean type: object enabled: - description: If enabled, metrics for istio-proxy containers - are scraped from Pods that have had the istio-proxy sidecar - injected. The default is `false`. + description: If enabled, istio-proxy metrics are scraped from + Pods that have the istio-proxy sidecar injected. The default + is `false`. type: boolean namespaces: description: Describes whether istio-proxy metrics from specific @@ -146,7 +146,7 @@ spec: type: boolean type: object enabled: - description: If enabled, Pods marked with `prometheus.io/scrape=true` + description: If enabled, Services and Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. type: boolean namespaces: diff --git a/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml b/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml index b01a0828e..c28be306f 100644 --- a/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml +++ b/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml @@ -74,9 +74,9 @@ spec: type: boolean type: object enabled: - description: If enabled, metrics for istio-proxy containers - are scraped from Pods that have had the istio-proxy sidecar - injected. The default is `false`. + description: If enabled, istio-proxy metrics are scraped from + Pods that have the istio-proxy sidecar injected. The default + is `false`. type: boolean namespaces: description: Describes whether istio-proxy metrics from specific @@ -146,7 +146,7 @@ spec: type: boolean type: object enabled: - description: If enabled, Pods marked with `prometheus.io/scrape=true` + description: If enabled, Services and Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. type: boolean namespaces: diff --git a/docs/user/resources/05-metricpipeline.md b/docs/user/resources/05-metricpipeline.md index 246d3c3f5..9838999a7 100644 --- a/docs/user/resources/05-metricpipeline.md +++ b/docs/user/resources/05-metricpipeline.md @@ -72,7 +72,7 @@ For details, see the [MetricPipeline specification file](https://github.com/kyma | **input.​istio** | object | Configures istio-proxy metrics scraping. | | **input.​istio.​diagnosticMetrics** | object | Configures diagnostic metrics scraping | | **input.​istio.​diagnosticMetrics.​enabled** | boolean | If enabled, diagnostic metrics are scraped. The default is `false`. | -| **input.​istio.​enabled** | boolean | If enabled, metrics for istio-proxy containers are scraped from Pods that have had the istio-proxy sidecar injected. The default is `false`. | +| **input.​istio.​enabled** | boolean | If enabled, istio-proxy metrics are scraped from Pods that have the istio-proxy sidecar injected. The default is `false`. | | **input.​istio.​namespaces** | object | Describes whether istio-proxy metrics from specific namespaces are selected. System namespaces are enabled by default. | | **input.​istio.​namespaces.​exclude** | \[\]string | Exclude metrics from the specified Namespace names only. | | **input.​istio.​namespaces.​include** | \[\]string | Include metrics from the specified Namespace names only. | @@ -84,7 +84,7 @@ For details, see the [MetricPipeline specification file](https://github.com/kyma | **input.​prometheus** | object | Configures Prometheus scraping. | | **input.​prometheus.​diagnosticMetrics** | object | Configures diagnostic metrics scraping | | **input.​prometheus.​diagnosticMetrics.​enabled** | boolean | If enabled, diagnostic metrics are scraped. The default is `false`. | -| **input.​prometheus.​enabled** | boolean | If enabled, Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. | +| **input.​prometheus.​enabled** | boolean | If enabled, Services and Pods marked with `prometheus.io/scrape=true` annotation are scraped. The default is `false`. | | **input.​prometheus.​namespaces** | object | Describes whether Prometheus metrics from specific namespaces are selected. System namespaces are disabled by default. | | **input.​prometheus.​namespaces.​exclude** | \[\]string | Exclude metrics from the specified Namespace names only. | | **input.​prometheus.​namespaces.​include** | \[\]string | Include metrics from the specified Namespace names only. |