Enabling metrics collection

Info

The following steps were tested only in OpenShift environments.
For other kubernetes distributions (eks, minikube, kind ,etc) the instructions can be different and were not tested by Pulp team yet.

Pulp operator allows to enable Pulp metrics collection using the OpenTelemetry Framework and exposing them to Prometheus.

Prerequisites

• the monitoring for user-defined projects should be enabled
• a ServiceMonitor resource should be available

Example of a ServiceMonitor:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  labels:
    k8s-app: prometheus-example-monitor
  name: prometheus-example-monitor
spec:
  endpoints:
  - interval: 30s
    port: otel-8889
    scheme: http
  selector:
    matchLabels:
      otel: ""

Configuring

To enable telemetry, configure Pulp operator CR with the following fields:

...
spec:
  telemetry:
    enabled: true
...