From ceb24df4cbe7293c4ac8f552e25d2d329f2e03b9 Mon Sep 17 00:00:00 2001
From: ali ugur <ali.ugur@canonical.com>
Date: Tue, 21 Jan 2025 10:23:06 +0300
Subject: [PATCH 01/11] feat(tracing): Add commented out tracing relation into
 templates

---
 charmcraft/templates/init-django-framework/charmcraft.yaml.j2 | 4 ++++
 .../templates/init-fastapi-framework/charmcraft.yaml.j2       | 4 ++++
 charmcraft/templates/init-flask-framework/charmcraft.yaml.j2  | 4 ++++
 charmcraft/templates/init-go-framework/charmcraft.yaml.j2     | 4 ++++
 4 files changed, 16 insertions(+)

diff --git a/charmcraft/templates/init-django-framework/charmcraft.yaml.j2 b/charmcraft/templates/init-django-framework/charmcraft.yaml.j2
index c60140ed2..b250123f5 100644
--- a/charmcraft/templates/init-django-framework/charmcraft.yaml.j2
+++ b/charmcraft/templates/init-django-framework/charmcraft.yaml.j2
@@ -55,3 +55,7 @@ extensions:
 #     interface: rabbitmq
 #     optional: false
 #     limit: 1
+#   tracing:
+#     interface: tracing
+#     optional: true
+#     limit: 1
diff --git a/charmcraft/templates/init-fastapi-framework/charmcraft.yaml.j2 b/charmcraft/templates/init-fastapi-framework/charmcraft.yaml.j2
index a8b24a74a..ed4bc7b39 100644
--- a/charmcraft/templates/init-fastapi-framework/charmcraft.yaml.j2
+++ b/charmcraft/templates/init-fastapi-framework/charmcraft.yaml.j2
@@ -57,3 +57,7 @@ extensions:
 #     interface: rabbitmq
 #     optional: false
 #     limit: 1
+#   tracing:
+#     interface: tracing
+#     optional: true
+#     limit: 1
diff --git a/charmcraft/templates/init-flask-framework/charmcraft.yaml.j2 b/charmcraft/templates/init-flask-framework/charmcraft.yaml.j2
index 888b49d25..d9f3611f7 100644
--- a/charmcraft/templates/init-flask-framework/charmcraft.yaml.j2
+++ b/charmcraft/templates/init-flask-framework/charmcraft.yaml.j2
@@ -55,3 +55,7 @@ extensions:
 #     interface: rabbitmq
 #     optional: false
 #     limit: 1
+#   tracing:
+#     interface: tracing
+#     optional: true
+#     limit: 1
diff --git a/charmcraft/templates/init-go-framework/charmcraft.yaml.j2 b/charmcraft/templates/init-go-framework/charmcraft.yaml.j2
index 8ddd8b05c..d7f7b2e2e 100644
--- a/charmcraft/templates/init-go-framework/charmcraft.yaml.j2
+++ b/charmcraft/templates/init-go-framework/charmcraft.yaml.j2
@@ -57,3 +57,7 @@ extensions:
 #     interface: rabbitmq
 #     optional: false
 #     limit: 1
+#   tracing:
+#     interface: tracing
+#     optional: true
+#     limit: 1

From 28042e56b19ff1be2081f361dc05ce567a99ad39 Mon Sep 17 00:00:00 2001
From: ali ugur <ali.ugur@canonical.com>
Date: Tue, 21 Jan 2025 11:31:11 +0300
Subject: [PATCH 02/11] chore(docs): Add extension reference docs

---
 .../extensions/django-framework-extension.md  | 47 ++++++++++--
 .../extensions/fastapi-framework-extension.md | 73 +++++++++++++++++--
 .../extensions/flask-framework-extension.md   | 70 ++++++++++++++++--
 .../extensions/go-framework-extension.md      | 51 +++++++++++--
 4 files changed, 215 insertions(+), 26 deletions(-)

diff --git a/docs/reference/extensions/django-framework-extension.md b/docs/reference/extensions/django-framework-extension.md
index ba1450485..876197008 100644
--- a/docs/reference/extensions/django-framework-extension.md
+++ b/docs/reference/extensions/django-framework-extension.md
@@ -26,7 +26,7 @@ Django application with it.
 
 You can use the predefined options (run `charmcraft expand-extensions` for details) but also add your own, as needed.
 
-In the latter case, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `DJANGO_CONFIG_OPTION_NAME` where the option name is converted to upper case, dashes will be converted to underscores and the `DJANGO_` prefix will be added. 
+In the latter case, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `DJANGO_CONFIG_OPTION_NAME` where the option name is converted to upper case, dashes will be converted to underscores and the `DJANGO_` prefix will be added.
 
 In either case, you will be able to set it in the usual way by running `juju config <application> <option>=<value>`. For example, if you define an option called `token`, as below, this will generate a `DJANGO_TOKEN` environment variable, and a user of your charm can set it by running `juju config <application> token=<token>`.
 
@@ -44,7 +44,7 @@ For the predefined configuration option `django-allowed-hosts`, that will set th
 
 ## `peers`, `provides`,  and `requires` keys
 
-Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes. 
+Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes.
 
 `````{dropdown} Pre-populated integrations
 
@@ -81,6 +81,7 @@ In addition to these integrations, in each `provides` and `requires` block you m
 - [SAML](https://charmhub.io/saml-integrator)
 - [S3](https://charmhub.io/s3-integrator)
 - RabbitMQ: [machine](https://charmhub.io/rabbitmq-server) and [k8s](https://charmhub.io/rabbitmq-k8s) charm
+- [Tempo](https://charmhub.io/topics/charmed-tempo-ha)
 
 These endpoint definitions are as below:
 
@@ -140,11 +141,19 @@ requires:
     limit: 1
 ```
 
+```yaml
+requires:
+  tracing:
+    interface: tracing
+    optional: True
+    limit: 1
+```
+
 ```{note}
 The key `optional` with value `False` means that the charm will get blocked and stop the services if the integration is not provided.
 ```
 
-To add one of these integrations, e.g. PostgreSQL, in the `charmcraft.yaml` file include the appropriate requires block and integrate with `juju integrate <django charm> postgresql` as usual. 
+To add one of these integrations, e.g. PostgreSQL, in the `charmcraft.yaml` file include the appropriate requires block and integrate with `juju integrate <django charm> postgresql` as usual.
 
 After the integration has been established, the connection string will be
 available as an environment variable. Integration with PostgreSQL, MySQL, MongoDB or Redis provides the string as the `POSTGRESQL_DB_CONNECT_STRING`, `MYSQL_DB_CONNECT_STRING`,
@@ -159,8 +168,8 @@ available as an environment variable. Integration with PostgreSQL, MySQL, MongoD
 - `<integration>_DB_USERNAME`
 - `<integration>_DB_PASSWORD`
 - `<integration>_DB_HOSTNAME`
-- `<integration>_DB_PORT` 
-- `<integration>_DB_NAME` 
+- `<integration>_DB_PORT`
+- `<integration>_DB_NAME`
 
 Here, `<integration>` is replaced by `POSTGRESQL`, `MYSQL` `MONGODB` or `REDIS` for the relevant integration. The key `optional` with value `False` means that the charm will get blocked and stop the services if the integration is not provided.
 
@@ -200,6 +209,11 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_PORT`
 - `RABBITMQ_VHOST`
 
+The Tracing integration creates the following environment variables that you may use to configure your application:
+
+- `OTEL_EXPORTER_OTLP_ENDPOINT`
+- `OTEL_SERVICE_NAME`
+
 The environment variable `DJANGO_BASE_URL` provides the Ingress URL for an Ingress integration or the Kubernetes service URL if there is no Ingress integration.
 
 
@@ -218,6 +232,29 @@ in the application, the services with the name ending in `-worker` will run in a
 only run in one of the units of the application.
 
 
+## Observability
+
+12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+
+```shell
+juju integrate django-k8s grafana
+juju integrate django-k8s loki
+juju integrate django-k8s prometheus
+```
+After integration, you will be able to observe your workload using Grafana dashboards.
+
+
+In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
+To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
+
+To learn how to enable tracing in your Django app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
+
+Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+
+
 ## Secrets
 
 Juju secrets can be passed as environment variables to your Django application.
diff --git a/docs/reference/extensions/fastapi-framework-extension.md b/docs/reference/extensions/fastapi-framework-extension.md
index a8f1de028..66cc33f83 100644
--- a/docs/reference/extensions/fastapi-framework-extension.md
+++ b/docs/reference/extensions/fastapi-framework-extension.md
@@ -11,9 +11,9 @@ If you'd like to see the full contents contributed by this extension, see {ref}`
 
 ## `charmcraft.yaml` > `config` > `options`
 
-You can use the predefined options (run `charmcraft expand-extensions` for details) but also add your own, as needed. 
+You can use the predefined options (run `charmcraft expand-extensions` for details) but also add your own, as needed.
 
-In the latter case, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `APP_CONFIG_OPTION_NAME` where the option name is converted to upper case, dashes will be converted to underscores and the `APP_` prefix will be added. 
+In the latter case, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `APP_CONFIG_OPTION_NAME` where the option name is converted to upper case, dashes will be converted to underscores and the `APP_` prefix will be added.
 
 In either case, you will be able to set it in the usual way by running `juju config <application> <option>=<value>`. For example, if you define an option called `token`, as below, this will generate a `APP_TOKEN` environment variable, and a user of your charm can set it by running `juju config <application> token=<token>`.
 
@@ -29,7 +29,7 @@ config:
 
 ## `charmcraft.yaml` > `peers`, `provides`, `requires`
 
-Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes. 
+Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes.
 
 
 `````{dropdown} Expand to view pre-loaded integrations
@@ -66,6 +66,9 @@ In addition to these integrations, in each `provides` and `requires` block you m
 - [Redis](https://charmhub.io/redis-k8s)
 - [SAML](https://charmhub.io/saml-integrator)
 - [S3](https://charmhub.io/s3-integrator)
+- RabbitMQ: [machine](https://charmhub.io/rabbitmq-server) and
+  [k8s](https://charmhub.io/rabbitmq-k8s) charm
+- [Tempo](https://charmhub.io/topics/charmed-tempo-ha)
 
 These endpoint definitions are as below:
 
@@ -117,11 +120,27 @@ requires:
     limit: 1
 ```
 
+```yaml
+requires:
+  rabbitmq:
+    interface: rabbitmq
+    optional: True
+    limit: 1
+```
+
+```yaml
+requires:
+  tracing:
+    interface: tracing
+    optional: True
+    limit: 1
+```
+
 ```{note}
 The key `optional` with value `False` means that the charm will get blocked and stop the services if the integration is not provided.
 ```
 
-To add one of these integrations, e.g. PostgreSQL, in the `charmcraft.yaml` file include the appropriate requires block and integrate with `juju integrate <fastapi charm> postgresql` as usual. 
+To add one of these integrations, e.g. PostgreSQL, in the `charmcraft.yaml` file include the appropriate requires block and integrate with `juju integrate <fastapi charm> postgresql` as usual.
 
 After the integration has been established, the connection string will be
 available as an environment variable. Integration with PostgreSQL, MySQL, MongoDB or Redis provides the string as the `POSTGRESQL_DB_CONNECT_STRING`, `MYSQL_DB_CONNECT_STRING`,
@@ -136,8 +155,8 @@ available as an environment variable. Integration with PostgreSQL, MySQL, MongoD
 - `<integration>_DB_USERNAME`
 - `<integration>_DB_PASSWORD`
 - `<integration>_DB_HOSTNAME`
-- `<integration>_DB_PORT` 
-- `<integration>_DB_NAME` 
+- `<integration>_DB_PORT`
+- `<integration>_DB_NAME`
 
 Here, `<integration>` is replaced by `POSTGRESQL`, `MYSQL` `MONGODB` or `REDIS` for the relevant integration.
 
@@ -163,6 +182,25 @@ The S3 integration creates the following environment variables that you may use
 - `S3_ATTRIBUTES`
 - `S3_TLS_CA_CHAIN`
 
+The RabbitMQ integration creates the connection string in the environment variable `RABBITMQ_CONNECT_STRING`. Furthermore, the following environment variables may be provided, derived from the connection string:
+
+- `RABBITMQ_SCHEME`
+- `RABBITMQ_NETLOC`
+- `RABBITMQ_PATH`
+- `RABBITMQ_PARAMS`
+- `RABBITMQ_QUERY`
+- `RABBITMQ_FRAGMENT`
+- `RABBITMQ_USERNAME`
+- `RABBITMQ_PASSWORD`
+- `RABBITMQ_HOSTNAME`
+- `RABBITMQ_PORT`
+- `RABBITMQ_VHOST`
+
+The Tracing integration creates the following environment variables that you may use to configure your application:
+
+- `OTEL_EXPORTER_OTLP_ENDPOINT`
+- `OTEL_SERVICE_NAME`
+
 The environment variable `APP_BASE_URL` provides the Ingress URL for an Ingress integration or the Kubernetes service URL if there is no Ingress integration.
 
 
@@ -181,6 +219,29 @@ in the application, the services with the name ending in `-worker` will run in a
 only run in one of the units of the application.
 
 
+## Observability
+
+12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+
+```shell
+juju integrate fastapi-k8s grafana
+juju integrate fastapi-k8s loki
+juju integrate fastapi-k8s prometheus
+```
+After integration, you will be able to observe your workload using Grafana dashboards.
+
+
+In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
+To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
+
+To learn how to enable tracing in your FastAPI app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
+
+Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+
+
 ## Regarding the `migrate.sh` file
 
 If your app depends on a database it is common to run a database migration
diff --git a/docs/reference/extensions/flask-framework-extension.md b/docs/reference/extensions/flask-framework-extension.md
index 36527aa3a..cdc4dd54a 100644
--- a/docs/reference/extensions/flask-framework-extension.md
+++ b/docs/reference/extensions/flask-framework-extension.md
@@ -11,9 +11,9 @@ If you'd like to see the full contents contributed by this extension, see {ref}`
 
 ## `charmcraft.yaml` > `config` > `options`
 
-You can use the predefined options (run `charmcraft expand-extensions` for details) but also add your own, as needed. 
+You can use the predefined options (run `charmcraft expand-extensions` for details) but also add your own, as needed.
 
-In the latter case, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `FLASK_CONFIG_OPTION_NAME` where the option name is converted to upper case and dashes are converted to underscores. 
+In the latter case, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `FLASK_CONFIG_OPTION_NAME` where the option name is converted to upper case and dashes are converted to underscores.
 
 In either case, you will be able to set it in the usual way by running `juju config <application> <option>=<value>`. For example, if you define an option called `token`, as below, this will generate a `FLASK_TOKEN` environment variable, and a user of your charm can set it by running `juju config <application> token=<token>`.
 
@@ -29,7 +29,7 @@ config:
 
 ## `charmcraft.yaml` > `peers`, `provides`, `requires`
 
-Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes. 
+Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes.
 
 `````{dropdown} Expand to view pre-loaded integrations
 
@@ -67,6 +67,7 @@ In addition to these, in each `provides` and `requires` block you may specifying
 - [S3](https://charmhub.io/s3-integrator)
 - RabbitMQ: [machine](https://charmhub.io/rabbitmq-server) and
   [k8s](https://charmhub.io/rabbitmq-k8s) charm
+- [Tempo](https://charmhub.io/topics/charmed-tempo-ha)
 
 These endpoint definitions are as below:
 
@@ -126,11 +127,19 @@ requires:
     limit: 1
 ```
 
+```yaml
+requires:
+  tracing:
+    interface: tracing
+    optional: True
+    limit: 1
+```
+
 ```{note}
 The key `optional` with value `False` means that the charm will get blocked and stop the services if the integration is not provided.
 ```
 
-To add one of these integrations, e.g. postgresql, in the `charmcraft.yaml` file include the appropriate requires block and integrate with `juju integrate <flask charm> postgresql` as usual. 
+To add one of these integrations, e.g. postgresql, in the `charmcraft.yaml` file include the appropriate requires block and integrate with `juju integrate <flask charm> postgresql` as usual.
 
 After the integration has been established, the connection string will be
 available as an environment variable. Integration with PostgreSQL, MySQL, MongoDB or Redis provides the string as the `POSTGRESQL_DB_CONNECT_STRING`, `MYSQL_DB_CONNECT_STRING`,
@@ -145,8 +154,8 @@ available as an environment variable. Integration with PostgreSQL, MySQL, MongoD
 - `<integration>_DB_USERNAME`
 - `<integration>_DB_PASSWORD`
 - `<integration>_DB_HOSTNAME`
-- `<integration>_DB_PORT` 
-- `<integration>_DB_NAME` 
+- `<integration>_DB_PORT`
+- `<integration>_DB_NAME`
 
 Here, `<integration>` is replaced by `POSTGRESQL`, `MYSQL` `MONGODB` or `REDIS` for the relevant integration.
 
@@ -183,8 +192,13 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_USERNAME`
 - `RABBITMQ_PASSWORD`
 - `RABBITMQ_HOSTNAME`
-- `RABBITMQ_PORT` 
-- `RABBITMQ_VHOST` 
+- `RABBITMQ_PORT`
+- `RABBITMQ_VHOST`
+
+The Tracing integration creates the following environment variables that you may use to configure your application:
+
+- `OTEL_EXPORTER_OTLP_ENDPOINT`
+- `OTEL_SERVICE_NAME`
 
 The environment variable `FLASK_BASE_URL` provides the Ingress URL for an Ingress integration or the Kubernetes service URL if there is no Ingress integration.
 
@@ -204,6 +218,46 @@ in the application, the services with the name ending in `-worker` will run in a
 only run in one of the units of the application.
 
 
+## Observability
+
+12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+
+```shell
+juju relate flask-k8s grafana
+juju relate flask-k8s loki
+juju relate flask-k8s prometheus
+```
+After integration, you will be able to observe your workload using Grafana dashboards.
+
+
+In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
+To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
+
+To enable tracing in your Flask app you can simply add the following lines to your workload code:
+
+```python
+from opentelemetry import trace
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
+
+app = Flask(__name__)
+FlaskInstrumentor().instrument_app(app)
+tracer = trace.get_tracer(__name__)
+```
+
+You also need to add the following lines into your `requirements.txt` file:
+
+```
+opentelemetry-api
+opentelemetry-exporter-otlp-proto-http
+opentelemetry-instrumentation-flask
+opentelemetry-sdk
+```
+
+Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+
 ## Regarding the `migrate.sh` file
 
 If your app depends on a database it is common to run a database migration
diff --git a/docs/reference/extensions/go-framework-extension.md b/docs/reference/extensions/go-framework-extension.md
index d1d93910c..00ed5f3fc 100644
--- a/docs/reference/extensions/go-framework-extension.md
+++ b/docs/reference/extensions/go-framework-extension.md
@@ -16,10 +16,10 @@ You can use the predefined options (run `charmcraft expand-extensions` for detai
 The predefined configuration options for the `go-framework` are:
 -   **app-port**: Port in which the application should listen. The ingress will be configured using this port. The environment variable passed to the app is `APP_PORT`. Default value is 8080.
 -   **app-secret-key**: Long secret you can use for sessions, csrf or any other thing where you need a random secret shared by all units. The environment variable passed to the app is `APP_METRICS_PORT`. The default value is random.
--   **metrics-port**: Port where the prometheus metrics will be scraped. The environment variable passed to the app is `APP_PORT`. Default value is 8080. 
+-   **metrics-port**: Port where the prometheus metrics will be scraped. The environment variable passed to the app is `APP_PORT`. Default value is 8080.
 -   **metrics-path**: Path where the prometheus metrics will be scraped. The environment variable passed to the app is `APP_METRICS_PATH`. Default value is `/metrics`.
 
-In case you want to add extra configuration options, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `APP_CONFIG_OPTION_NAME` where the option name is converted to upper case and dashes are converted to underscores. 
+In case you want to add extra configuration options, any option you define will be used to generate environment variables; a user-defined option `config-option-name` will generate an environment variable named `APP_CONFIG_OPTION_NAME` where the option name is converted to upper case and dashes are converted to underscores.
 
 In either case, you will be able to set it in the usual way by running `juju config <application> <option>=<value>`. For example, if you define an option called `token`, as below, this will generate a `APP_TOKEN` environment variable, and a user of your charm can set it by running `juju config <application> token=<token>`.
 
@@ -34,7 +34,7 @@ config:
 
 ## `charmcraft.yaml` > `peers`, `provides`, `requires`
 
-Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes. 
+Your charm already has some `peers`, `provides`, and `requires` integrations, for internal purposes.
 
 `````{dropdown} Expand to view pre-loaded integrations
 
@@ -72,6 +72,7 @@ In addition to these, in each `provides` and `requires` block you may specifying
 - [S3](https://charmhub.io/s3-integrator)
 - RabbitMQ: [machine](https://charmhub.io/rabbitmq-server) and
   [k8s](https://charmhub.io/rabbitmq-k8s) charm
+- [Tempo](https://charmhub.io/topics/charmed-tempo-ha)
 
 These endpoint definitions are as below:
 
@@ -131,6 +132,14 @@ requires:
     limit: 1
 ```
 
+```yaml
+requires:
+  tracing:
+    interface: tracing
+    optional: True
+    limit: 1
+```
+
 ```{note}
 The key `optional` with value `False` means that the charm will get blocked and stop the services if the integration is not provided.
 ```
@@ -150,8 +159,8 @@ available as an environment variable. Integration with PostgreSQL, MySQL, MongoD
 - `<integration>_DB_USERNAME`
 - `<integration>_DB_PASSWORD`
 - `<integration>_DB_HOSTNAME`
-- `<integration>_DB_PORT` 
-- `<integration>_DB_NAME` 
+- `<integration>_DB_PORT`
+- `<integration>_DB_NAME`
 
 Here, `<integration>` is replaced by `POSTGRESQL`, `MYSQL` `MONGODB` or `REDIS` for the relevant integration.
 
@@ -188,8 +197,13 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_USERNAME`
 - `RABBITMQ_PASSWORD`
 - `RABBITMQ_HOSTNAME`
-- `RABBITMQ_PORT` 
-- `RABBITMQ_VHOST` 
+- `RABBITMQ_PORT`
+- `RABBITMQ_VHOST`
+
+The Tracing integration creates the following environment variables that you may use to configure your application:
+
+- `OTEL_EXPORTER_OTLP_ENDPOINT`
+- `OTEL_SERVICE_NAME`
 
 The environment variable `APP_BASE_URL` provides the Ingress URL for an Ingress integration or the Kubernetes service URL if there is no Ingress integration.
 
@@ -209,6 +223,29 @@ in the application, the services with the name ending in `-worker` will run in a
 only run in one of the units of the application.
 
 
+## Observability
+
+12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+
+```shell
+juju integrate go-k8s grafana
+juju integrate go-k8s loki
+juju integrate go-k8s prometheus
+```
+After integration, you will be able to observe your workload using Grafana dashboards.
+
+
+In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
+To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
+
+To learn how to enable tracing in your Go app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
+
+Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+
+
 ## Secrets
 
 Juju secrets can be passed as environment variables to your Go application.

From 565a1452737f6614a61d0d15ce39fed1a8562697 Mon Sep 17 00:00:00 2001
From: ali ugur <ali.ugur@canonical.com>
Date: Tue, 21 Jan 2025 12:32:03 +0300
Subject: [PATCH 03/11] ci(): Run CI again


From b439d23cb1c314ad9e10c1137db73d4ee919c165 Mon Sep 17 00:00:00 2001
From: ali ugur <ali.ugur@canonical.com>
Date: Wed, 22 Jan 2025 08:28:36 +0300
Subject: [PATCH 04/11] Chore(docs): Address nitpicks

---
 docs/reference/extensions/django-framework-extension.md  | 4 ++--
 docs/reference/extensions/fastapi-framework-extension.md | 4 ++--
 docs/reference/extensions/flask-framework-extension.md   | 4 ++--
 docs/reference/extensions/go-framework-extension.md      | 4 ++--
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/reference/extensions/django-framework-extension.md b/docs/reference/extensions/django-framework-extension.md
index 876197008..f537ad8b4 100644
--- a/docs/reference/extensions/django-framework-extension.md
+++ b/docs/reference/extensions/django-framework-extension.md
@@ -234,7 +234,7 @@ only run in one of the units of the application.
 
 ## Observability
 
-12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
 You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
 
@@ -251,7 +251,7 @@ To learn about how to deploy Tempo you can read the documentation [here](https:/
 
 To learn how to enable tracing in your Django app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
 
-Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
 For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
 
 
diff --git a/docs/reference/extensions/fastapi-framework-extension.md b/docs/reference/extensions/fastapi-framework-extension.md
index 66cc33f83..935138e22 100644
--- a/docs/reference/extensions/fastapi-framework-extension.md
+++ b/docs/reference/extensions/fastapi-framework-extension.md
@@ -221,7 +221,7 @@ only run in one of the units of the application.
 
 ## Observability
 
-12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
 You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
 
@@ -238,7 +238,7 @@ To learn about how to deploy Tempo you can read the documentation [here](https:/
 
 To learn how to enable tracing in your FastAPI app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
 
-Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
 For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
 
 
diff --git a/docs/reference/extensions/flask-framework-extension.md b/docs/reference/extensions/flask-framework-extension.md
index cdc4dd54a..f105cb153 100644
--- a/docs/reference/extensions/flask-framework-extension.md
+++ b/docs/reference/extensions/flask-framework-extension.md
@@ -220,7 +220,7 @@ only run in one of the units of the application.
 
 ## Observability
 
-12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
 You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
 
@@ -255,7 +255,7 @@ opentelemetry-instrumentation-flask
 opentelemetry-sdk
 ```
 
-Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
 For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
 
 ## Regarding the `migrate.sh` file
diff --git a/docs/reference/extensions/go-framework-extension.md b/docs/reference/extensions/go-framework-extension.md
index 00ed5f3fc..027e14d85 100644
--- a/docs/reference/extensions/go-framework-extension.md
+++ b/docs/reference/extensions/go-framework-extension.md
@@ -225,7 +225,7 @@ only run in one of the units of the application.
 
 ## Observability
 
-12 Factor charms are designed to be easily observable using [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
+12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
 You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
 
@@ -242,7 +242,7 @@ To learn about how to deploy Tempo you can read the documentation [here](https:/
 
 To learn how to enable tracing in your Go app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
 
-Opentelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
+OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
 For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
 
 

From 07a619b55b86e641806080417abb41786e3a803e Mon Sep 17 00:00:00 2001
From: Ali Ugur <ali.ugur@canonical.com>
Date: Mon, 27 Jan 2025 10:10:59 +0300
Subject: [PATCH 05/11] Chore(doc): Update docs.

---
 docs/reference/extensions/django-framework-extension.md  | 8 ++++----
 docs/reference/extensions/fastapi-framework-extension.md | 8 ++++----
 docs/reference/extensions/flask-framework-extension.md   | 8 ++++----
 docs/reference/extensions/go-framework-extension.md      | 8 ++++----
 4 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/docs/reference/extensions/django-framework-extension.md b/docs/reference/extensions/django-framework-extension.md
index f537ad8b4..5ff32a45d 100644
--- a/docs/reference/extensions/django-framework-extension.md
+++ b/docs/reference/extensions/django-framework-extension.md
@@ -209,7 +209,7 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_PORT`
 - `RABBITMQ_VHOST`
 
-The Tracing integration creates the following environment variables that you may use to configure your application:
+The Tracing integration creates the following environment variables that you can use to configure your application:
 
 - `OTEL_EXPORTER_OTLP_ENDPOINT`
 - `OTEL_SERVICE_NAME`
@@ -236,15 +236,15 @@ only run in one of the units of the application.
 
 12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
-You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s), [Prometheus](https://charmhub.io/prometheus-k8s) and [Grafana](https://charmhub.io/grafana-k8s) using Juju.
 
 ```shell
 juju integrate django-k8s grafana
 juju integrate django-k8s loki
 juju integrate django-k8s prometheus
 ```
-After integration, you will be able to observe your workload using Grafana dashboards.
 
+After integration, you will be able to observe your workload using Grafana dashboards.
 
 In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
 To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
@@ -252,7 +252,7 @@ To learn about how to deploy Tempo you can read the documentation [here](https:/
 To learn how to enable tracing in your Django app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
 
 OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
-For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+See the [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/) for further information about tracing.
 
 
 ## Secrets
diff --git a/docs/reference/extensions/fastapi-framework-extension.md b/docs/reference/extensions/fastapi-framework-extension.md
index 935138e22..e9919ef47 100644
--- a/docs/reference/extensions/fastapi-framework-extension.md
+++ b/docs/reference/extensions/fastapi-framework-extension.md
@@ -196,7 +196,7 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_PORT`
 - `RABBITMQ_VHOST`
 
-The Tracing integration creates the following environment variables that you may use to configure your application:
+The Tracing integration creates the following environment variables that you can use to configure your application:
 
 - `OTEL_EXPORTER_OTLP_ENDPOINT`
 - `OTEL_SERVICE_NAME`
@@ -223,15 +223,15 @@ only run in one of the units of the application.
 
 12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
-You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s), [Prometheus](https://charmhub.io/prometheus-k8s) and [Grafana](https://charmhub.io/grafana-k8s) using Juju.
 
 ```shell
 juju integrate fastapi-k8s grafana
 juju integrate fastapi-k8s loki
 juju integrate fastapi-k8s prometheus
 ```
-After integration, you will be able to observe your workload using Grafana dashboards.
 
+After integration, you will be able to observe your workload using Grafana dashboards.
 
 In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
 To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
@@ -239,7 +239,7 @@ To learn about how to deploy Tempo you can read the documentation [here](https:/
 To learn how to enable tracing in your FastAPI app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
 
 OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
-For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+See the [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/) for further information about tracing.
 
 
 ## Regarding the `migrate.sh` file
diff --git a/docs/reference/extensions/flask-framework-extension.md b/docs/reference/extensions/flask-framework-extension.md
index f105cb153..c409e104c 100644
--- a/docs/reference/extensions/flask-framework-extension.md
+++ b/docs/reference/extensions/flask-framework-extension.md
@@ -195,7 +195,7 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_PORT`
 - `RABBITMQ_VHOST`
 
-The Tracing integration creates the following environment variables that you may use to configure your application:
+The Tracing integration creates the following environment variables that you can use to configure your application:
 
 - `OTEL_EXPORTER_OTLP_ENDPOINT`
 - `OTEL_SERVICE_NAME`
@@ -222,15 +222,15 @@ only run in one of the units of the application.
 
 12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
-You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s), [Prometheus](https://charmhub.io/prometheus-k8s) and [Grafana](https://charmhub.io/grafana-k8s) using Juju.
 
 ```shell
 juju relate flask-k8s grafana
 juju relate flask-k8s loki
 juju relate flask-k8s prometheus
 ```
-After integration, you will be able to observe your workload using Grafana dashboards.
 
+After integration, you will be able to observe your workload using Grafana dashboards.
 
 In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
 To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
@@ -256,7 +256,7 @@ opentelemetry-sdk
 ```
 
 OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
-For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+See the [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/) for further information about tracing.
 
 ## Regarding the `migrate.sh` file
 
diff --git a/docs/reference/extensions/go-framework-extension.md b/docs/reference/extensions/go-framework-extension.md
index 027e14d85..0a580b7f0 100644
--- a/docs/reference/extensions/go-framework-extension.md
+++ b/docs/reference/extensions/go-framework-extension.md
@@ -200,7 +200,7 @@ The RabbitMQ integration creates the connection string in the environment variab
 - `RABBITMQ_PORT`
 - `RABBITMQ_VHOST`
 
-The Tracing integration creates the following environment variables that you may use to configure your application:
+The Tracing integration creates the following environment variables that you can use to configure your application:
 
 - `OTEL_EXPORTER_OTLP_ENDPOINT`
 - `OTEL_SERVICE_NAME`
@@ -227,15 +227,15 @@ only run in one of the units of the application.
 
 12-Factor charms are designed to be easily observable using the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack).
 
-You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s) and [Prometheus](https://charmhub.io/prometheus-k8s) using Juju.
+You can easily integrate your charm with [Loki](https://charmhub.io/loki-k8s), [Prometheus](https://charmhub.io/prometheus-k8s) and [Grafana](https://charmhub.io/grafana-k8s) using Juju.
 
 ```shell
 juju integrate go-k8s grafana
 juju integrate go-k8s loki
 juju integrate go-k8s prometheus
 ```
-After integration, you will be able to observe your workload using Grafana dashboards.
 
+After integration, you will be able to observe your workload using Grafana dashboards.
 
 In addition to that you can also trace your workload code using [Tempo](https://charmhub.io/topics/charmed-tempo-ha).
 To learn about how to deploy Tempo you can read the documentation [here](https://charmhub.io/topics/charmed-tempo-ha).
@@ -243,7 +243,7 @@ To learn about how to deploy Tempo you can read the documentation [here](https:/
 To learn how to enable tracing in your Go app you can checkout the example in [Paas Charm repository](https://github.com/canonical/paas-charm).
 
 OpenTelemetry will automatically read the environment variables and configure the OpenTelemetry SDK to use them.
-For other frameworks and further configuration options please refer to [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/).
+See the [OpenTelemetry documentation](https://opentelemetry-python.readthedocs.io/en/latest/) for further information about tracing.
 
 
 ## Secrets

From 3f81c4180e273b1ba54c85634f04a3b61c769090 Mon Sep 17 00:00:00 2001
From: Ali Ugur <ali.ugur@canonical.com>
Date: Fri, 7 Feb 2025 06:55:12 +0300
Subject: [PATCH 06/11] Chore(update): Update docs to rst

---
 .../extensions/django-framework-extension.rst | 51 ++++++++++++
 .../fastapi-framework-extension.rst           | 78 +++++++++++++++++++
 .../extensions/flask-framework-extension.rst  | 51 ++++++++++++
 .../extensions/go-framework-extension.rst     | 51 ++++++++++++
 4 files changed, 231 insertions(+)

diff --git a/docs/reference/extensions/django-framework-extension.rst b/docs/reference/extensions/django-framework-extension.rst
index 20ec9d213..49c1f024c 100644
--- a/docs/reference/extensions/django-framework-extension.rst
+++ b/docs/reference/extensions/django-framework-extension.rst
@@ -105,6 +105,7 @@ the following charms and bundles:
 - `S3 <https://charmhub.io/s3-integrator>`__
 - RabbitMQ: `machine <https://charmhub.io/rabbitmq-server>`__ and
   `k8s <https://charmhub.io/rabbitmq-k8s>`__ charm
+- `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__
 
 These endpoint definitions are as below:
 
@@ -164,6 +165,14 @@ These endpoint definitions are as below:
        optional: True
        limit: 1
 
+.. code-block:: yaml
+
+    requires:
+      tracing:
+        interface: tracing
+        optional: True
+        limit: 1
+
 .. note::
 
     The key ``optional`` with value ``False`` means that the charm will
@@ -239,6 +248,12 @@ connection string:
 - ``RABBITMQ_PORT``
 - ``RABBITMQ_VHOST``
 
+The Tracing integration creates the following environment variables
+that you can use to configure your application:
+
+- ``OTEL_EXPORTER_OTLP_ENDPOINT``
+- ``OTEL_SERVICE_NAME``
+
 The environment variable ``DJANGO_BASE_URL`` provides the Ingress URL
 for an Ingress integration or the Kubernetes service URL if there is no
 Ingress integration.
@@ -270,6 +285,42 @@ than one unit in the application, the services with the name ending in
 ``-scheduler`` will only run in one of the units of the application.
 
 
+Observability
+-------------
+
+12-Factor charms are designed to be easily observable using the
+`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+
+You can easily integrate your charm with
+`Loki <https://charmhub.io/loki-k8s>`__,
+`Prometheus <https://charmhub.io/prometheus-k8s>`__ and
+`Grafana <https://charmhub.io/grafana-k8s>`__ using Juju.
+
+.. code-block:: bash
+
+    juju integrate django-k8s grafana
+    juju integrate django-k8s loki
+    juju integrate django-k8s prometheus
+
+After integration, you will be able to observe your workload
+using Grafana dashboards.
+
+In addition to that you can also trace your workload code
+using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn about how to deploy Tempo you can read the
+documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn how to enable tracing in your Django app you can
+checkout the example in
+`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
+
+OpenTelemetry will automatically read the environment variables
+and configure the OpenTelemetry SDK to use them.
+See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+for further information about tracing.
+
+
 Secrets
 -------
 
diff --git a/docs/reference/extensions/fastapi-framework-extension.rst b/docs/reference/extensions/fastapi-framework-extension.rst
index fdbba0db5..d5dd9f208 100644
--- a/docs/reference/extensions/fastapi-framework-extension.rst
+++ b/docs/reference/extensions/fastapi-framework-extension.rst
@@ -83,6 +83,9 @@ the following charms and bundles:
 - `Redis <https://charmhub.io/redis-k8s>`__
 - `SAML <https://charmhub.io/saml-integrator>`__
 - `S3 <https://charmhub.io/s3-integrator>`__
+- RabbitMQ: `machine <https://charmhub.io/rabbitmq-server>`__ and
+  `k8s <https://charmhub.io/rabbitmq-k8s>`__ charm
+- `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__
 
 These endpoint definitions are as below:
 
@@ -134,6 +137,22 @@ These endpoint definitions are as below:
         optional: True
         limit: 1
 
+.. code-block:: yaml
+
+   requires:
+     rabbitmq:
+       interface: rabbitmq
+       optional: True
+       limit: 1
+
+.. code-block:: yaml
+
+    requires:
+      tracing:
+        interface: tracing
+        optional: True
+        limit: 1
+
 .. note::
 
     The key ``optional`` with value ``False`` means that the charm will
@@ -190,6 +209,29 @@ may use to configure your FastAPI application:
 - ``S3_ATTRIBUTES``
 - ``S3_TLS_CA_CHAIN``
 
+The RabbitMQ integration creates the connection string in the
+environment variable ``RABBITMQ_CONNECT_STRING``. Furthermore, the
+following environment variables may be provided, derived from the
+connection string:
+
+- ``RABBITMQ_SCHEME``
+- ``RABBITMQ_NETLOC``
+- ``RABBITMQ_PATH``
+- ``RABBITMQ_PARAMS``
+- ``RABBITMQ_QUERY``
+- ``RABBITMQ_FRAGMENT``
+- ``RABBITMQ_USERNAME``
+- ``RABBITMQ_PASSWORD``
+- ``RABBITMQ_HOSTNAME``
+- ``RABBITMQ_PORT``
+- ``RABBITMQ_VHOST``
+
+The Tracing integration creates the following environment variables
+that you can use to configure your application:
+
+- ``OTEL_EXPORTER_OTLP_ENDPOINT``
+- ``OTEL_SERVICE_NAME``
+
 The environment variable ``APP_BASE_URL`` provides the Ingress URL for
 an Ingress integration or the Kubernetes service URL if there is no
 Ingress integration.
@@ -221,6 +263,42 @@ than one unit in the application, the services with the name ending in
 ``-scheduler`` will only run in one of the units of the application.
 
 
+Observability
+-------------
+
+12-Factor charms are designed to be easily observable using the
+`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+
+You can easily integrate your charm with
+`Loki <https://charmhub.io/loki-k8s>`__,
+`Prometheus <https://charmhub.io/prometheus-k8s>`__ and
+`Grafana <https://charmhub.io/grafana-k8s>`__ using Juju.
+
+.. code-block:: bash
+
+    juju integrate fastapi-k8s grafana
+    juju integrate fastapi-k8s loki
+    juju integrate fastapi-k8s prometheus
+
+After integration, you will be able to observe your workload
+using Grafana dashboards.
+
+In addition to that you can also trace your workload code
+using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn about how to deploy Tempo you can read the
+documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn how to enable tracing in your FastAPI app you can
+checkout the example in
+`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
+
+OpenTelemetry will automatically read the environment variables
+and configure the OpenTelemetry SDK to use them.
+See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+for further information about tracing.
+
+
 Regarding the ``migrate.sh`` file
 ---------------------------------
 
diff --git a/docs/reference/extensions/flask-framework-extension.rst b/docs/reference/extensions/flask-framework-extension.rst
index bc133c020..00be9dd07 100644
--- a/docs/reference/extensions/flask-framework-extension.rst
+++ b/docs/reference/extensions/flask-framework-extension.rst
@@ -80,6 +80,7 @@ further integration endpoints, to integrate with the following charms and bundle
 - `S3 <https://charmhub.io/s3-integrator>`__
 - RabbitMQ: `machine <https://charmhub.io/rabbitmq-server>`__ and
   `k8s <https://charmhub.io/rabbitmq-k8s>`__ charm
+- `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__
 
 These endpoint definitions are as below:
 
@@ -139,6 +140,14 @@ These endpoint definitions are as below:
         optional: True
         limit: 1
 
+.. code-block:: yaml
+
+    requires:
+      tracing:
+        interface: tracing
+        optional: True
+        limit: 1
+
 .. note::
 
     The key optional with value ``False`` means that the charm will
@@ -209,6 +218,12 @@ provided, derived from the connection string:
 - ``RABBITMQ_PORT``
 - ``RABBITMQ_VHOST``
 
+The Tracing integration creates the following environment variables
+that you can use to configure your application:
+
+- ``OTEL_EXPORTER_OTLP_ENDPOINT``
+- ``OTEL_SERVICE_NAME``
+
 The environment variable ``FLASK_BASE_URL`` provides the Ingress URL for an Ingress
 integration or the Kubernetes service URL if there is no Ingress integration.
 
@@ -237,6 +252,42 @@ the services with the name ending in ``-worker`` will run in all units. The serv
 with name ending in ``-scheduler`` will only run in one of the units of the application.
 
 
+Observability
+-------------
+
+12-Factor charms are designed to be easily observable using the
+`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+
+You can easily integrate your charm with
+`Loki <https://charmhub.io/loki-k8s>`__,
+`Prometheus <https://charmhub.io/prometheus-k8s>`__ and
+`Grafana <https://charmhub.io/grafana-k8s>`__ using Juju.
+
+.. code-block:: bash
+
+    juju integrate flask-k8s grafana
+    juju integrate flask-k8s loki
+    juju integrate flask-k8s prometheus
+
+After integration, you will be able to observe your workload
+using Grafana dashboards.
+
+In addition to that you can also trace your workload code
+using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn about how to deploy Tempo you can read the
+documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn how to enable tracing in your Flask app you can
+checkout the example in
+`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
+
+OpenTelemetry will automatically read the environment variables
+and configure the OpenTelemetry SDK to use them.
+See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+for further information about tracing.
+
+
 Regarding the ``migrate.sh`` file
 ---------------------------------
 
diff --git a/docs/reference/extensions/go-framework-extension.rst b/docs/reference/extensions/go-framework-extension.rst
index eb4ec624c..e88c79faf 100644
--- a/docs/reference/extensions/go-framework-extension.rst
+++ b/docs/reference/extensions/go-framework-extension.rst
@@ -92,6 +92,7 @@ further integration endpoints, to integrate with the following charms and bundle
 - `S3 <https://charmhub.io/s3-integrator>`__
 - RabbitMQ: `machine <https://charmhub.io/rabbitmq-server>`__ and
   `k8s <https://charmhub.io/rabbitmq-k8s>`__ charm
+- `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__
 
 These endpoint definitions are as below:
 
@@ -151,6 +152,14 @@ These endpoint definitions are as below:
         optional: True
         limit: 1
 
+.. code-block:: yaml
+
+    requires:
+      tracing:
+        interface: tracing
+        optional: True
+        limit: 1
+
 .. note::
 
     The key optional with value ``False`` means that the charm will
@@ -221,6 +230,12 @@ provided, derived from the connection string:
 - ``RABBITMQ_PORT``
 - ``RABBITMQ_VHOST``
 
+The Tracing integration creates the following environment variables
+that you can use to configure your application:
+
+- ``OTEL_EXPORTER_OTLP_ENDPOINT``
+- ``OTEL_SERVICE_NAME``
+
 The environment variable ``APP_BASE_URL`` provides the Ingress URL for an Ingress
 integration or the Kubernetes service URL if there is no Ingress integration.
 
@@ -249,6 +264,42 @@ the services with the name ending in ``-worker`` will run in all units. The serv
 with name ending in ``-scheduler`` will only run in one of the units of the application.
 
 
+Observability
+-------------
+
+12-Factor charms are designed to be easily observable using the
+`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+
+You can easily integrate your charm with
+`Loki <https://charmhub.io/loki-k8s>`__,
+`Prometheus <https://charmhub.io/prometheus-k8s>`__ and
+`Grafana <https://charmhub.io/grafana-k8s>`__ using Juju.
+
+.. code-block:: bash
+
+    juju integrate go-k8s grafana
+    juju integrate go-k8s loki
+    juju integrate go-k8s prometheus
+
+After integration, you will be able to observe your workload
+using Grafana dashboards.
+
+In addition to that you can also trace your workload code
+using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn about how to deploy Tempo you can read the
+documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
+
+To learn how to enable tracing in your Go app you can
+checkout the example in
+`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
+
+OpenTelemetry will automatically read the environment variables
+and configure the OpenTelemetry SDK to use them.
+See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+for further information about tracing.
+
+
 Secrets
 -------
 

From b064c193352a1c1a0996c2c473346412abf74804 Mon Sep 17 00:00:00 2001
From: Ali Ugur <ali.ugur@canonical.com>
Date: Fri, 7 Feb 2025 09:22:03 +0300
Subject: [PATCH 07/11] Chore(docs): Remove reference to non-existent how-to

---
 docs/reference/extensions/django-framework-extension.rst  | 4 ----
 docs/reference/extensions/fastapi-framework-extension.rst | 4 ----
 docs/reference/extensions/flask-framework-extension.rst   | 4 ----
 docs/reference/extensions/go-framework-extension.rst      | 4 ----
 tools/external                                            | 2 +-
 5 files changed, 1 insertion(+), 17 deletions(-)

diff --git a/docs/reference/extensions/django-framework-extension.rst b/docs/reference/extensions/django-framework-extension.rst
index 49c1f024c..e1c10a071 100644
--- a/docs/reference/extensions/django-framework-extension.rst
+++ b/docs/reference/extensions/django-framework-extension.rst
@@ -311,10 +311,6 @@ using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
 To learn about how to deploy Tempo you can read the
 documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
-To learn how to enable tracing in your Django app you can
-checkout the example in
-`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
-
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
 See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
diff --git a/docs/reference/extensions/fastapi-framework-extension.rst b/docs/reference/extensions/fastapi-framework-extension.rst
index d5dd9f208..52739f0e3 100644
--- a/docs/reference/extensions/fastapi-framework-extension.rst
+++ b/docs/reference/extensions/fastapi-framework-extension.rst
@@ -289,10 +289,6 @@ using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
 To learn about how to deploy Tempo you can read the
 documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
-To learn how to enable tracing in your FastAPI app you can
-checkout the example in
-`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
-
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
 See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
diff --git a/docs/reference/extensions/flask-framework-extension.rst b/docs/reference/extensions/flask-framework-extension.rst
index 00be9dd07..611ba9dcf 100644
--- a/docs/reference/extensions/flask-framework-extension.rst
+++ b/docs/reference/extensions/flask-framework-extension.rst
@@ -278,10 +278,6 @@ using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
 To learn about how to deploy Tempo you can read the
 documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
-To learn how to enable tracing in your Flask app you can
-checkout the example in
-`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
-
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
 See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
diff --git a/docs/reference/extensions/go-framework-extension.rst b/docs/reference/extensions/go-framework-extension.rst
index e88c79faf..36cd39917 100644
--- a/docs/reference/extensions/go-framework-extension.rst
+++ b/docs/reference/extensions/go-framework-extension.rst
@@ -290,10 +290,6 @@ using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
 To learn about how to deploy Tempo you can read the
 documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
-To learn how to enable tracing in your Go app you can
-checkout the example in
-`Paas Charm repository <https://github.com/canonical/paas-charm>`__.
-
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
 See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
diff --git a/tools/external b/tools/external
index f46dccb46..bae7faf8c 160000
--- a/tools/external
+++ b/tools/external
@@ -1 +1 @@
-Subproject commit f46dccb464f3a82932c0a89ecabffb6ef84ec6df
+Subproject commit bae7faf8cb3f04296bac9552ac0d1aa89d4e9139

From e2563d3142724bddf38f069565e79e8a1d4a3aa0 Mon Sep 17 00:00:00 2001
From: Ali Ugur <ali.ugur@canonical.com>
Date: Fri, 7 Feb 2025 12:48:03 +0300
Subject: [PATCH 08/11] Chore(lint): Fix line-too-long

---
 docs/reference/extensions/django-framework-extension.rst  | 6 ++++--
 docs/reference/extensions/fastapi-framework-extension.rst | 6 ++++--
 docs/reference/extensions/flask-framework-extension.rst   | 6 ++++--
 docs/reference/extensions/go-framework-extension.rst      | 6 ++++--
 4 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/docs/reference/extensions/django-framework-extension.rst b/docs/reference/extensions/django-framework-extension.rst
index e1c10a071..f10e52163 100644
--- a/docs/reference/extensions/django-framework-extension.rst
+++ b/docs/reference/extensions/django-framework-extension.rst
@@ -289,7 +289,8 @@ Observability
 -------------
 
 12-Factor charms are designed to be easily observable using the
-`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+`Canonical Observability Stack
+<https://charmhub.io/topics/canonical-observability-stack>`__.
 
 You can easily integrate your charm with
 `Loki <https://charmhub.io/loki-k8s>`__,
@@ -313,7 +314,8 @@ documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
-See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+See the `OpenTelemetry documentation
+<https://opentelemetry-python.readthedocs.io/en/latest/>`__
 for further information about tracing.
 
 
diff --git a/docs/reference/extensions/fastapi-framework-extension.rst b/docs/reference/extensions/fastapi-framework-extension.rst
index 52739f0e3..cde2e39a8 100644
--- a/docs/reference/extensions/fastapi-framework-extension.rst
+++ b/docs/reference/extensions/fastapi-framework-extension.rst
@@ -267,7 +267,8 @@ Observability
 -------------
 
 12-Factor charms are designed to be easily observable using the
-`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+`Canonical Observability Stack
+<https://charmhub.io/topics/canonical-observability-stack>`__.
 
 You can easily integrate your charm with
 `Loki <https://charmhub.io/loki-k8s>`__,
@@ -291,7 +292,8 @@ documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
-See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+See the `OpenTelemetry documentation
+<https://opentelemetry-python.readthedocs.io/en/latest/>`__
 for further information about tracing.
 
 
diff --git a/docs/reference/extensions/flask-framework-extension.rst b/docs/reference/extensions/flask-framework-extension.rst
index 611ba9dcf..4ed3f6d24 100644
--- a/docs/reference/extensions/flask-framework-extension.rst
+++ b/docs/reference/extensions/flask-framework-extension.rst
@@ -256,7 +256,8 @@ Observability
 -------------
 
 12-Factor charms are designed to be easily observable using the
-`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+`Canonical Observability Stack
+<https://charmhub.io/topics/canonical-observability-stack>`__.
 
 You can easily integrate your charm with
 `Loki <https://charmhub.io/loki-k8s>`__,
@@ -280,7 +281,8 @@ documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
-See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+See the `OpenTelemetry documentation
+<https://opentelemetry-python.readthedocs.io/en/latest/>`__
 for further information about tracing.
 
 
diff --git a/docs/reference/extensions/go-framework-extension.rst b/docs/reference/extensions/go-framework-extension.rst
index 36cd39917..06cddc265 100644
--- a/docs/reference/extensions/go-framework-extension.rst
+++ b/docs/reference/extensions/go-framework-extension.rst
@@ -268,7 +268,8 @@ Observability
 -------------
 
 12-Factor charms are designed to be easily observable using the
-`Canonical Observability Stack <https://charmhub.io/topics/canonical-observability-stack>`__.
+`Canonical Observability Stack
+<https://charmhub.io/topics/canonical-observability-stack>`__.
 
 You can easily integrate your charm with
 `Loki <https://charmhub.io/loki-k8s>`__,
@@ -292,7 +293,8 @@ documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.
-See the `OpenTelemetry documentation <https://opentelemetry-python.readthedocs.io/en/latest/>`__
+See the `OpenTelemetry documentation
+<https://opentelemetry-python.readthedocs.io/en/latest/>`__
 for further information about tracing.
 
 

From 02af98275589256431ee082ed40b892eefa81eec Mon Sep 17 00:00:00 2001
From: Ali Ugur <ali.ugur@canonical.com>
Date: Fri, 7 Feb 2025 15:10:21 +0300
Subject: [PATCH 09/11] Chore(): Add charm lib to extension.

---
 charmcraft/extensions/app.py | 1 +
 tests/extensions/test_app.py | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/charmcraft/extensions/app.py b/charmcraft/extensions/app.py
index 7e9c7a681..6e58bf854 100644
--- a/charmcraft/extensions/app.py
+++ b/charmcraft/extensions/app.py
@@ -37,6 +37,7 @@ class _AppBase(Extension):
         {"lib": "redis_k8s.redis", "version": "0"},
         {"lib": "data_platform_libs.s3", "version": "0"},
         {"lib": "saml_integrator.saml", "version": "0"},
+        {"lib": "tempo_coordinator_k8s.tracing", "version": "0"},
     ]
 
     @staticmethod
diff --git a/tests/extensions/test_app.py b/tests/extensions/test_app.py
index 39de39c60..33a451bf7 100644
--- a/tests/extensions/test_app.py
+++ b/tests/extensions/test_app.py
@@ -66,6 +66,7 @@ def flask_input_yaml_fixture():
                     {"lib": "redis_k8s.redis", "version": "0"},
                     {"lib": "data_platform_libs.s3", "version": "0"},
                     {"lib": "saml_integrator.saml", "version": "0"},
+                    {"lib": "tempo_coordinator_k8s.tracing", "version": "0"},
                 ],
                 "config": {
                     "options": {**FlaskFramework.options},
@@ -142,6 +143,7 @@ def flask_input_yaml_fixture():
                     {"lib": "redis_k8s.redis", "version": "0"},
                     {"lib": "data_platform_libs.s3", "version": "0"},
                     {"lib": "saml_integrator.saml", "version": "0"},
+                    {"lib": "tempo_coordinator_k8s.tracing", "version": "0"},
                 ],
                 "config": {
                     "options": {**DjangoFramework.options},
@@ -208,6 +210,7 @@ def flask_input_yaml_fixture():
                     {"lib": "redis_k8s.redis", "version": "0"},
                     {"lib": "data_platform_libs.s3", "version": "0"},
                     {"lib": "saml_integrator.saml", "version": "0"},
+                    {"lib": "tempo_coordinator_k8s.tracing", "version": "0"},
                 ],
                 "config": {
                     "options": {**GoFramework.options},
@@ -274,6 +277,7 @@ def flask_input_yaml_fixture():
                     {"lib": "redis_k8s.redis", "version": "0"},
                     {"lib": "data_platform_libs.s3", "version": "0"},
                     {"lib": "saml_integrator.saml", "version": "0"},
+                    {"lib": "tempo_coordinator_k8s.tracing", "version": "0"},
                 ],
                 "config": {
                     "options": {**FastAPIFramework.options},

From 26cae9f03a177092e12f7647a7b27a46aae5aadb Mon Sep 17 00:00:00 2001
From: Michael DuBelko <michael.dubelko@canonical.com>
Date: Mon, 10 Feb 2025 18:08:11 -0800
Subject: [PATCH 10/11] docs: ta review

---
 docs/reference/extensions/django-framework-extension.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/reference/extensions/django-framework-extension.rst b/docs/reference/extensions/django-framework-extension.rst
index f10e52163..cbd41bb19 100644
--- a/docs/reference/extensions/django-framework-extension.rst
+++ b/docs/reference/extensions/django-framework-extension.rst
@@ -288,7 +288,7 @@ than one unit in the application, the services with the name ending in
 Observability
 -------------
 
-12-Factor charms are designed to be easily observable using the
+12-factor app charms are designed to be easily observable using the
 `Canonical Observability Stack
 <https://charmhub.io/topics/canonical-observability-stack>`__.
 
@@ -309,8 +309,8 @@ using Grafana dashboards.
 In addition to that you can also trace your workload code
 using `Tempo <https://charmhub.io/topics/charmed-tempo-ha>`__.
 
-To learn about how to deploy Tempo you can read the
-documentation `here <https://charmhub.io/topics/charmed-tempo-ha>`__.
+See `Charmed Tempo HA <https://charmhub.io/topics/charmed-tempo-ha>`_ on Discourse to
+learn more about how to deploy Tempo.
 
 OpenTelemetry will automatically read the environment variables
 and configure the OpenTelemetry SDK to use them.

From 1aa8afaebb57286fa9484cd422326388c3361fda Mon Sep 17 00:00:00 2001
From: Michael DuBelko <michael.dubelko@canonical.com>
Date: Mon, 10 Feb 2025 18:10:48 -0800
Subject: [PATCH 11/11] docs: fix broken ref to 12-factor how-to

---
 docs/reference/extensions/django-framework-extension.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/reference/extensions/django-framework-extension.rst b/docs/reference/extensions/django-framework-extension.rst
index cbd41bb19..43c6bd4ec 100644
--- a/docs/reference/extensions/django-framework-extension.rst
+++ b/docs/reference/extensions/django-framework-extension.rst
@@ -26,7 +26,7 @@ contents will be removed upon a new container being deployed. The
 for every application, such as
 `PostgreSQL <https://www.postgresql.org/>`_ or
 `MySQL <https://www.mysql.com/>`_. See the
-:ref:`how-to guide <manage-a-12-factor-app-charm>` for how to deploy
+:ref:`how-to guide <manage-12-factor-app-charms>` for how to deploy
 a database and integrate the Django application with it.