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

Document all flags associated with manager #3565

Open
atoulme opened this issue Dec 21, 2024 · 1 comment
Open

Document all flags associated with manager #3565

atoulme opened this issue Dec 21, 2024 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@atoulme
Copy link

atoulme commented Dec 21, 2024

Component(s)

auto-instrumentation

Is your feature request related to a problem? Please describe.

The manager executable seems to accept a number of ways of configuration:

  • A JSON file
  • CLI flags
  • Env vars

There is no uniformity between those arguments - some env vars for example like ENABLE_WEBHOOKS have no equivalent CLI flag.

Describe the solution you'd like

  • Create a documentation for the existing
  • Create tests to uniformly enforce how the config is set so each key is sure to have an equivalent in JSON/CLI Flag/Env var
  • Fix inconsistencies

Describe alternatives you've considered

No response

Additional context

No response

@atoulme atoulme added enhancement New feature or request needs triage labels Dec 21, 2024
@jaronoff97 jaronoff97 added good first issue Good for newcomers and removed needs triage labels Dec 23, 2024
@jaronoff97
Copy link
Contributor

Agreed, this is in a few places currently with most of documentation being the code itself. This would be a good one to take.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants