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

Guide for configuring tracing #70

Closed
R-Lawton opened this issue Feb 27, 2024 · 0 comments · Fixed by Kuadrant/kuadrant-operator#568
Closed

Guide for configuring tracing #70

R-Lawton opened this issue Feb 27, 2024 · 0 comments · Fixed by Kuadrant/kuadrant-operator#568
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@R-Lawton
Copy link
Contributor

R-Lawton commented Feb 27, 2024

WHAT:

Add a new docs page/guide that shows how you can enable tracing in istio, authorino and limitador to a central collector, and an example troubleshooting flow.

Depends on changes and information captured in:

Related to Kuadrant/kuadrant-operator#399, but doesn't depend on it.
The guide can be written with the current limitations called out.

Rough layout of the guide:

The work in https://gist.github.com/adam-cattermole/0f5097e3814f2fcf4d9eed85c6d897a3 and Kuadrant/kuadrant-operator#521 can be taken as needed for the guide. There's no need to include the complete setup of the various kuadrant and gateway api CRs though, or the setup of the tracing stack. The focus can be on the trace collector endpoint configuration in the gateway and kuadrant components, and making use of traces.

Caveat:

  • The trace starting point must be outside of envoy/istio/ossm (before it hits the gateway) for tracing support in limitador to take effect.
  • There are future plans to remove this limitation by implementing a feature in Envoy. If/When that lands, it will be picked up by OSSM at some future date, after which we update our documentation and examples accordingly.

Future work (no need to call this out in guide):

  • There is future work to abstract the tracing endpoint configuration to a single configuration point in the Kuadrant CR. There are also discussions about how this could be automated in the context of OpenShift so that if you are using OSSM with OpenShift Distributed Tracing, you get tracing support in Kuadrant components turned out by default (or at the very least, easily enabled), sending traces to the same collector as OSSM.
@R-Lawton R-Lawton changed the title Document tracing pieces Document limitador tracing pieces Feb 27, 2024
@R-Lawton R-Lawton mentioned this issue Feb 27, 2024
5 tasks
@R-Lawton R-Lawton added the documentation Improvements or additions to documentation label Feb 27, 2024
@david-martin david-martin changed the title Document limitador tracing pieces Guide for configuring tracing Apr 11, 2024
@david-martin david-martin self-assigned this Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants