Skip to content

added config template that OBI accepts#974

Closed
itsCheithanya wants to merge 1 commit into
open-telemetry:mainfrom
itsCheithanya:docs
Closed

added config template that OBI accepts#974
itsCheithanya wants to merge 1 commit into
open-telemetry:mainfrom
itsCheithanya:docs

Conversation

@itsCheithanya

Copy link
Copy Markdown
Contributor

Checklist

Fixes #973

@itsCheithanya itsCheithanya requested a review from a team as a code owner December 8, 2025 07:49
@linux-foundation-easycla

linux-foundation-easycla Bot commented Dec 8, 2025

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: itsCheithanya / name: Cheithanya (7e840fb)

@NimrodAvni78

Copy link
Copy Markdown
Contributor

@itsCheithanya was this written by you or generated automatically?
if not is it something we can generate from a go struct?
because we will need to remember to update this or we will drift from the actual config structure

@itsCheithanya

Copy link
Copy Markdown
Contributor Author

@NimrodAvni78 I created this by referencing all the structs ,yes we should keep that in mind if any structs change we need to update here maybe give a NOTE in the structs will be a good approach?

@MrAlias MrAlias left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather we use something like jsonschema or cue to validate our configuration syntax instead of adding the noise of a one-off yaml file.

@itsCheithanya

Copy link
Copy Markdown
Contributor Author

@MrAlias Thanks for the feedback! I understand the concern about maintaining a one-off YAML file. I can refactor this to use either approach . Which would be better? also should I keep this template as documentation alongside the schema,or replace it entirely?

@MrAlias

MrAlias commented Dec 9, 2025

Copy link
Copy Markdown
Contributor

@itsCheithanya I would suggest jsonschema as that is used in other parts of OTel including the declarative config.

I would focus on just using jsonschema, no need for this yaml file.

@NimrodAvni78

Copy link
Copy Markdown
Contributor

ive created a PR that generates json schema automatically from the config struct
#1017

@MrAlias

MrAlias commented Dec 17, 2025

Copy link
Copy Markdown
Contributor

Closing in favor of #1017

@MrAlias MrAlias closed this Dec 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Need comprehensive documentation for OBI config file fields

3 participants