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 support for telemetry #2919

Closed
brikis98 opened this issue Jan 29, 2024 · 0 comments · Fixed by #2921
Closed

Add support for telemetry #2919

brikis98 opened this issue Jan 29, 2024 · 0 comments · Fixed by #2921
Assignees
Labels
enhancement New feature or request

Comments

@brikis98
Copy link
Member

brikis98 commented Jan 29, 2024

Many TG users are looking for a way to get telemetry data on what TG is doing under the hood so they can troubleshoot issues, improve performance bottlenecks, etc.

Proposal

  • Update TG to emit telemetry data.
  • Use OpenTelemetry as the format/tooling.
  • This should be an opt-in feature you turn on with some sort of flag / env var.
  • All data should be anonymous: no personal user IDs or anything like that should be included. That said, local file paths will be included.

Data to emit

We will need to do some thinking on what data to emit and when, but here's an initial list:

  • What commands are running and in which folders.
    • Whether each command succeeded or failed.
    • How long each command took.
  • What steps TG did internally (e.g., file system scanning, config parsing, auto-init, hook execution, etc) to process the command.
    • How long each step took.
    • Whether each step succeeded or failed.
  • What TF modules and providers, and at which versions, were used.
    • How long it took to download them.
    • How big they are on disk.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants