Implement OpenTelemetry tracing

[ryanmelt]

closes #171

To test add to compose.yaml:

openc3-jaeger:
  image: "${OPENC3_REGISTRY}/jaegertracing/all-in-one:1.38"
  command: ["--memory.max-traces=1000000"]
  ports:
    - "127.0.0.1:16686:16686"
  restart: on-failure
  environment:
    - "COLLECTOR_OTLP_ENABLED=true"
  env_file:
    - ".env"

Add to .env:

OTEL_EXPORTER_OTLP_ENDPOINT=http://openc3-jaeger:4318
OPENC3_OTEL=CMD__TLM__API

[codecov]

Codecov Report

Base: 74.01% // Head: 73.98% // Decreases project coverage by -0.03% ⚠️

Coverage data is based on head (3180376) compared to base (a856125).
Patch coverage: 58.95% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #194      +/-   ##
==========================================
- Coverage   74.01%   73.98%   -0.04%     
==========================================
  Files         413      414       +1     
  Lines       25564    25619      +55     
  Branches      560      560              
==========================================
+ Hits        18920    18953      +33     
- Misses       6558     6581      +23     
+ Partials       86       85       -1     

Flag	Coverage Δ
frontend	75.84% <ø> (+0.16%)	⬆️
ruby-api	43.90% <3.70%> (-0.02%)	⬇️
ruby-backend	78.41% <69.17%> (-0.10%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...enc3-cmd-tlm-api/app/controllers/api_controller.rb	9.30% <3.70%> (+1.80%)	⬆️
openc3/lib/openc3/utilities/open_telemetry.rb	29.54% <29.54%> (ø)
...lib/openc3/microservices/interface_microservice.rb	84.02% <80.28%> (+0.05%)	⬆️
...nc3/lib/openc3/microservices/decom_microservice.rb	89.39% <100.00%> (+0.33%)	⬆️
openc3/lib/openc3/microservices/microservice.rb	67.79% <100.00%> (+0.55%)	⬆️
openc3/lib/openc3/topics/command_topic.rb	100.00% <100.00%> (ø)
openc3/lib/openc3/topics/telemetry_decom_topic.rb	92.30% <100.00%> (+1.39%)	⬆️
...3/lib/openc3/microservices/reducer_microservice.rb	90.72% <0.00%> (-0.07%)	⬇️
...enc3-tool-calendar/src/tools/Calendar/Calendar.vue	71.03% <0.00%> (+5.51%)	⬆️
openc3/lib/openc3/utilities/metric.rb	96.07% <0.00%> (+5.88%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jmthomas]

I look forward to trying it out!

[jmthomas]

So you inject_context and then use with_context to link together the tracing?

[ryanmelt]

Yep

[jmthomas]

All these use statements are how OpenTelemetry can instrument and interpret various nested calls within Ruby?

[ryanmelt]

The use statements enable built in instrumentors provided by OpenTelemetry. So they automatically inject spans for calls to the associated libraries.