python/iot3: add service_id to OTLP spans

[ymorin-orange]

Changes

• IoT3 SDK:
  • core: add service-id tag to OTLP trace spans
• applications:
  • interqueuemanager: set the service-id tag
  • vehicle: set the service-id tag

Close #491

Test

How to test

Note: in the following, lines starting with $ are to be executed on your
machine, as a non-root user;
lines starting with (docker)$ are to be executed in the Docker container;
lines starting with (docker)🐍 $ are to be executed in the Docker container,
in the python venv.

1. Prepare a test environment:
   1. in a terminal, prepare a collector implementing the OpenTelemetry API, on localhost. If you don't have one, you may use an existing one, like:

      $ docker container run \
          --rm \
          -p 16686:16686 \
          -p 4318:4318 \
          jaegertracing/all-in-one:1.58
      

      then open a browser on the Jaegger UI (or that of your own collector if you have one):

      http://localhost:16686/
      

   2. in another terminal, start a container with Python 3.11
      and the necessary packages:

      $ docker container run \
          --detach \
          --name iot3 \
          --rm \
          -ti \
          --network host \
          -e http_proxy \
          -e https_proxy \
          -e no_proxy \
          --user $(id -u):$(id -u) \
          --mount type=bind,source=$(pwd),destination=$(pwd) \
          --workdir $(pwd) \
          python:3.11.14-slim-trixie \
          /bin/bash -il
      
      $ docker container exec -u 0:0 iot3 apt update
      $ docker container exec -u 0:0 iot3 apt install -y git build-essential
      
      $ docker container attach iot3

   3. prepare a Python 3.11 environment

      (docker)$ python3.11 -m venv /tmp/venv
      (docker)$ . /tmp/venv/bin/activate

2. Build the Python IoT3 package:

   (docker)🐍 $ pip \
                   --disable-pip-version-check \
                   --no-cache-dir \
                   wheel \
                   -w /tmp/wheels \
                   python/iot3

3. Install the Python IoT3 package:

   (docker)🐍 $ pip \
                   --disable-pip-version-check \
                   --no-cache-dir \
                   install \
                   --no-deps \
                   /tmp/wheels/*.whl

4. Run the IoT3 Core SDK tests:

   (docker)🐍 ./python/iot3/tests/test-iot3-core-otel

5. In the Jaeger UI, search traces for the test-service. Open a span, and look for its attributes.

Expected results

1. The test environment is ready
2. The package was built successfully
3. The package was installed successfully
4. The test succeds
5. The traces are available; spans have an attribute named iot3.core.service_id with value test_42.

[Hugues360]

The description of the MR is not updated (in particular the link of the issue to be fixed)

[Hugues360]

I had a problem to get python:3.11.17-slim-trixie:
docker: Error response from daemon: manifest for python:3.11.17-slim-trixie not found: manifest unknown: manifest unknown.
I made the test with python:3.11.14-slim-trixie

[Hugues360]

A little proposed modification for the type of service_id (Optional[str] should be I think better) but everything is ok otherwise, I approve

[Hugues360]

srvice-id should be Optional[str], no?

[ymorin-orange]

srvice-id should be Optional[str], no?

Indeed. And this is also missing on others parameters too... I'll fix all of that, thanks!

[ymorin-orange]

I made the test with python:3.11.14-slim-trixie

MR description updated, thanks.

[ymorin-orange]

The description of the MR is not updated (in particular the link of the issue to be fixed)

MR description updated, thanks.