Documentation for CLI flags and JSON configuration options #4309
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
frzifus
reviewed
Aug 26, 2025
|
|
||
| ## Flag Table by Categories | ||
|
|
||
| ### Core Configuration |
There was a problem hiding this comment.
Is this somehow generated? If yes, can we include the script or provide a makefile rule for it?
There was a problem hiding this comment.
Not exactly generated via a script. I had written the original file in MD and had it converted to HTML using LLMs to stay consistent with the formatting in API docs.
iblancasa
reviewed
Aug 27, 2025
| @@ -0,0 +1,141 @@ | |||
| # CLI Flags Reference | |||
There was a problem hiding this comment.
Can't this be added in markdown?
There was a problem hiding this comment.
Sure. I can update it to be markdown. I wanted to keep it consistent with the existing API document formatting so I converted it into HTML format.
|
Please also add env vars and default values. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Creates a
configuration.mdfile, which contains all the configuration options for auto-instrumentation. The options can be passed in either as CLI Flags or JSON.Link to tracking Issue(s): #3565