feat: Add development observability stack for testing OpenTelemetry with Jaeger, and Prometheus

[morgan-wowk]

Add development observability stack for testing OpenTelemetry with Jaeger, and Prometheus

TL;DR

Added a complete observability stack to collect and visualize traces and metrics from Tangle.

What changed?

• Added a Docker Compose setup with OpenTelemetry Collector, Jaeger, and Prometheus
• Created configuration files for each component:
  • otel-collector-config.yaml for the OpenTelemetry Collector
  • prometheus.yml for Prometheus
• Added comprehensive documentation in README.md explaining:
  • How to start and stop the stack
  • How to configure Tangle to export telemetry
  • Available UIs and ports
  • Troubleshooting common issues

How to test?

1. Start the observability stack:
2. Configure Tangle to export telemetry:
3. Access the UIs:
   • Jaeger (traces): http://localhost:16686
   • Prometheus (metrics): http://localhost:9090

Why make this change?

This observability stack provides crucial visibility into Tangle's performance and behavior.

[morgan-wowk]

• feat: Add development observability stack for testing OpenTelemetry with Jaeger, and Prometheus #101 👈 (View in Graphite)
• feat: API-Server - Added OTel trace id auto-instrumentation for FastAPI #82 : 1 other dependent PR (#75 )
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

[Volv-G]

Please add a bit more info on the purpose of these tools. It's not obvious that this is mostly for local testing.

[morgan-wowk]

That sounds great. I changed the wording to "Development observability stack" and added the line "intended for local development testing"

[Volv-G]

maybe rename the folder too? Alternatively, if we expect this folder to be filled with production telemetry tools in forked repos, we can somehow explain that.

[morgan-wowk]

Thanks. I have renamed it to be an "example" and put emphasis on the fact that it is "intended as an example or for testing new telemetry data"

[Ark-kun]

Agreed. Folder is a bit too specific for the root dir.
Maybe something like
examples/setup/observability

[morgan-wowk]

I like that

[Volv-G]

I think we can proceed with this. If needed we can remove this later, but for the time being this seems to be a good tool to test new telemetry

[Ark-kun]

Thank you, Morgan!

[morgan-wowk]

Merge activity

• Feb 25, 10:11 PM UTC: @morgan-wowk merged this pull request with Graphite.