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

Telemetry Exporter #1318

Closed
2 tasks done
Tracked by #793
mpstefan opened this issue Dec 1, 2023 · 2 comments
Closed
2 tasks done
Tracked by #793

Telemetry Exporter #1318

mpstefan opened this issue Dec 1, 2023 · 2 comments
Assignees
Labels
area/telemetry Issues related to collected telemetry data refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks
Milestone

Comments

@mpstefan
Copy link
Collaborator

mpstefan commented Dec 1, 2023

As a maintainer of NGF
I want an exporter library to enable me to send data to a centralized telemetry collector
So that I can aggregate and visualize telemetry data to make better product decisions based on how users are using the products.

Acceptance

  • Data sent to the exporter library is able to send data to our centralized collector.
  • A set of common data points for NGF/NIC telemetry is identified within the exporter library.
  • The README is updated to include how to use the Telemetry Exporter as a developer.
  • The library interfaces are reviewed and approved by both NGF and NIC teams and @f5yacobucci

Dev Notes

  • Once the interface is made, we should share that interface with the team for feedback.
  • We need to add an automated test to validate that the format of what is sent by the exporter matches the Open Telemetry format.

Tasks

@mpstefan mpstefan added the area/telemetry Issues related to collected telemetry data label Dec 1, 2023
@mpstefan mpstefan added this to the v1.2.0 milestone Dec 1, 2023
@mpstefan mpstefan changed the title Send Telemetry to Collector Telemetry Exporter Dec 13, 2023
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks and removed refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks labels Dec 13, 2023
@mpstefan mpstefan added the blocked Blocked by other issue label Jan 4, 2024
@mpstefan
Copy link
Collaborator Author

mpstefan commented Jan 4, 2024

Blocked by #1374

@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks labels Jan 4, 2024
@pleshakov pleshakov self-assigned this Jan 24, 2024
@pleshakov pleshakov moved this from 🆕 New to 🏗 In Progress in NGINX Gateway Fabric Jan 24, 2024
pleshakov added a commit to nginxinc/telemetry-exporter that referenced this issue Jan 26, 2024
Problem:
As a maintainer of NGF and NIC
I want an exporter library to enable me to send data to a centralized
telemetry collector,
So that I can aggregate and visualize telemetry data to make better
product decisions based on how users are using the products.

Solution:

Note: this is a PoC of the design.

- Add Exporter type Exporter the data to an OpenTelemetry endpoint.
- The passed exported data must implement Exportable interface.
- Add generation tools to generate the implementation of
the Exportable interface for the data and generate the scheme.
- Define common telemetry data points to be used across projects.
- Add a go code example along with the instructions for an e2e demo.

Fixes nginxinc/nginx-gateway-fabric#1318
@pleshakov pleshakov removed the blocked Blocked by other issue label Mar 6, 2024
@pleshakov
Copy link
Contributor

The last part of it - docs - is being worked here nginxinc/telemetry-exporter#5
Closing this issue

@github-project-automation github-project-automation bot moved this from 🏗 In Progress to ✅ Done in NGINX Gateway Fabric Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/telemetry Issues related to collected telemetry data refined Requirements are refined and the issue is ready to be implemented. size/large Estimated to be completed within two weeks
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants