Integrate with the Canonical Observability Stack (COS)¶

This document shows how to integrate the different components of the Canonical Identity platform with the Canonical Observability Stack (COS) to enable the pre-configured dashboards and alerting rules.

The Canonical Observability Stack (COS-Lite) is a Juju bundle that includes a series of open source observability applications and related automation. For the complete list of components in the COS, read the Component List.

Prerequisites¶

A running COS-Lite bundle. You can follow the Getting started on MicroK8s tutorial to get you started. Make sure to follow the section Deploy the COS Lite bundle with overlays sections.
A running Canonical Identity Platform. Please refer to the tutorial.

It is generally recommended to keep the observability stack separate from any observed applications to separate failure domains. This document assumes that the Identity Platform and the COS bundles are deployed to different models.

Integration approaches¶

There are two possible integration approaches depending on your networking and deployment setup:

Direct Integration: If you are able to send metrics and logs directly to the observability platform components, follow the Integrate the Identity Platform charms with COS-Lite section.
Telemetry Collector: If you prefer using a telemetry collector component (often used for OIDC-compliant applications in restricted networks), follow the Integrate the Identity Platform charms with COS-Lite through Grafana Agent section.

Integrate the Identity Platform charms with COS-Lite¶

Grafana integration¶

Assuming you deployed the COS-Lite bundle in model cos-model with user admin, use the following commands to integrate the Identity applications by means of an application offer:

juju integrate kratos admin/cos-model.grafana-dashboards
juju integrate hydra admin/cos-model.grafana-dashboards
juju integrate identity-platform-login-ui-operator admin/cos-model.grafana-dashboards
juju integrate traefik-admin admin/cos-model.grafana-dashboards
juju integrate traefik-public admin/cos-model.grafana-dashboards

Loki integration¶

Assuming you deployed the COS-Lite bundle in model cos-model with user admin, use the following commands to integrate the Identity applications by means of an application offer:

juju integrate kratos admin/cos-model.loki-logging
juju integrate hydra admin/cos-model.loki-logging
juju integrate identity-platform-login-ui-operator admin/cos-model.loki-logging
juju integrate traefik-admin admin/cos-model.loki-logging
juju integrate traefik-public admin/cos-model.loki-logging

Prometheus integration¶

Assuming you deployed the COS-Lite bundle in model cos-model with user admin, use the following commands to integrate the Identity applications by means of an application offer:

juju integrate kratos admin/cos-model.prometheus-scrape
juju integrate hydra admin/cos-model.prometheus-scrape
juju integrate identity-platform-login-ui-operator admin/cos-model.prometheus-scrape
juju integrate traefik-admin admin/cos-model.prometheus-scrape
juju integrate traefik-public admin/cos-model.prometheus-scrape

Integrate the Identity Platform charms with COS-Lite through Grafana Agent¶

You first need to deploy the Grafana Agent operator, which is a telemetry collector used to aggregate and push information to the COS-lite bundle.

To deploy Grafana Agent, run:

juju deploy grafana-agent-k8s --channel edge --trust

Forward Prometheus metrics¶

Integrate Grafana Agent with the Identity Stack Components by running the following commands:

juju integrate grafana-agent-k8s kratos:metrics-endpoint
juju integrate grafana-agent-k8s hydra:metrics-endpoint
juju integrate grafana-agent-k8s identity-platform-login-ui-operator:metrics-endpoint
juju integrate grafana-agent-k8s traefik-admin:metrics-endpoint
juju integrate grafana-agent-k8s traefik-public:metrics-endpoint

Forward Loki logs¶

Integrate Grafana Agent with the Identity Stack Components by running the following commands:

juju integrate grafana-agent-k8s kratos:logging
juju integrate grafana-agent-k8s hydra:logging
juju integrate grafana-agent-k8s identity-platform-login-ui-operator:logging
juju integrate grafana-agent-k8s traefik-admin:logging
juju integrate grafana-agent-k8s traefik-public:logging

Integrate Grafana Agent with COS-Lite¶

Assuming you deployed the COS-Lite bundle in model cos-model with user admin, use these commands to integrate the Grafana Agent with Prometheus and Loki:

juju integrate grafana-agent-k8s admin/cos-model.prometheus-receive-remote-write
juju integrate grafana-agent-k8s admin/cos-model.loki-logging

Access the dashboards¶

You can get the Grafana IP address with the juju status command. The default port for the Grafana HTTP server is 3000.

The default credentials are:

Username: admin
Password: You can retrieve the password with the get-admin-password action.

Once logged in, you will see a vertical menu bar on the left side of the page. You will find the available alerts by clicking on the Alerting menu and the dashboards under the Dashboards menu.

You can find a technical description of the observability setup in the related reference section of the docs.