Add required --semconv-version to TLDR example
#2518
Merged
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
The "ECS Tooling Usage" guide has a "TLDR example" to get started. It needs to be adjusted by the user to generate templates, but since 009caf4, the user also have to provide a value for the `--semconv-version` required parameter. Unfortunately, nothing is told about this parameter in that file, leading the user with a cryptic: ``` Traceback (most recent call last): File "./ecs/scripts/generator.py", line 144, in <module> main() File "./ecs/scripts/generator.py", line 46, in main raise KeyError("OTel Semantic Conventions version has not been provided as a config option '--semconv-version'") KeyError: "OTel Semantic Conventions version has not been provided as a config option '--semconv-version'" ``` Adjust the example to make bootstraping a custom config easier.
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
mjwolf
approved these changes
Aug 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The "ECS Tooling Usage" guide has a "TLDR example" to get started. It needs to be adjusted by the user to generate templates, but since 009caf4, the user also have to provide a value for the
--semconv-versionrequired parameter. Unfortunately, nothing is told about this parameter in that file, leading the user with a cryptic:Adjust the example to make bootstraping a custom config easier.
Only the first example is adjusted in this PR, as it makes examples more verbose and I assumed the user would find how to quickly fix the issue when they follow the guide bottom-down. On request, I can adjust the PR to fix the other examples for correctness, or adjust the script so that it loads the version from that file if not provided.