Chapter 5. Monitoring CodeReady Workspaces

Prerequisites

• CodeReady Workspaces is exposing metrics on port 8087. See Enabling and exposing CodeReady Workspaces metrics.
• Prometheus 2.9.1 or later is running. The Prometheus console is running on port 9090 with a corresponding service and route. See First steps with Prometheus.

Procedure

• Configure Prometheus to scrape metrics from the 8087 port:

  Example 5.1. Prometheus configuration example

  apiVersion: v1
  kind: ConfigMap
  metadata:
    name: prometheus-config
  data:
    prometheus.yml: |-
        global:
          scrape_interval:     5s             

  1

  
          evaluation_interval: 5s             

  2

  
        scrape_configs:                       

  3

  
          - job_name: 'che'
            static_configs:
              - targets: ['[che-host]:8087']  

  4

  Copy to Clipboard Toggle word wrap

  1

  Rate, at which a target is scraped.

  2

  Rate, at which recording and alerting rules are re-checked (not used in the system at the moment).

  3

  Resources Prometheus monitors. In the default configuration, a single job called che, scrapes the time series data exposed by the CodeReady Workspaces server.

  4

  Scrape metrics from the 8087 port.

Verification steps

• Use the Prometheus console to query and view metrics.

  Metrics are available at: http://<che-server-url>:9090/metrics.

  For more information, see Using the expression browser.

Additional resources

• First steps with Prometheus.
• Configuring Prometheus.
• Querying Prometheus.
• Prometheus metric types.