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

…rameworks.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

gregory-schiano · 2025-01-16T11:47:35Z

tests/integration/integrations/test_tracing.py

+@pytest.mark.parametrize(
+    "tracing_app, port",
+    [
+        ("flask_tracing_app", 8000),
+        ("django_tracing_app", 8000),
+        ("fastapi_tracing_app", 8080),
+        ("go_tracing_app", 8080),
+    ],
+)


I think you can use indirect fixture by using indirect=["tracing_app"]

This will avoid calling getfixturevalue

I tried to use this but it turns out it doesn't call the flask_tracing_app when you use indirect. What it does is calls the tracing_app fixture with a parameter that is flask_tracing_app. If I do that I have to create a fixture like the following:

@pytest.fixture(name="tracing_app") async def tracing_app_fixture(request): return await request.getfixturevalue(request.param)

I think this is worse then just using the getfixturevalue inside the test. Since in both cases we use that function and in indirect method we add more lines.

But if you think indirect method is better I can implement it.

gregory-schiano · 2025-01-16T11:49:52Z

tests/integration/integrations/test_tracing.py

+    tracing_app = request.getfixturevalue(tracing_app)
+    idle_list = [tracing_app.name]
+
+    if tracing_app != "flask_tracing_app":


Should probably be tracing_app.name

fixed re-assigning the variable issues. Thanks for pointing out

… into tempo-tracing

gregory-schiano · 2025-01-16T11:56:57Z

tests/unit/flask/test_tracing.py

+from .constants import DEFAULT_LAYER, FLASK_CONTAINER_NAME
+
+
+def test_tracing_relation(harness: Harness):


I'd add a test with tracing disabled and ensure the envvars aren't injected
And I think you can also add a test in test_webserver.py that ensure the generated gunicorn config contains the tracing methods

I will also try to add a test for the following lines:

try: # pylint: disable=ungrouped-imports from charms.tempo_coordinator_k8s.v0.tracing import TracingEndpointRequirer except ImportError: logger.exception( "Missing charm library, please run " "`charmcraft fetch-lib charms.tempo_coordinator_k8s.v0.tracing`" )

javierdelapuente

Good work!

Just a question (maybe I it is already discussed). As the examples are similar to the base ones, why not updating the base examples instead of adding new ones?

javierdelapuente · 2025-01-16T16:10:03Z

src/paas_charm/_gunicorn/webserver.py

+            "OTEL_EXPORTER_OTLP_ENDPOINT", None
+        ):
+            config += textwrap.dedent(
+                """\


Maybe it could be simpler to put the configuration in a jinja template or similar, as it it slowly getting complex

javierdelapuente · 2025-01-16T16:17:05Z

src/paas_charm/charm_state.py

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


+class TempoParameters(BaseModel):


Although ordering the classes so everything is defined before is used has advantages, it also has disadvantages.

The disadvantage of putting this class as the first one of the file, is that when opening it, it takes a while to realise that the most important class is CharmState and what it contains. In this way readibility is decreased. This is similar to https://github.com/canonical/is-charms-contributing-guide/blob/main/CONTRIBUTING.md#function-and-method-Ordering

WDYT? @jdkandersson

The reason is around that these are classes that other classes depend on so you have to define them first I think

In our case the difference is this:

- s3_parameters: "S3Parameters | None" = None - saml_parameters: "SamlParameters | None" = None + s3_parameters: S3Parameters | None = None + saml_parameters: SamlParameters | None = None

the type hints have to be defined with strings. It is of course a matter of preference. My opinion leans toward using strings (that are checked by the linter), although they are not as elegant.

javierdelapuente · 2025-01-16T16:19:19Z

tests/integration/integrations/conftest.py

+
+PROJECT_ROOT = pathlib.Path(__file__).parent.parent.parent.parent
+
+import nest_asyncio


is this needed?

javierdelapuente · 2025-01-16T16:24:06Z

tests/integration/integrations/test_tracing.py

+    """
+
+    try:
+        tempo_app = await request.getfixturevalue("tempo_app")


why not having a fixture for this?

javierdelapuente · 2025-01-16T16:27:32Z

tests/integration/integrations/test_tracing.py

+
+    if tracing_app.name != "flask-tracing-k8s":
+        try:
+            postgresql_app = request.getfixturevalue("postgresql_k8s")


could postgresq_k8s be integrated in the django_tracing_app /fastapi_tracing_app instead?

This would copy the same piece of code to 3 different places(go, fastapi, django). WDYT @jdkandersson ?

There will be two more lines in each those three fixtures. However in this if there are already 8 lines. Besides, all the fixtures will be complete and equal, and also could be reused in other tests (currently, for example the flask-tracing-k8s waits for the app to be active but not the others).

javierdelapuente · 2025-01-16T16:29:52Z

tests/unit/flask/test_tracing.py

+
+import ops
+import pytest
+from ops.testing import Harness


would it be very difficult to write the new tests using scenario as harness is legacy?

github-actions · 2025-01-17T06:23:04Z

Test coverage for 4f05ded

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           100      4     22      3    94%   177->182, 179->182, 233, 245-251
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                           171      0     62      5    98%   113->exit, 170->176, 280->282, 282->285, 363->365
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, 519-520, 525, 530, 535, 545, 550, 555, 560, 565, 590, 625
src/paas_charm/charm_state.py                   111      2     12      2    97%   280, 376
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                                          1247     82    248     34    92%

Static code analysis report

Run started:2025-01-17 06:22:27.484329

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2652
  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):

jdkandersson · 2025-01-17T08:57:33Z

I think I agree with Javi that we should just use existing examples and add tempo to them. Adding a lot of extra examples is a lot to maintain

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

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

alithethird added 3 commits January 15, 2025 07:11

chore(Format): Remove unnecessary files and format code

02624c5

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

47d5b91

… into tempo-tracing

Chore(test): Fix unit test

068a3c1

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

alithethird and others added 10 commits January 15, 2025 09:10

Chore(test): Fix false positive

a12f204

chore(format):format

af0c47c

Chore(test): Skip if juju <=3.4

707af93

Chore(format): Format

1ca07aa

Chore(test): juju version skip fixed.

f566767

chore(): Skip test at model level

0e090cc

Chore(): Change matrix to not include workload stuff for juju 3.3

32fb470

chore(test): Move all tracing tests into one module and parametrize f…

66fb938

…rameworks.

Chore(): Cleanup the code and update docstrings.

e1624fe

chore(): Update app.py

2650b7b

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

alithethird requested review from jdkandersson, javierdelapuente and weiiwang01 January 16, 2025 10:50

gregory-schiano reviewed Jan 16, 2025

View reviewed changes

alithethird added 2 commits January 16, 2025 14:51

chore():Address comments

ebcccf4

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

fbc66ab

… into tempo-tracing

gregory-schiano reviewed Jan 16, 2025

View reviewed changes

javierdelapuente reviewed Jan 16, 2025

View reviewed changes

alithethird added 4 commits January 16, 2025 22:48

Chore(): Fix

cdb1902

chore(test): Improve tests

f7e9645

chore(trivy): Add back Go stdlib ignore

a5bd4fe

chore(trivy): Add back

4f05ded

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

gregory-schiano Jan 16, 2025

alithethird Jan 17, 2025

alithethird Jan 17, 2025

gregory-schiano Jan 16, 2025

alithethird Jan 17, 2025

gregory-schiano Jan 16, 2025

alithethird Jan 17, 2025

alithethird Jan 17, 2025

javierdelapuente left a comment

javierdelapuente Jan 16, 2025

javierdelapuente Jan 16, 2025

alithethird Jan 17, 2025

jdkandersson Jan 17, 2025

javierdelapuente Jan 17, 2025

javierdelapuente Jan 16, 2025

javierdelapuente Jan 16, 2025

javierdelapuente Jan 16, 2025

alithethird Jan 17, 2025 •

edited

Loading

javierdelapuente Jan 17, 2025

javierdelapuente Jan 16, 2025

github-actions bot commented Jan 17, 2025

jdkandersson commented Jan 17, 2025

		from .constants import DEFAULT_LAYER, FLASK_CONTAINER_NAME


		def test_tracing_relation(harness: Harness):

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


		class TempoParameters(BaseModel):


		PROJECT_ROOT = pathlib.Path(__file__).parent.parent.parent.parent

		import nest_asyncio

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

javierdelapuente 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

alithethird Jan 17, 2025 • edited Loading

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 17, 2025

jdkandersson commented Jan 17, 2025

alithethird commented Dec 16, 2024 •

edited

Loading

alithethird Jan 17, 2025 •

edited

Loading