Skip to content

Prototype sending product telemetry #1246

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
wants to merge 2 commits into from

Conversation

pleshakov
Copy link
Contributor

Proposed changes

Problem:

  • Understand how to send product telemetry using OpenTelemerty
  • Note: OpenTelemetry is required by the backend (F5 Data Fabric)

Solution:

  • Use OpenTelemetry traces to send some telemetry data

Note: an offline demo/presentation will follow this prototype

Demo instructions:

  • Install OTel collector using /otel-collector/README.md instructions
  • Install NGF, 1 replica.
  • After NGF starts, it will send telemetry data once.
  • To show that NGF sends the data:
    • In NGF log, look for generated traces
    • In the OTel collector log, look for received traces.
      Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
      following format:

Note: linting errors are ok

Closes #1213

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Problem:
- Understand how to send product telemetry using OpenTelemerty
- Note: OpenTelemetry is required by the backend (F5 Data Fabric)

Solution:
- Use OpenTelemetry traces to send some telemetry data

Note: an offline demo/presentation will follow this prototype

Demo instructions:
- Install OTel collector using /otel-collector/README.md instructions
- Install NGF, 1 replica.
- After NGF starts, it will send telemetry data once.
- To show that NGF sends the data:
  - In NGF log, look for generated traces
  - In the OTel collector log, look for received traces.
@github-actions github-actions bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request labels Nov 14, 2023
@sjberman
Copy link
Collaborator

From a high level I think the approach makes sense. I agree with your offline comment about the idea of using traces to send a bunch of metadata is a little weird, but it's an easy way to ensure the format and protocol is standardized (without creating something completely new). It allows us to use existing libraries.

@pleshakov pleshakov closed this Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[SPIKE] Data Fabric Discovery
3 participants