Coder Observability Chart

[!NOTE] This Helm chart is in BETA; use with caution

Overview

This chart contains a highly opinionated set of integrations between Grafana, Loki, Prometheus, Alertmanager, and Grafana Agent.

Dashboards, alerts, and runbooks are preconfigured for monitoring Coder installations.

Out of the box:

Metrics will be scraped from all pods which have a prometheus.io/scrape=true annotation.
Logs will be scraped from all pods in the Kubernetes cluster.

Installation

helm repo add coder-observability https://helm.coder.com/observability
helm upgrade --install coder-observability coder-observability/coder-observability --version 0.1.1 --namespace coder-observability --create-namespace

Requirements

General

• Helm 3.7+

Coder

Ensure these environment variables are set in your Coder deployment:

• CODER_PROMETHEUS_ENABLE=true
• CODER_PROMETHEUS_COLLECT_AGENT_STATS=true
• CODER_LOGGING_HUMAN=/dev/stderr (only human log format is supported currently; issue)

Ensure these labels exist on your Coder & provisioner deployments:

• prometheus.io/scrape=true
• prometheus.io/port=2112 (ensure this matches the port defined by CODER_PROMETHEUS_ADDRESS)

If you use the coder/coder helm chart, you can use the following:

coder:
  podAnnotations:
    prometheus.io/scrape: "true"
    prometheus.io/port: "2112"

For more details, see the coder documentation on exposing Prometheus metrics.

Postgres

You may configure the Helm chart to monitor your Coder deployment's Postgres server. Ensure that the resources created by this Helm chart can access your Postgres server.

Create a secret with your Postgres password and reference it as follows, along with the other connection details:

global:
  postgres:
    hostname: <your postgres server host>
    port: <postgres port>
    database: <coder database>
    username: <database username>
    mountSecret: <your secret name here>

The secret should be in the form of PGPASSWORD=<your password>, as this secret will be used to create an environment variable.

apiVersion: v1
kind: Secret
metadata:
  name: pg-secret
  namespace: coder-observability
data:
  PGPASSWORD: <base64-encoded password>

Grafana

To access Grafana, run:

kubectl -n coder-observability port-forward svc/grafana 3000:80

And open your web browser to http://localhost:3000/.

By default, Grafana is configured to allow anonymous access; if you want password authentication, define this in your values.yaml:

grafana:
  admin:
    existingSecret: grafana-admin
    userKey: username
    passwordKey: password
  grafana.ini:
    auth.anonymous:
      enabled: false

You will also need to define a secret as follows:

apiVersion: v1
kind: Secret
metadata:
  name: grafana-admin # this matches the "existingSecret" field above
stringData:
  username: "<your username>" # this matches the "userKey" field above
  password: "<your password>" # this matches the "passwordKey" field above

Subcharts

Each subchart can be disabled by setting the enabled field to false.

Values

The global values are the values which pertain to this chart, while the rest pertain to the subcharts. These values represent only the values set in this chart. For the full list of available values, please see each subchart.

For example, the grafana.replicas value is set by this chart by default, and is one of hundreds of available values which are defined here.