Skip to content

Support Tracing via OpenTelemetry #622

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

Closed
mpstefan opened this issue May 3, 2023 · 4 comments
Closed

Support Tracing via OpenTelemetry #622

mpstefan opened this issue May 3, 2023 · 4 comments
Labels
epic Represents an epic. Contains sub-issues refined Requirements are refined and the issue is ready to be implemented.
Milestone

Comments

@mpstefan
Copy link
Member

mpstefan commented May 3, 2023

As a user of NGF
I want NGF to have the ability to generate and send traces
So that I can easily get tracing for all of my traffic to help debug my environment.

Background

We evaluated adding tracing capabilities before 1.0, but the nginx 1.0 otel module had not yet been released yet. Now that is has, and that @ciarams87 has completed a POC, it is time to add the capability.

Acceptance Criteria

  • When enabled, the NGINX otel module is utilized to generate traces.
  • Generated traces can be exported to a configurable endpoint.
  • All fields from otel_exporter directive are configurable by the user.
  • Documentation is created to explain this feature.

For Discussion

  • Does the above acceptance criteria make sense?
### Tasks
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1660
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1662
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1166
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1800
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1826
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1827
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1828
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1911
- [ ] https://github.com/nginxinc/nginx-gateway-fabric/issues/1912
@mpstefan mpstefan changed the title Export Traces Tracing May 3, 2023
@mpstefan mpstefan added the epic Represents an epic. Contains sub-issues label May 3, 2023
@mpstefan mpstefan added the enhancement New feature or request label Jun 9, 2023
@mpstefan
Copy link
Member Author

Look at using NGINX otel: https://github.com/nginxinc/nginx-otel

@brianehlert
Copy link

We should use the nginx developed module. And expose its settings.
It only has tracing today, but plans to add metrics and logs.

@mpstefan mpstefan added this to the v1.1.0 milestone Sep 7, 2023
@ciarams87
Copy link
Contributor

@mpstefan mpstefan added the refined Requirements are refined and the issue is ready to be implemented. label Oct 23, 2023
@ja20222 ja20222 removed this from the v1.1.0 milestone Nov 20, 2023
@mpstefan mpstefan added this to the v1.3.0 milestone Jan 26, 2024
@mpstefan mpstefan removed the enhancement New feature or request label Mar 12, 2024
@sjberman sjberman changed the title Tracing Support Tracing via OpenTelemetry Mar 29, 2024
@sjberman
Copy link
Collaborator

Branch containing original implementation, can be used for reference: https://github.com/nginxinc/nginx-gateway-fabric/tree/feat/data-plane-crd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic Represents an epic. Contains sub-issues refined Requirements are refined and the issue is ready to be implemented.
Projects
None yet
Development

No branches or pull requests

5 participants