Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-4992

Provide definitions and lists for all Metrics collected in an OpenShift Deployment

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Duplicate
    • Icon: Undefined Undefined
    • None
    • None
    • Monitoring
    • None
    • ---
    • ---

      Summary:
      --------
      OpenShift provides a unified experience for deploying and managing workloads. It does this by collecting a number of useful tools, such as HAProxy or node_exporter and deploys these sub-projects in an opinionated way to provide the best experience possible.

      These 'sub-projects' are provided in a core-OpenShift install and are monitored by the Prometheus deployment, which scrapes a number of metrics endpoints for monitoring in the OpenShift Web Console.

      Many of the collected metrics have no references in the OpenShift documentation. Some of the metrics are documented in the sub-projects documentation but many are only documented in the code of the sub-project.[1]

      Customers should not be expected to be familiar with the sub-projects at the code-level to effectively manage an OpenShift cluster.

      Request:
      --------
      Provide a unified document in the OpenShift documentation which lists all of the scraped and provided metrics in a normal OpenShift deployment (excluding any additional operators/tool deployments).

      Provide clear and concise descriptions of what the metric is measuring and what the metric type is. (i.e. counter, guage, etc) [0]

      Resources:
      [0] Prometheus Data Types:
      https://prometheus.io/docs/concepts/metric_types/
      [1] Example of un-documented metrics
      https://github.com/prometheus/haproxy_exporter/blob/main/haproxy_exporter.go#L138-L236
      [2] Example of documented metrics
      https://github.com/kubernetes/kube-state-metrics/blob/main/docs/pod-metrics.md

            cbremble@redhat.com Claire Bremble
            rhn-support-mwasher Michael Washer
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: