Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Not Intended to Merge] Initial POC implementation of OpenTelemetry #1067

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

b-yogesh
Copy link
Contributor

@b-yogesh b-yogesh commented Sep 10, 2024

This is a test PR that implements the initial POC implementation of OpenTelemetry to get observability insights into the xcube server.

Opentelemetry (OT) is used to extract the traces. In production, it is recommended to use a Collector (a concept from OT) but for this POC, we can directly send the data to the backend (Jaeger in this case).
Jaeger is a docker container (for development purposes) that collects these traces and displays them in an UI

To run Jaeger, just run this

docker run --rm --name jaeger \                             
 -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 4317:4317 \
  -p 4318:4318 \
  -p 14250:14250 \
  -p 14268:14268 \
  -p 14269:14269 \
  -p 9411:9411 \
  jaegertracing/all-in-one:1.60

Reference links:
OpenTelemetry
Jaeger
Youtube-OT Basics

Checklist:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/source/*
  • Changes documented in CHANGES.md
  • GitHub CI passes
  • AppVeyor CI passes
  • Test coverage remains or increases (target 100%)

@b-yogesh b-yogesh changed the title Initial POC implementation of OpenTelemetry [Not Intended to Merge] Initial POC implementation of OpenTelemetry Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants