feat: otel [very draftey draft]

[dimaqq]

[tbd]

Files

ops/jujuversion.py -- lightweight, no need to instrument
ops/tracing/_buffer.py -- new
ops/tracing/__init__.py -- new, shim only
ops/tracing/_hacks.py -- may have to run first, would have to be exempt
ops/tracing/_fixme.py -- the guts, like sending telemetry out... exempt or not?
ops/version.py -- static content, nothing to instrument
ops/_main.py -- started, possibly more to do
ops/log.py -- recursion prevention added
ops/charm.py -- started
ops/pebble.py -- TBD started, mostly relying on urllib instrumentation though
ops/framework.py -- TBD started
ops/__init__.py -- only shims, no need to instrument
ops/_private/harness.py -- test only
ops/_private/__init__.py -- empty
ops/_private/yaml.py -- done
ops/_private/timeconv.py
ops/model.py
ops/storage.py
ops/lib/__init__.py -- deprecated, will not touch
ops/jujucontext.py -- lightweight, no need to instrument
ops/main.py -- shim only, no need to instrument
ops/testing.py -- out of scope

Functionality

• manual testing harness
• something that received tracing data and dumps it to stdout
• test from console
• test this lib with [tracing]
• test this lib without [tracing]
• test a charm built with ops[tracing]
• test a charm built without ops[tracing]
• test a charm that uses Pietro's charm tracing charm lib with ops
• wait for regression: typing error with start_as_current_span on Python<3.10 open-telemetry/opentelemetry-python#3836
• wait for new opentelemetry release that includes Fix span context manager typing by using ParamSpec from typing_extensions open-telemetry/opentelemetry-python#4389
• clean up all those type: ignore
• doc: expectations for charms and charm libs
• doc: how to use it, with a screenshot
• doc: optional dependencies in general
• doc: the API
• doc: how it works
  • tracing starts early
  • anonymous vs named buffer
  • how tracing data is delivered
  • failure modes

[dimaqq]

Notes:

• adds opentelemetry-api (64kB wheel) to dependencies
• adds a bunch of opentelemetry-this-and-that (total size tbd) to ops[tracing] dependency group

[dimaqq]

No idea why RTD build fails...

[dimaqq]

probably a bug in main, not a part of this PR

[dimaqq]

@dwilding wdyt?

[dwilding]

I guess something (tooling/automation?) removed the trailing space. I need to do a separate PR for HACKING.md to fix something else, so I'll change this. Thanks for pointing it out.

[dwilding]

PR to change this: #1539

[dimaqq]

squashed and rebased: #1539 got merged; #1538 a no-go.