Tempo tracing #20

alithethird · 2024-12-16T08:02:15Z

Overview

Adds new integration Tempo to the charm. Creates a class called TempoParameters that handles the parameters. There are only 2 parameters:

Endpoint
Service name

Endpoint comes from the integration and service name is generated by reading the charm name from the charmcraft.yaml file.

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

The charm style guide was applied
The contributing guide was applied
The changes are compliant with ISD054 - Managing Charm Complexity
The documentation is generated using src-docs
The documentation for charmhub is updated
The PR is tagged with appropriate label (urgent, trivial, complex)
The changelog has been updated

src/paas_charm/app.py

src/paas_charm/charm.py

src/paas_charm/charm_state.py

github-actions

license-eye has checked 264 files.

Valid	Invalid	Ignored	Fixed
0	148	116	0

Click to see the invalid file list

examples/django/charm/charmcraft.yaml
examples/django/charm/src/charm.py
examples/django/django_app/django_app/django_app/init.py
examples/django/django_app/django_app/django_app/asgi.py
examples/django/django_app/django_app/django_app/settings.py
examples/django/django_app/django_app/django_app/urls.py
examples/django/django_app/django_app/django_app/wsgi.py
examples/django/django_app/django_app/manage.py
examples/django/django_app/django_app/migrate.sh
examples/django/django_app/django_app/testing/init.py
examples/django/django_app/django_app/testing/admin.py
examples/django/django_app/django_app/testing/apps.py
examples/django/django_app/django_app/testing/migrations/init.py
examples/django/django_app/django_app/testing/models.py
examples/django/django_app/django_app/testing/tests.py
examples/django/django_app/django_app/testing/views.py
examples/django/django_app/rockcraft.yaml
examples/django/django_async_app/django_async_app/django_async_app/init.py
examples/django/django_async_app/django_async_app/django_async_app/asgi.py
examples/django/django_async_app/django_async_app/django_async_app/settings.py
examples/django/django_async_app/django_async_app/django_async_app/urls.py
examples/django/django_async_app/django_async_app/django_async_app/wsgi.py
examples/django/django_async_app/django_async_app/manage.py
examples/django/django_async_app/django_async_app/testing/init.py
examples/django/django_async_app/django_async_app/testing/admin.py
examples/django/django_async_app/django_async_app/testing/apps.py
examples/django/django_async_app/django_async_app/testing/migrations/init.py
examples/django/django_async_app/django_async_app/testing/models.py
examples/django/django_async_app/django_async_app/testing/tests.py
examples/django/django_async_app/django_async_app/testing/views.py
examples/django/django_async_app/rockcraft.yaml
examples/fastapi/alembic.ini
examples/fastapi/alembic/env.py
examples/fastapi/alembic/versions/eca6177bd16a_initial_migration.py
examples/fastapi/app.py
examples/fastapi/charm/charmcraft.yaml
examples/fastapi/charm/src/charm.py
examples/fastapi/migrate.sh
examples/fastapi/rockcraft.yaml
examples/flask/charmcraft.yaml
examples/flask/src/charm.py
examples/flask/test_async_rock/app.py
examples/flask/test_async_rock/rockcraft.yaml
examples/flask/test_db_rock/alembic.ini
examples/flask/test_db_rock/alembic/env.py
examples/flask/test_db_rock/alembic/versions/eca6177bd16a_initial_migration.py
examples/flask/test_db_rock/app.py
examples/flask/test_db_rock/migrate.sh
examples/flask/test_db_rock/rockcraft.yaml
examples/flask/test_rock/app.py
examples/flask/test_rock/rockcraft.yaml
examples/go/charm/charmcraft.yaml
examples/go/charm/src/charm.py
examples/go/go.mod
examples/go/internal/service/service.go
examples/go/main.go
examples/go/migrate.sh
examples/go/rockcraft.yaml
localstack-installation.sh
pyproject.toml
setup.py
src/paas_app_charmer/init.py
src/paas_app_charmer/django/init.py
src/paas_app_charmer/django/charm.py
src/paas_app_charmer/fastapi/init.py
src/paas_app_charmer/fastapi/charm.py
src/paas_app_charmer/flask/init.py
src/paas_app_charmer/flask/charm.py
src/paas_app_charmer/go/init.py
src/paas_app_charmer/go/charm.py
src/paas_charm/init.py
src/paas_charm/_gunicorn/init.py
src/paas_charm/_gunicorn/charm.py
src/paas_charm/_gunicorn/webserver.py
src/paas_charm/_gunicorn/workload_config.py
src/paas_charm/_gunicorn/wsgi_app.py
src/paas_charm/app.py
src/paas_charm/charm.py
src/paas_charm/charm_state.py
src/paas_charm/charm_utils.py
src/paas_charm/database_migration.py
src/paas_charm/databases.py
src/paas_charm/django/init.py
src/paas_charm/django/charm.py
src/paas_charm/exceptions.py
src/paas_charm/fastapi/init.py
src/paas_charm/fastapi/charm.py
src/paas_charm/flask/init.py
src/paas_charm/flask/charm.py
src/paas_charm/framework.py
src/paas_charm/go/init.py
src/paas_charm/go/charm.py
src/paas_charm/observability.py
src/paas_charm/rabbitmq.py
src/paas_charm/secret_storage.py
src/paas_charm/utils.py
tests/init.py
tests/conftest.py
tests/integration/conftest.py
tests/integration/django/init.py
tests/integration/django/conftest.py
tests/integration/django/test_django.py
tests/integration/django/test_django_integrations.py
tests/integration/django/test_workers.py
tests/integration/fastapi/init.py
tests/integration/fastapi/conftest.py
tests/integration/fastapi/test_fastapi.py
tests/integration/flask/init.py
tests/integration/flask/conftest.py
tests/integration/flask/test_charm.py
tests/integration/flask/test_cos.py
tests/integration/flask/test_database.py
tests/integration/flask/test_db_migration.py
tests/integration/flask/test_integrations.py
tests/integration/flask/test_proxy.py
tests/integration/flask/test_workers.py
tests/integration/go/init.py
tests/integration/go/conftest.py
tests/integration/go/test_go.py
tests/integration/helpers.py
tests/unit/init.py
tests/unit/django/init.py
tests/unit/django/conftest.py
tests/unit/django/constants.py
tests/unit/django/test_charm.py
tests/unit/django/test_workers.py
tests/unit/fastapi/init.py
tests/unit/fastapi/conftest.py
tests/unit/fastapi/constants.py
tests/unit/fastapi/test_charm.py
tests/unit/flask/init.py
tests/unit/flask/conftest.py
tests/unit/flask/constants.py
tests/unit/flask/test_charm.py
tests/unit/flask/test_charm_state.py
tests/unit/flask/test_database_migration.py
tests/unit/flask/test_databases.py
tests/unit/flask/test_flask_app.py
tests/unit/flask/test_tracing.py
tests/unit/flask/test_webserver.py
tests/unit/flask/test_workers.py
tests/unit/go/init.py
tests/unit/go/conftest.py
tests/unit/go/constants.py
tests/unit/go/test_app.py
tests/unit/go/test_charm.py
tests/unit/test_deprecated.py
tox.ini

Use this command to fix any missing license headers

```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

github-actions

license-eye has checked 264 files.

Valid	Invalid	Ignored	Fixed
0	148	116	0

Click to see the invalid file list

examples/django/charm/charmcraft.yaml
examples/django/charm/src/charm.py
examples/django/django_app/django_app/django_app/init.py
examples/django/django_app/django_app/django_app/asgi.py
examples/django/django_app/django_app/django_app/settings.py
examples/django/django_app/django_app/django_app/urls.py
examples/django/django_app/django_app/django_app/wsgi.py
examples/django/django_app/django_app/manage.py
examples/django/django_app/django_app/migrate.sh
examples/django/django_app/django_app/testing/init.py
examples/django/django_app/django_app/testing/admin.py
examples/django/django_app/django_app/testing/apps.py
examples/django/django_app/django_app/testing/migrations/init.py
examples/django/django_app/django_app/testing/models.py
examples/django/django_app/django_app/testing/tests.py
examples/django/django_app/django_app/testing/views.py
examples/django/django_app/rockcraft.yaml
examples/django/django_async_app/django_async_app/django_async_app/init.py
examples/django/django_async_app/django_async_app/django_async_app/asgi.py
examples/django/django_async_app/django_async_app/django_async_app/settings.py
examples/django/django_async_app/django_async_app/django_async_app/urls.py
examples/django/django_async_app/django_async_app/django_async_app/wsgi.py
examples/django/django_async_app/django_async_app/manage.py
examples/django/django_async_app/django_async_app/testing/init.py
examples/django/django_async_app/django_async_app/testing/admin.py
examples/django/django_async_app/django_async_app/testing/apps.py
examples/django/django_async_app/django_async_app/testing/migrations/init.py
examples/django/django_async_app/django_async_app/testing/models.py
examples/django/django_async_app/django_async_app/testing/tests.py
examples/django/django_async_app/django_async_app/testing/views.py
examples/django/django_async_app/rockcraft.yaml
examples/fastapi/alembic.ini
examples/fastapi/alembic/env.py
examples/fastapi/alembic/versions/eca6177bd16a_initial_migration.py
examples/fastapi/app.py
examples/fastapi/charm/charmcraft.yaml
examples/fastapi/charm/src/charm.py
examples/fastapi/migrate.sh
examples/fastapi/rockcraft.yaml
examples/flask/charmcraft.yaml
examples/flask/src/charm.py
examples/flask/test_async_rock/app.py
examples/flask/test_async_rock/rockcraft.yaml
examples/flask/test_db_rock/alembic.ini
examples/flask/test_db_rock/alembic/env.py
examples/flask/test_db_rock/alembic/versions/eca6177bd16a_initial_migration.py
examples/flask/test_db_rock/app.py
examples/flask/test_db_rock/migrate.sh
examples/flask/test_db_rock/rockcraft.yaml
examples/flask/test_rock/app.py
examples/flask/test_rock/rockcraft.yaml
examples/go/charm/charmcraft.yaml
examples/go/charm/src/charm.py
examples/go/go.mod
examples/go/internal/service/service.go
examples/go/main.go
examples/go/migrate.sh
examples/go/rockcraft.yaml
localstack-installation.sh
pyproject.toml
setup.py
src/paas_app_charmer/init.py
src/paas_app_charmer/django/init.py
src/paas_app_charmer/django/charm.py
src/paas_app_charmer/fastapi/init.py
src/paas_app_charmer/fastapi/charm.py
src/paas_app_charmer/flask/init.py
src/paas_app_charmer/flask/charm.py
src/paas_app_charmer/go/init.py
src/paas_app_charmer/go/charm.py
src/paas_charm/init.py
src/paas_charm/_gunicorn/init.py
src/paas_charm/_gunicorn/charm.py
src/paas_charm/_gunicorn/webserver.py
src/paas_charm/_gunicorn/workload_config.py
src/paas_charm/_gunicorn/wsgi_app.py
src/paas_charm/app.py
src/paas_charm/charm.py
src/paas_charm/charm_state.py
src/paas_charm/charm_utils.py
src/paas_charm/database_migration.py
src/paas_charm/databases.py
src/paas_charm/django/init.py
src/paas_charm/django/charm.py
src/paas_charm/exceptions.py
src/paas_charm/fastapi/init.py
src/paas_charm/fastapi/charm.py
src/paas_charm/flask/init.py
src/paas_charm/flask/charm.py
src/paas_charm/framework.py
src/paas_charm/go/init.py
src/paas_charm/go/charm.py
src/paas_charm/observability.py
src/paas_charm/rabbitmq.py
src/paas_charm/secret_storage.py
src/paas_charm/utils.py
tests/init.py
tests/conftest.py
tests/integration/conftest.py
tests/integration/django/init.py
tests/integration/django/conftest.py
tests/integration/django/test_django.py
tests/integration/django/test_django_integrations.py
tests/integration/django/test_workers.py
tests/integration/fastapi/init.py
tests/integration/fastapi/conftest.py
tests/integration/fastapi/test_fastapi.py
tests/integration/flask/init.py
tests/integration/flask/conftest.py
tests/integration/flask/test_charm.py
tests/integration/flask/test_cos.py
tests/integration/flask/test_database.py
tests/integration/flask/test_db_migration.py
tests/integration/flask/test_integrations.py
tests/integration/flask/test_proxy.py
tests/integration/flask/test_workers.py
tests/integration/go/init.py
tests/integration/go/conftest.py
tests/integration/go/test_go.py
tests/integration/helpers.py
tests/unit/init.py
tests/unit/django/init.py
tests/unit/django/conftest.py
tests/unit/django/constants.py
tests/unit/django/test_charm.py
tests/unit/django/test_workers.py
tests/unit/fastapi/init.py
tests/unit/fastapi/conftest.py
tests/unit/fastapi/constants.py
tests/unit/fastapi/test_charm.py
tests/unit/flask/init.py
tests/unit/flask/conftest.py
tests/unit/flask/constants.py
tests/unit/flask/test_charm.py
tests/unit/flask/test_charm_state.py
tests/unit/flask/test_database_migration.py
tests/unit/flask/test_databases.py
tests/unit/flask/test_flask_app.py
tests/unit/flask/test_tracing.py
tests/unit/flask/test_webserver.py
tests/unit/flask/test_workers.py
tests/unit/go/init.py
tests/unit/go/conftest.py
tests/unit/go/constants.py
tests/unit/go/test_app.py
tests/unit/go/test_charm.py
tests/unit/test_deprecated.py
tox.ini

Use this command to fix any missing license headers

```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

github-actions

license-eye has checked 300 files.

Valid	Invalid	Ignored	Fixed
0	177	123	0

Click to see the invalid file list

app.py
examples/django/charm/charmcraft.yaml
examples/django/charm/src/charm.py
examples/django/django_app/django_app/django_app/init.py
examples/django/django_app/django_app/django_app/asgi.py
examples/django/django_app/django_app/django_app/settings.py
examples/django/django_app/django_app/django_app/urls.py
examples/django/django_app/django_app/django_app/wsgi.py
examples/django/django_app/django_app/manage.py
examples/django/django_app/django_app/migrate.sh
examples/django/django_app/django_app/testing/init.py
examples/django/django_app/django_app/testing/admin.py
examples/django/django_app/django_app/testing/apps.py
examples/django/django_app/django_app/testing/migrations/init.py
examples/django/django_app/django_app/testing/models.py
examples/django/django_app/django_app/testing/tests.py
examples/django/django_app/django_app/testing/views.py
examples/django/django_app/rockcraft.yaml
examples/django/django_async_app/django_async_app/django_async_app/init.py
examples/django/django_async_app/django_async_app/django_async_app/asgi.py
examples/django/django_async_app/django_async_app/django_async_app/settings.py
examples/django/django_async_app/django_async_app/django_async_app/urls.py
examples/django/django_async_app/django_async_app/django_async_app/wsgi.py
examples/django/django_async_app/django_async_app/manage.py
examples/django/django_async_app/django_async_app/testing/init.py
examples/django/django_async_app/django_async_app/testing/admin.py
examples/django/django_async_app/django_async_app/testing/apps.py
examples/django/django_async_app/django_async_app/testing/migrations/init.py
examples/django/django_async_app/django_async_app/testing/models.py
examples/django/django_async_app/django_async_app/testing/tests.py
examples/django/django_async_app/django_async_app/testing/views.py
examples/django/django_async_app/rockcraft.yaml
examples/django/django_tracing_app/django_tracing_app/django_tracing_app/init.py
examples/django/django_tracing_app/django_tracing_app/django_tracing_app/asgi.py
examples/django/django_tracing_app/django_tracing_app/django_tracing_app/settings.py
examples/django/django_tracing_app/django_tracing_app/django_tracing_app/urls.py
examples/django/django_tracing_app/django_tracing_app/django_tracing_app/wsgi.py
examples/django/django_tracing_app/django_tracing_app/manage.py
examples/django/django_tracing_app/django_tracing_app/migrate.sh
examples/django/django_tracing_app/django_tracing_app/testing/init.py
examples/django/django_tracing_app/django_tracing_app/testing/admin.py
examples/django/django_tracing_app/django_tracing_app/testing/apps.py
examples/django/django_tracing_app/django_tracing_app/testing/migrations/init.py
examples/django/django_tracing_app/django_tracing_app/testing/models.py
examples/django/django_tracing_app/django_tracing_app/testing/tests.py
examples/django/django_tracing_app/django_tracing_app/testing/views.py
examples/django/django_tracing_app/rockcraft.yaml
examples/fastapi/charm/charmcraft.yaml
examples/fastapi/charm/src/charm.py
examples/fastapi/fastapi_app/alembic.ini
examples/fastapi/fastapi_app/alembic/env.py
examples/fastapi/fastapi_app/alembic/versions/eca6177bd16a_initial_migration.py
examples/fastapi/fastapi_app/app.py
examples/fastapi/fastapi_app/migrate.sh
examples/fastapi/fastapi_app/rockcraft.yaml
examples/fastapi/fastapi_tracing_app/alembic.ini
examples/fastapi/fastapi_tracing_app/alembic/env.py
examples/fastapi/fastapi_tracing_app/alembic/versions/eca6177bd16a_initial_migration.py
examples/fastapi/fastapi_tracing_app/app.py
examples/fastapi/fastapi_tracing_app/migrate.sh
examples/fastapi/fastapi_tracing_app/rockcraft.yaml
examples/flask/charmcraft.yaml
examples/flask/src/charm.py
examples/flask/test_async_rock/app.py
examples/flask/test_async_rock/rockcraft.yaml
examples/flask/test_db_rock/alembic.ini
examples/flask/test_db_rock/alembic/env.py
examples/flask/test_db_rock/alembic/versions/eca6177bd16a_initial_migration.py
examples/flask/test_db_rock/app.py
examples/flask/test_db_rock/migrate.sh
examples/flask/test_db_rock/rockcraft.yaml
examples/flask/test_rock/app.py
examples/flask/test_rock/rockcraft.yaml
examples/flask/test_tracing_rock/app.py
examples/flask/test_tracing_rock/rockcraft.yaml
examples/go/charm/charmcraft.yaml
examples/go/charm/src/charm.py
examples/go/go_app/go.mod
examples/go/go_app/internal/service/service.go
examples/go/go_app/main.go
examples/go/go_app/migrate.sh
examples/go/go_app/rockcraft.yaml
examples/go/go_tracing_app/go.mod
examples/go/go_tracing_app/internal/service/service.go
examples/go/go_tracing_app/main.go
examples/go/go_tracing_app/migrate.sh
examples/go/go_tracing_app/rockcraft.yaml
localstack-installation.sh
pyproject.toml
setup.py
src/paas_app_charmer/init.py
src/paas_app_charmer/django/init.py
src/paas_app_charmer/django/charm.py
src/paas_app_charmer/fastapi/init.py
src/paas_app_charmer/fastapi/charm.py
src/paas_app_charmer/flask/init.py
src/paas_app_charmer/flask/charm.py
src/paas_app_charmer/go/init.py
src/paas_app_charmer/go/charm.py
src/paas_charm/init.py
src/paas_charm/_gunicorn/init.py
src/paas_charm/_gunicorn/charm.py
src/paas_charm/_gunicorn/webserver.py
src/paas_charm/_gunicorn/workload_config.py
src/paas_charm/_gunicorn/wsgi_app.py
src/paas_charm/app.py
src/paas_charm/charm.py
src/paas_charm/charm_state.py
src/paas_charm/charm_utils.py
src/paas_charm/database_migration.py
src/paas_charm/databases.py
src/paas_charm/django/init.py
src/paas_charm/django/charm.py
src/paas_charm/exceptions.py
src/paas_charm/fastapi/init.py
src/paas_charm/fastapi/charm.py
src/paas_charm/flask/init.py
src/paas_charm/flask/charm.py
src/paas_charm/framework.py
src/paas_charm/go/init.py
src/paas_charm/go/charm.py
src/paas_charm/observability.py
src/paas_charm/rabbitmq.py
src/paas_charm/secret_storage.py
src/paas_charm/utils.py
tests/init.py
tests/conftest.py
tests/integration/conftest.py
tests/integration/django/init.py
tests/integration/django/conftest.py
tests/integration/django/test_django.py
tests/integration/django/test_django_integrations.py
tests/integration/django/test_workers.py
tests/integration/fastapi/init.py
tests/integration/fastapi/conftest.py
tests/integration/fastapi/test_fastapi.py
tests/integration/flask/init.py
tests/integration/flask/conftest.py
tests/integration/flask/test_charm.py
tests/integration/flask/test_cos.py
tests/integration/flask/test_database.py
tests/integration/flask/test_db_migration.py
tests/integration/flask/test_integrations.py
tests/integration/flask/test_proxy.py
tests/integration/flask/test_workers.py
tests/integration/go/init.py
tests/integration/go/conftest.py
tests/integration/go/test_go.py
tests/integration/helpers.py
tests/unit/init.py
tests/unit/django/init.py
tests/unit/django/conftest.py
tests/unit/django/constants.py
tests/unit/django/test_charm.py
tests/unit/django/test_workers.py
tests/unit/fastapi/init.py
tests/unit/fastapi/conftest.py
tests/unit/fastapi/constants.py
tests/unit/fastapi/test_charm.py
tests/unit/flask/init.py
tests/unit/flask/conftest.py
tests/unit/flask/constants.py
tests/unit/flask/test_charm.py
tests/unit/flask/test_charm_state.py
tests/unit/flask/test_database_migration.py
tests/unit/flask/test_databases.py
tests/unit/flask/test_flask_app.py
tests/unit/flask/test_tracing.py
tests/unit/flask/test_webserver.py
tests/unit/flask/test_workers.py
tests/unit/go/init.py
tests/unit/go/conftest.py
tests/unit/go/constants.py
tests/unit/go/test_app.py
tests/unit/go/test_charm.py
tests/unit/test_deprecated.py
tox.ini

Use this command to fix any missing license headers

```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

… into tempo-tracing

app.py

examples/flask/lib/charms/tempo_coordinator_k8s/v0/tracing.py

src/paas_charm/templates/gunicorn.conf.py.j2

src/paas_charm/_gunicorn/webserver.py

src/paas_charm/charm.py

src/paas_charm/charm_state.py

…tempo-tracing

This reverts commit a2b439b, reversing changes made to 8eeb7a3.

…tempo-tracing

This reverts commit a2b439b, reversing changes made to 8eeb7a3.

jdkandersson · 2025-01-28T15:14:23Z

examples/fastapi/charm/lib/charms/traefik_k8s/v2/ingress.py

@@ -73,7 +72,7 @@ def _on_ingress_revoked(self, event: IngressPerAppRevokedEvent):

 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 14
+LIBPATCH = 13


it looks like we're going backwards on the version here? Is version 14 available, or perhaps an even later version?

Since the library is in an example folder, they're not automatically updated, all the other examples are using version 13, so Ali aligned.
I think it should be good to:

Upgrade the libraries manually once to get the latest

Add a story to find a way to automate this library upgrade via juju action or renovate

Could done in a separate PR as it's unrelated to this PR

examples/flask/lib/charms/data_platform_libs/v0/data_interfaces.py

gregory-schiano · 2025-01-29T08:09:19Z

examples/fastapi/charm/lib/charms/traefik_k8s/v2/ingress.py

@@ -73,7 +72,7 @@ def _on_ingress_revoked(self, event: IngressPerAppRevokedEvent):

 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 14
+LIBPATCH = 13


Since the library is in an example folder, they're not automatically updated, all the other examples are using version 13, so Ali aligned.
I think it should be good to:

Upgrade the libraries manually once to get the latest

Add a story to find a way to automate this library upgrade via juju action or renovate

examples/flask/lib/charms/data_platform_libs/v0/data_interfaces.py

gregory-schiano · 2025-01-29T08:16:33Z

requirements.txt

We should pin dependencies in requirements.txt

Could be tackled in another PR as it's not related to Tempo tracing

gregory-schiano · 2025-01-29T08:27:28Z

src/paas_charm/charm_state.py

@@ -20,6 +20,95 @@
 logger = logging.getLogger(__name__)


+class TempoParameters(BaseModel):


We're even not consistent because IntegrationState is declared after CharmState but used in a hint in CharmState
I don't like when a linting/hinting tool dictate the structure of the code (in the sense that we do things to please it). The fact that the class must be declared before to be used without strings in the typehints is a limitation of mypy and should force us to go to a less natural ordering.
Usually I'm in favor of ordering in the natural code execution order, as when you reason about the code, you're following it in the order of execution. And that's the order defined in our coding guideline. Generally I'm pretty flexible there, since a small data object (like HTTPProxy) before the CharmState doesn't alter too much the readability, and allows to immediately know Proxy is properly manage in the charm. But when the CharmState becomes more complex with embedded state object, I prefer reading the charmstate first and drill down.

So as a conclusion:

Simple charmstate with few data object, I'm fine having them defined first

More complex charmstate, I'd rather have the charmstate first

gregory-schiano · 2025-01-29T08:39:48Z

src/paas_charm/charm.py

@@ -498,7 +492,7 @@ def _create_charm_state(self) -> CharmState:
            s3_connection_info=self._s3.get_s3_connection_info() if self._s3 else None,
            saml_relation_data=saml_relation_data,
            rabbitmq_uri=self._rabbitmq.rabbitmq_uri() if self._rabbitmq else None,
-            tracing_relation_data=tracing_relation_data,
+            tempo_parameters=TempoParameters.from_charm(name=self.app.name, tracing=self._tracing),


I feel like the approach is incoherent compared to how other optional relations are treated. S3 and SAML for example don't use a from_charm passed to the charmstate.
Instead they're passing their parameter to the CharmState and then it leverages the IntegrationState.build to generate the Parameters objects.

So what I suggest:

Check if the relation exists is done in this method for other relation

Similarly to saml_relation_data, build a dict that is either None or contains the data required for the TempoParameters

Pass that dict to the CharmState.from_charm, that will use the IntegrationState.build with these parameters, to return the TempoParameters

…alized.

github-actions · 2025-01-29T11:31:41Z

Test coverage for d2899a0

Name                                          Stmts   Miss Branch BrPart  Cover   Missing
-----------------------------------------------------------------------------------------
src/paas_app_charmer/__init__.py                  2      0      0      0   100%
src/paas_app_charmer/django/__init__.py           2      0      0      0   100%
src/paas_app_charmer/django/charm.py              2      0      0      0   100%
src/paas_app_charmer/fastapi/__init__.py          2      0      0      0   100%
src/paas_app_charmer/fastapi/charm.py             2      0      0      0   100%
src/paas_app_charmer/flask/__init__.py            2      0      0      0   100%
src/paas_app_charmer/flask/charm.py               2      0      0      0   100%
src/paas_app_charmer/go/__init__.py               2      0      0      0   100%
src/paas_app_charmer/go/charm.py                  2      0      0      0   100%
src/paas_charm/__init__.py                       32     17      0      0    47%   13-14, 19-20, 26-27, 33-37, 43-44, 50-51, 57-58
src/paas_charm/_gunicorn/__init__.py              0      0      0      0   100%
src/paas_charm/_gunicorn/charm.py                42      0      6      0   100%
src/paas_charm/_gunicorn/webserver.py            90      4     16      1    95%   209, 221-227
src/paas_charm/_gunicorn/workload_config.py       8      0      0      0   100%
src/paas_charm/_gunicorn/wsgi_app.py             21      0      2      0   100%
src/paas_charm/app.py                           172      0     62      5    98%   115->exit, 172->178, 282->284, 284->287, 365->367
src/paas_charm/charm.py                         294     35     62      4    88%   35-36, 43-44, 51-52, 165-166, 188-189, 209-210, 260-261, 305, 315-316, 318-319, 348-352, 420, 520-521, 526, 531, 536, 546, 551, 556, 561, 566, 591, 626
src/paas_charm/charm_state.py                   123      2     12      2    97%   177, 325
src/paas_charm/charm_utils.py                    23      0      0      0   100%
src/paas_charm/database_migration.py             35      0      2      0   100%
src/paas_charm/databases.py                      25      2      6      1    90%   89-90
src/paas_charm/django/__init__.py                 2      0      0      0   100%
src/paas_charm/django/charm.py                   50      4      8      2    90%   49, 124, 139-140
src/paas_charm/exceptions.py                      5      0      0      0   100%
src/paas_charm/fastapi/__init__.py                2      0      0      0   100%
src/paas_charm/fastapi/charm.py                  31      0      0      0   100%
src/paas_charm/flask/__init__.py                  2      0      0      0   100%
src/paas_charm/flask/charm.py                    26      0      0      0   100%
src/paas_charm/framework.py                      23      4     12      2    77%   36, 49-51
src/paas_charm/go/__init__.py                     2      0      0      0   100%
src/paas_charm/go/charm.py                       28      0      0      0   100%
src/paas_charm/observability.py                  24      3      4      1    86%   42->46, 73-77
src/paas_charm/rabbitmq.py                       78      2     22      5    93%   117->exit, 122->exit, 157->exit, 159-160, 181->175
src/paas_charm/secret_storage.py                 50      2     14      4    91%   55->54, 56->58, 86, 105
src/paas_charm/utils.py                          44      7     14      5    79%   34, 36, 56-57, 75, 79, 104
-----------------------------------------------------------------------------------------
TOTAL                                          1250     82    242     32    92%

Static code analysis report

Run started:2025-01-29 11:18:31.267099

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2684
  Total lines skipped (#nosec): 1
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 2

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

alithethird added 11 commits December 16, 2024 10:42

feat(tracing): Init gunicorn tracing

eca6a14

chore(example): Change paas-charm branch in example flask

0fabc4f

chore(example): Fix missing import and libraries

7fa73fe

chore(): Fix wrong function

4da5103

feat(tracing): Remove unused topology, bring order to code

311854f

feat(tracing): Implemented environmental approach

8ba4b39

chore(): Remove unnecessary log

5df179c

chore(): Write interface

ae59283

chore(): Cleaning

f9b6b3c

chore(): More cleaning

99172b1

chore(): Remove empty line

f999115

canonical deleted a comment from github-actions bot Dec 18, 2024

alithethird marked this pull request as ready for review December 18, 2024 08:00

alithethird requested a review from a team as a code owner December 18, 2024 08:00

chore(): Add unit test for env variables.

b3f845b

jdkandersson reviewed Dec 19, 2024

View reviewed changes

alithethird added 2 commits December 19, 2024 12:55

chore(): Addressed comment

ca89e47

chore(): Modify examples to test out tracing.

259648d

github-actions bot reviewed Jan 6, 2025

View reviewed changes

chore(lint): Format code

6cda4e5

canonical deleted a comment from github-actions bot Jan 6, 2025

Merge remote-tracking branch 'origin/main' into tempo-tracing

ea0cf59

github-actions bot reviewed Jan 6, 2025

View reviewed changes

canonical deleted a comment from github-actions bot Jan 8, 2025

alithethird added 2 commits January 8, 2025 14:34

chore(tracing): Update examples.

8187b23

chore(examples): Fix naming issues with tracing apps examples.

f8c68ce

github-actions bot reviewed Jan 8, 2025

View reviewed changes

chore(lint): Lint

6f77bb3

alithethird added 2 commits January 21, 2025 07:25

Chore(test): Updates app fixtures in integrations tests

7d783d1

Merge branch 'tempo-tracing' of https://github.com/canonical/paas-charm…

38d7f1e

… into tempo-tracing

alithethird mentioned this pull request Jan 21, 2025

feat(tracing): Add commented out tracing relation into templates canonical/charmcraft#2100

Draft

jdkandersson reviewed Jan 23, 2025

View reviewed changes

alithethird and others added 17 commits January 24, 2025 22:13

chore(): Initial

0cbc108

chore(): Needs fixing in unit tests

efc08bf

chore(test): Test

dd52794

Chore(test): Fixed unit tests.

4e7d810

Chore(): Address comments.

2b4923b

Merge branch 'main' into tempo-tracing

6603015

fix(): Fix '

1c0a046

Merge branch 'tempo-tracing' of github.com:canonical/paas-charm into …

5ec6a3f

…tempo-tracing

Fix(config): config error fixed when tracing relation is not there

5c86c23

Chore(): Revert minor changes.

8eeb7a3

Merge branch 'smtp-integration' into tempo-tracing

a2b439b

Un-Merge branch 'smtp-integration' into tempo-tracing

5df9a4d

Merge branch 'tempo-tracing' of github.com:canonical/paas-charm into …

52741d5

…tempo-tracing

Chore(): Add example lib folders to lint ignore

5f37a6a

Revert "Merge branch 'smtp-integration' into tempo-tracing"

3de0fd4

This reverts commit a2b439b, reversing changes made to 8eeb7a3.

Merge branch 'tempo-tracing' of github.com:canonical/paas-charm into …

fe3020f

…tempo-tracing

Revert "Merge branch 'smtp-integration' into tempo-tracing"

f49e157

This reverts commit a2b439b, reversing changes made to 8eeb7a3.

jdkandersson reviewed Jan 28, 2025

View reviewed changes

gregory-schiano reviewed Jan 29, 2025

View reviewed changes

alithethird added 3 commits January 29, 2025 14:03

Chore(reqs): Pinned Jinja2 version.

3b77a71

Chore(state): Addressed comment about Tempo state and how it is initi…

0e469b1

…alized.

Chore(tracing): Fix string format

d2899a0

canonical deleted a comment from github-actions bot Jan 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tempo tracing #20

Tempo tracing #20

alithethird commented Dec 16, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

jdkandersson Jan 28, 2025

gregory-schiano Jan 29, 2025

gregory-schiano Jan 29, 2025

gregory-schiano Jan 29, 2025

gregory-schiano Jan 29, 2025

gregory-schiano Jan 29, 2025

gregory-schiano Jan 29, 2025

gregory-schiano Jan 29, 2025

github-actions bot commented Jan 29, 2025

		@@ -20,6 +20,95 @@
		logger = logging.getLogger(__name__)


		class TempoParameters(BaseModel):

Tempo tracing #20

Are you sure you want to change the base?

Tempo tracing #20

Conversation

alithethird commented Dec 16, 2024 • edited Loading

Overview

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 29, 2025

alithethird commented Dec 16, 2024 •

edited

Loading