[chore] Add implementation details to Component Configuration Management RFC by jkoronaAtCisco · Pull Request #14486 · open-telemetry/opentelemetry-collector

jkoronaAtCisco · 2026-01-27T16:47:50Z

Description

Added implementation details and examples to RFC document

Changes were announced on #otel-collector-dev slack channel.

Link to tracking issue

Extends #14433

…nagement RFC

codecov · 2026-01-27T16:57:49Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.27%. Comparing base (9a8be05) to head (9afeca0).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #14486   +/-   ##
=======================================
  Coverage   91.27%   91.27%           
=======================================
  Files         709      709           
  Lines       46224    46224           
=======================================
  Hits        42192    42192           
  Misses       2817     2817           
  Partials     1215     1215

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Added descriptions for configuration schema properties and clarified generated code for custom fields.

Change the handling of referenced schemas in JSON Schema.

github-actions · 2026-02-28T03:47:18Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

dmitryax · 2026-03-04T01:59:50Z

@open-telemetry/collector-approvers PTAL. I guess we need more approvals before merging RFC amendments

mx-psi · 2026-03-04T11:47:22Z

Can you add to the PR description how you have fulfilled the requirements regarding announcing this RFC/RFC Amendment?

…guration schema roadmap

iblancasa · 2026-03-17T12:58:43Z

+  in a single JSON Schema file.
+- Each referenced schema will be embedded inline.
+- The `$id` field will be set to the component's import path for easy identification.
+- The custom types will be represented as `any` type in JSON Schema.


How about having a way to provide schemas for custom types?

You can still do it. Let's say that you wan to use external type github.com/foo.bar in your config. Then you can do that in your metadata.yaml config:

config: type: object properties: bar: go: type: github.com/foo.bar type: object properties: x: type: integer y: type: integer

That would generate json schema like:

{ "type": "object", "properties": { "bar": { "type": "object", "properties": { "x": { "type": "integer" }, "y": { "type": "integer" } } } } }

But generated go struct would be:

import "github.com/foo.bar" struct Config { bar: foo.Bar `mapstructure:"bar"` }

iblancasa · 2026-03-17T12:59:02Z

+
+**Objective**: Use OCB to bind all components schemas to single schema that describes entire collector config file
+
+**Success Criteria:**


A global $id is needed too.

I don't quite understand this requirement. Can you elaborate?

Yes. Each component has a $id field.
For the global schema, we need a "global" $id property too. That is needed to differentiate between 2 schema files.

For each component json schema we're going to create $id using following pattern:

<namespace>/<path>/<component_name>

for example: go.opentelemetry.io/collector/cmd/mdatagen/internal/samplescraper

For global id we can use just namespace, e.g. go.opentelemetry.io/collector. What do you think?

iblancasa · 2026-03-17T14:45:12Z

+}
+```
+
+#### Generated JSON Schema details


Some components have an alias now because their old names are deprecated. I think we should support validating with the aliases for the time they are there. So, they need to be added to the schemas.

I'm not familiar with this problem. Can you provide some examples?

You can find the full context here open-telemetry/opentelemetry-collector-contrib#45339

iblancasa · 2026-03-17T14:53:53Z

+}
+```
+
+#### Generated JSON Schema details


We also need to make duration/custom-type validation portable across validators

Mdatagen would add pattern validator automatically to those fields.

github-actions · 2026-04-23T04:14:44Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

github-actions · 2026-05-25T04:44:07Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

mx-psi · 2026-05-27T09:41:48Z

This is entering final comment period and will be merged on or after June 2nd if it fulfills all criteria for merging.

@jkoronaAtCisco
So that we can merge this, please ensure that:

All conversations are resolved
You add to the PR description on what Collector SIG meetings this was discussed and when was this shared on #otel-collector-dev

mx-psi · 2026-05-27T09:42:25Z

We also need to make CI pass to be able to merge this

Add implementation details and examples to Component Configuration Ma…

3c778b2

…nagement RFC

jkoronaAtCisco requested review from a team, bogdandrutu, codeboten, dmitryax and mx-psi as code owners January 27, 2026 16:47

Add unknown words to cspell.json

888369e

mx-psi requested review from atoulme and evan-bradley January 27, 2026 17:33

jkoronaAtCisco commented Jan 28, 2026

View reviewed changes

Comment thread docs/rfcs/component-configuration-schema-roadmap.md Outdated

dmitryax reviewed Feb 6, 2026

View reviewed changes

Comment thread docs/rfcs/component-configuration-schema-roadmap.md Outdated

Comment thread docs/rfcs/component-configuration-schema-roadmap.md

Comment thread docs/rfcs/component-configuration-schema-roadmap.md Outdated

Comment thread docs/rfcs/component-configuration-schema-roadmap.md Outdated

jkoronaAtCisco added 4 commits February 11, 2026 09:54

Enhance component configuration schema documentation

36a114e

Added descriptions for configuration schema properties and clarified generated code for custom fields.

Embed referenced schemas inline in JSON Schema

8c683f9

Change the handling of referenced schemas in JSON Schema.

Merge branch 'main' into extend_schemas_rfc

93ba38c

Merge branch 'main' into extend_schemas_rfc

f00d0d3

dmitryax approved these changes Feb 12, 2026

View reviewed changes

Merge branch 'main' into extend_schemas_rfc

34afaf5

github-actions Bot added the Stale label Feb 28, 2026

dmitryax removed the Stale label Mar 4, 2026

jkoronaAtCisco added 3 commits March 5, 2026 11:54

Merge branch 'main' into extend_schemas_rfc

9bbdeac

Merge branch 'main' into extend_schemas_rfc

c813fea

[cmd/mdatagen] Fix indentation and improve clarity in component confi…

d1da44d

…guration schema roadmap

This comment was marked as outdated.

Sign in to view

iblancasa reviewed Mar 17, 2026

View reviewed changes

mx-psi requested a review from iblancasa April 6, 2026 12:13

iblancasa approved these changes Apr 6, 2026

View reviewed changes

Merge branch 'main' into extend_schemas_rfc

46befc2

github-actions Bot added Stale and removed Stale labels Apr 23, 2026

mx-psi added the rfc:approvals-needed This RFC needs approvals from collector-approvers label May 8, 2026

github-actions Bot added the Stale label May 25, 2026

mx-psi approved these changes May 27, 2026

View reviewed changes

Merge branch 'main' into extend_schemas_rfc

b98d836

mx-psi added rfc:final-comment-period This RFC is in the final comment period phase and removed Stale rfc:approvals-needed This RFC needs approvals from collector-approvers labels May 27, 2026

jkoronaAtCisco added 2 commits June 8, 2026 17:21

Merge branch 'main' into extend_schemas_rfc

1d107e6

fix markdown lint

9afeca0

jkoronaAtCisco force-pushed the extend_schemas_rfc branch from 85d214b to 9afeca0 Compare June 8, 2026 15:58

mx-psi added this pull request to the merge queue Jun 9, 2026

Merged via the queue into open-telemetry:main with commit 8e000d6 Jun 9, 2026
68 checks passed


		Objective: Use OCB to bind all components schemas to single schema that describes entire collector config file

		Success Criteria:

Uh oh!

Conversation

jkoronaAtCisco commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Link to tracking issue

Uh oh!

codecov Bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Feb 28, 2026

Uh oh!

dmitryax commented Mar 4, 2026

Uh oh!

mx-psi commented Mar 4, 2026

Uh oh!

This comment was marked as outdated.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

github-actions Bot commented May 25, 2026

Uh oh!

mx-psi commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mx-psi commented May 27, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jkoronaAtCisco commented Jan 27, 2026 •

edited

Loading

codecov Bot commented Jan 27, 2026 •

edited

Loading

mx-psi commented May 27, 2026 •

edited

Loading