feature: add open telemetry integration

[fcarreno-collab]

ref: https://app.clickup.com/t/86b7bdn9g

[caseylocker]

You're defining randomString in api/tests/open_telemetry_instrumentation_tests.py but not using it:

class OpenTelemetryInstrumentationTest(APITestCase):
    def randomString(self, str_len):
...

Wrapt was downgraded in the requirements.txt. Was that intentional?
wrapt==2.0.1 -> wrapt==1.17.3

[fcarreno-collab]

You're defining randomString in api/tests/open_telemetry_instrumentation_tests.py but not using it:

class OpenTelemetryInstrumentationTest(APITestCase):
    def randomString(self, str_len):

@caseylocker I removed this code you are right, its not been used, this was to generate a random string for the access_token we use to authenticate the requests on the other endpoints but here that does not happen

Wrapt was downgraded in the requirements.txt. Was that intentional? wrapt==2.0.1 -> wrapt==1.17.3

@caseylocker it was on propuse because newer versions create dependency conflicts when we try to install the open telemetry instrumentation libraries

[caseylocker]

LGTM. I've confirmed that the wrapt downgrade was a requirement by the Opentelementry instrumentation packages. They explicitly require wrapt<2.0.0. No other packages require wrapt 2.x

[smarcet]

@fcarreno-collab please review comments

[dariobressanExo]

@smarcet please can you review this.

[smarcet]

@fcarreno-collab this import should be moved to the begging of the file

[smarcet]

@fcarreno-collab
The test doesn't care about how many spans exist , it cares that the Django HTTP span has the right attributes. So instead of indexing by position spans[5], find the span by name:

spans = memory_exporter.get_finished_spans()
  self.assertGreaterEqual(len(spans), 1)

  # Find the top-level Django HTTP span by name pattern
  http_spans = [s for s in spans if s.name.startswith("GET ")]
  self.assertEqual(len(http_spans), 1)
  exported_span = http_spans[0]

  # Now assert the actual behavior under test
  self.assertEqual(exported_span.attributes.get("cf.ray_id"), "abc123")

This way the test validates the hook behavior (CF-Ray attribute is set, traceparent propagation works) without coupling to the exact internal span count, which is an implementation detail of the
instrumentation libraries and the request pipeline.

[smarcet]

@fcarreno-collab see https://github.com/fntechgit/marketing-api/pull/3/changes#r2818909831

[smarcet]

@fcarreno-collab
The tests test_mysql_span_has_db_name and test_redis_span_has_key in OpenTelemetryInstrumentationTest (api/tests/open_telemetry_instrumentation_tests.py:138–170) don't actually call the hook
methods they're supposed to test.

the test creates a span, manually sets attributes on it, then reads those same attributes back and asserts they match. It's a round-trip test of the OTEL SDK itself, not of
DjangoTelemetry.mysql_hook.

The mysql_hook has actual logic worth testing:

• It reads DB_NAME from the environment (os.getenv('DB_NAME', 'db'))
• It adds db.system = "mysql" (not present in the test at all)
• It guards with span.is_recording()
• It swallows exceptions silently

None of that is exercised. The test would pass even if mysql_hook didn't exist.

[smarcet]

@fcarreno-collab please review

[fcarreno-collab]

@smarcet changes related your comments already on PR

[smarcet]

@fcarreno-collab why this deps was downgraded ?
wrapt==2.0.1

[fcarreno-collab]

@smarcet the dependency downgrade was on propuse because newer versions create dependency conflicts when we try to install the open telemetry instrumentation libraries, I explain this to @caseylocker and he confirm it

[smarcet]

@fcarreno-collab please follow the same pattern as other hooks here

if not span.is_recording():
          return
      try:
          if hasattr(response, "content"):
              span.set_attribute("http.response.length", len(response.content))
      except Exception:
          pass

[fcarreno-collab]

changed

[smarcet]

@fcarreno-collab
When there's no Cf-Ray header, this sets cf.ray_id = "" on every span, adding noise. Should skip the attribute entirely

 cf_ray = request.headers.get("Cf-Ray")
  if cf_ray:
      span.set_attribute("cf.ray_id", cf_ray)

[fcarreno-collab]

changed

[smarcet]

@fcarreno-collab please review comments

[fcarreno-collab]

@smarcet branch updated with requested changes