Documentation for observability.metrics.enableMetrics truncated

[reknih]

Component(s)

operator, collector

What happened?

I am currently trying to wrap my head around how to let the OpenTelemetry Collector expose a ServiceMonitor. While doing so, I checked the API docs for the Collector CRD. In there, it contains the following description of the enableMetrics key:

EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. The operator.observability.

This description is obviously truncated. The issue apparently was introduced in PR #1983.

It would be great if the full docs entry could be added back as the instruction to enable the operator.observability.prometheus feature gate seems pretty vital to make use of this key.

Tangent: I'd really appreciate more thorough docs somewhere on how to set up the OTel Collector with its Prometheus exporter and a Service/PodMonitor!

Kubernetes Version

1.27.7

Operator version

v0.92.1

Collector version

v0.92.0

Environment information

Environment

Microsoft AKS

Log output

No response

Additional context

No response

[iblancasa]

Tangent: I'd really appreciate more thorough docs somewhere on how to set up the OTel Collector with its Prometheus exporter and a Service/PodMonitor!

When the feature gate is enabled and enableMetrics is true, the ServiceMonitor is created. You can check the E2E test to see an example configuration:

• https://github.com/open-telemetry/opentelemetry-operator/blob/main/tests/e2e-prometheuscr/create-sm-prometheus-exporters/02-install.yaml
• https://github.com/open-telemetry/opentelemetry-operator/blob/main/tests/e2e-prometheuscr/create-sm-prometheus-exporters/02-assert.yaml

I'm checking the issue