Note: All commands are written for juju >= v3.1
If you’re using juju 2.9, check the juju 3.0 Release Notes.
Enable tracing
This guide contains the steps to enable tracing with Grafana Tempo for your PgBouncer K8s application.
To summarize:
- Deploy the Tempo charm in a COS K8s environment
- Integrate it with the COS charms
- Offer interfaces for cross-model integrations
- View PgBouncer K8s traces on Grafana
Warning: This is feature is in development. It is not recommended for production environments.
This feature is available for Charmed PgBouncer K8s revision 162+ only.
Prerequisites
Enabling tracing with Tempo requires that you:
- Have deployed a Charmed PostgreSQL K8s application
- Have deployed a Charmed PgBouncer K8s application in the same model as the Charmed PostgreSQL K8s applicatoin
- Have deployed a ‘cos-lite’ bundle from the
latest/edgetrack in a Kubernetes environment
Deploy Tempo
First, switch to the Kubernetes controller where the COS model is deployed:
juju switch <k8s_controller_name>:<cos_model_name>
Then, deploy the tempo-k8s charm:
juju deploy -n 1 tempo-k8s --channel latest/edge
Integrate with the COS charms
Integrate tempo-k8s with the COS charms as follows:
juju integrate tempo-k8s:grafana-dashboard grafana:grafana-dashboard
juju integrate tempo-k8s:grafana-source grafana:grafana-source
juju integrate tempo-k8s:ingress traefik:traefik-route
juju integrate tempo-k8s:metrics-endpoint prometheus:metrics-endpoint
juju integrate tempo-k8s:logging loki:logging
If you would like to instrument traces from the COS charms as well, create the following integrations:
juju integrate tempo-k8s:tracing alertmanager:tracing
juju integrate tempo-k8s:tracing catalogue:tracing
juju integrate tempo-k8s:tracing grafana:tracing
juju integrate tempo-k8s:tracing loki:tracing
juju integrate tempo-k8s:tracing prometheus:tracing
juju integrate tempo-k8s:tracing traefik:tracing
Offer interfaces
Next, offer interfaces for cross-model integrations from the model where Charmed PgBouncer K8s is deployed.
To offer the Tempo integration, run
juju offer tempo-k8s:tracing
Then, switch to the Charmed PgBouncer K8s model, find the offers, and integrate (relate) with them:
juju switch <k8s_controller_name>:<pgbouncer_k8s_model_name>
juju find-offers <k8s_controller_name>:
Do not miss the “
:” in the command above.
Below is a sample output where k8s is the K8s controller name and cos is the model where cos-lite and tempo-k8s are deployed:
Store URL Access Interfaces
k8s admin/cos.tempo-k8s admin tracing:tracing
Next, consume this offer so that it is reachable from the current model:
juju consume k8s:admin/cos.tempo-k8s
Relate Charmed PgBouncer K8s with the above consumed interface:
juju integrate pgbouncer-k8s:tracing tempo-k8s:tracing
Wait until the model settles. The following is an example of the juju status --relations on the Charmed PgBouncer K8s model:
Model Controller Cloud/Region Version SLA Timestamp
database uk8s microk8s/localhost 3.4.3 unsupported 19:00:48Z
SAAS Status Store URL
tempo-k8s active uk8s admin/cos.tempo-k8s
App Version Status Scale Charm Channel Rev Address Exposed Message
pgbouncer-k8s 1.21.0 active 1 pgbouncer-k8s 1/edge 196 10.152.183.140 no
postgresql-k8s 14.12 active 1 postgresql-k8s 14/edge 315 10.152.183.28 no
postgresql-test-app active 1 postgresql-test-app latest/edge 176 10.152.183.204 no received database credentials of the first database
Unit Workload Agent Address Ports Message
pgbouncer-k8s/0* active idle 10.1.241.198
postgresql-k8s/0* active idle 10.1.241.220 Primary
postgresql-test-app/0* active idle 10.1.241.200 received database credentials of the first database
Integration provider Requirer Interface Type Message
pgbouncer-k8s:database postgresql-test-app:first-database postgresql_client regular
pgbouncer-k8s:pgb-peers pgbouncer-k8s:pgb-peers pgb_peers peer
pgbouncer-k8s:upgrade pgbouncer-k8s:upgrade upgrade peer
postgresql-k8s:database pgbouncer-k8s:backend-database postgresql_client regular
postgresql-k8s:database-peers postgresql-k8s:database-peers postgresql_peers peer
postgresql-k8s:restart postgresql-k8s:restart rolling_op peer
postgresql-k8s:upgrade postgresql-k8s:upgrade upgrade peer
postgresql-test-app:postgresql-test-peers postgresql-test-app:postgresql-test-peers postgresql-test-peers peer
tempo-k8s:tracing pgbouncer-k8s:tracing tracing regular
Note: All traces are exported to Tempo using HTTP. Support for sending traces via HTTPS is an upcoming feature.
View traces
After this is complete, the Tempo traces will be accessible from Grafana under the Explore section with tempo-k8s as the data source. You will be able to select pgbouncer-k8s as the Service Name under the Search tab to view traces belonging to Charmed PgBouncer K8s.
Below is a screenshot demonstrating a Charmed PgBouncer K8s trace:
Feel free to read through the Tempo documentation at your leisure to explore its deployment and its integrations.