Integrate With Canonical Observability Stack (COS)¶
This document shows how to integrate the different components of JAAS with the Canonical Observability Stack to enable 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 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 section to create offers.
A running JAAS. Please refer to the deployment tutorial.
Hint
Juju offers are a way of sharing software as a service between models. Make sure you deploy COS and setup offers so that you can relate to it across models.
It is generally recommended to keep the observability stack separate from any observed applications to separate failure domains. This document assumes that JAAS and the COS bundle are deployed to different models.
This how-to assumes that Vault and PostgreSQL are deployed alongside JIMM and OpenFGA. Depending on your approach, this may not be true. Additionally this how-to assumes the names of the deployed applications, which might differ in your environment.
Integration approaches¶
There are 2 possible integration approaches depending on your networking / deployment setup:
If you are able to send metrics and logs directly to the observability platform components follow the Integrate JAAS with COS-Lite section
If you prefer using a telemetry collector component follow the Integrate JAAS with COS-Lite through Grafana-Agent section
Integrate JAAS 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 JAAS applications by means of an application offer.
juju integrate jimm admin/cos-model.grafana-dashboards
juju integrate openfga admin/cos-model.grafana-dashboards
juju integrate postgresql admin/cos-model.grafana-dashboards
juju integrate vault 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 JAAS by means of an application offer.
juju integrate jimm admin/cos-model.loki-logging
juju integrate openfga admin/cos-model.loki-logging
juju integrate postgresql admin/cos-model.loki-logging
juju integrate vault 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 JAAS by means of an application offer.
juju integrate jimm admin/cos-model.prometheus-scrape
juju integrate openfga admin/cos-model.prometheus-scrape
juju integrate postgresql admin/cos-model.prometheus-scrape
juju integrate vault admin/cos-model.prometheus-scrape
Integrate JAAS 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.
Hint
Note that you may perform some relations directly with the COS applications. E.g. the Grafana relation shares any dashboards from the charm to Grafana. This relation should be done as described in the previous section.
To deploy Grafana-Agent run:
juju deploy grafana-agent-k8s --channel latest/stable --trust
Forward Prometheus metrics¶
Integrate Grafana-Agent with JAAS by running the following commands:
juju integrate grafana-agent-k8s jimm:metrics-endpoint
juju integrate grafana-agent-k8s openfga:metrics-endpoint
juju integrate grafana-agent-k8s postgresql:metrics-endpoint
juju integrate grafana-agent-k8s vault:metrics-endpoint
Forward Loki metrics¶
Integrate Grafana-Agent with JAAS by running the following commands:
juju integrate grafana-agent-k8s jimm:logging
juju integrate grafana-agent-k8s openfga:log-proxy
juju integrate grafana-agent-k8s postgresql:logging
juju integrate grafana-agent-k8s vault:logging
Integrate Grafana-Agent with COS-Lite¶
Assuming you deployed the COS-Lite bundle in model cos-model with user admin,
use this command to integrate the Grafana-Agent with Prometheus by means of an application offer.
juju integrate grafana-agent-k8s admin/cos-model.prometheus-receive-remote-write
Assuming you deployed the COS-Lite bundle in model cos-model with user admin,
use this command to integrate the Grafana-Agent with Loki by means of an application offer.
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 get the password with the juju action get-admin-password.