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

Add observability stack with jaeger and opentelemetry-collector #35

Merged
merged 14 commits into from
May 28, 2024

Conversation

NickLarsenNZ
Copy link
Member

@NickLarsenNZ NickLarsenNZ commented Apr 3, 2024

Make a Stack to aid in development and validation of webhook telemetry (and beyond). This will evolve into a full demo when operators/webhooks and/or products have been instrumented.

Stack

  • Jaeger Deployment
    • Actually also added Loki (logs) and Tempo (a second trace sink to show that multiple can be used), and the Grafana dashboard app.
  • OpenTelemetry Operator Deployment
    • OpenTelemetry Collector to route logs and traces
  • Deploy an instrumented operator with a webhook
    • The commons operator is deployed by this stack, but is not yet instrumented.

Demo

Important

A demo is not included for now, because there is no operator/webhook that has been instrumented yet. This can be done in a future PR.

@soenkeliebau
Copy link
Member

Just on very high level comment, because I was working on integrating openobserve into the demos somewhere else, which would in theory also support OpenTelemetry I believe.

Is it maybe worth taking a brief look at what Jaeger gives us more than OpenObserve? If OpenObserve suffices, we'd have one tool to take care of logs, metrics and traces all in one fell swoop for the demos ..

@NickLarsenNZ
Copy link
Member Author

Just on very high level comment, because I was working on integrating openobserve into the demos somewhere else, which would in theory also support OpenTelemetry I believe.

Is it maybe worth taking a brief look at what Jaeger gives us more than OpenObserve? If OpenObserve suffices, we'd have one tool to take care of logs, metrics and traces all in one fell swoop for the demos ..

I've gone with the Grafana stack as it has been IMO the best all-round observability stack.
Jaeger was added as an additional tool to show how the opentelemetry-collector can take one stream of logs/metrics/traces and send them to multiple things (out of scope, but the benefit is allowing end users to easily migrate to other tools without a hard cut which is often required when observability SaaS vendors' SDKs are used in code. In Rust, the tracing crate helps there too).

At this point in time, only the stack exists, so it wasn't described, but my intention is that a demo would explain all of this.

@NickLarsenNZ
Copy link
Member Author

NickLarsenNZ commented May 14, 2024

This is basically done, but I was waiting on a couple of changes to go into stackable-webhooks/stackable-telemetry (see task list in stackabletech/issues#531) to ensure a problem wasn't being created by the opentelemetry-collector.

I have some local changes/clean up to finalize this (I aim to do that after my holiday).

Note

It is only a stack at this point, and not an entire demo (that is best left to when we have instrumented real webhooks/operators and/or enabled instrumentation on products).

@NickLarsenNZ NickLarsenNZ marked this pull request as ready for review May 23, 2024 16:11
Copy link
Member

@sbernauer sbernauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Please expose using NodePorts
  • Deploy collector Pod (and not only sidecars)
  • URLs in stacks.yaml need updating (just before merging)

@NickLarsenNZ
Copy link
Member Author

NickLarsenNZ commented May 27, 2024

  • Please expose using NodePorts

I have done so for Grafana (b690482), but am unable to do the same for the OpenTelemetry Collector (see open-telemetry/opentelemetry-operator#902).

  • Deploy collector Pod (and not only sidecars)

Done in d9336f2

  • URLs in stacks.yaml need updating (just before merging)

Done in 8bea6ae

@NickLarsenNZ NickLarsenNZ requested a review from sbernauer May 27, 2024 09:41
Copy link
Member

@sbernauer sbernauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Can you please add a comment everywhere you were not able to use a NodePort including the link to the issue if possible?

Copy link
Member

@sbernauer sbernauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@NickLarsenNZ
Copy link
Member Author

LGTM. Can you please add a comment everywhere you were not able to use a NodePort including the link to the issue if possible?

Done in d8c58d0

@NickLarsenNZ NickLarsenNZ requested a review from sbernauer May 28, 2024 09:21
@NickLarsenNZ NickLarsenNZ added this pull request to the merge queue May 28, 2024
Merged via the queue into main with commit 61601f8 May 28, 2024
1 check passed
@NickLarsenNZ NickLarsenNZ deleted the observability-stack branch May 28, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants