config: generate model code from json schema by codeboten · Pull Request #4879 · open-telemetry/opentelemetry-python

codeboten · 2026-01-15T18:01:42Z

Description

Proposing that the first step towards implementing OpenTelemetry Configuration is to produce the model code from the json schema. I did a quick search for tools available to do this and came across datamodel-codegen which seems to do what i expected.

Will open following pull requests (in draft) to use this model code, i just want to keep these as clearly separated as possible to make reviewing them easier.

Related to #3631

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

This PR is just code generation, no tests have been added just yet

Yes. - Link to PR:
No.

Checklist:

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

Proposing that the first step towards implementing OpenTelemetry Configuration is to produce the model code from the json schema. I did a quick search for tools available to do this and came across datamodel-codegen which seems to do what i expected. Will open following pull requests (in draft) to use this model code, i just want to keep these as clearly separated as possible to make reviewing them easier. Signed-off-by: alex boten <223565+codeboten@users.noreply.github.com>

xrmx · 2026-01-16T09:01:36Z

pyproject.toml

+formatters = ["ruff-format", "ruff-check"]
+use-standard-collections = true
+use-schema-description = true
+use-title-as-name = true


Suggested change

use-title-as-name = true

use-title-as-name = true

use-union-operator = true

Does this make a difference? It should be the default but the pipe is not used for optionals

I tried this but Python 3.9 doesn't support | and with use-union-operator set we'd generate something like

AlwaysOffSampler: TypeAlias = dict[str, Any] | None

with it disabled, we generate which works in 3.9

AlwaysOffSampler: TypeAlias = Optional[dict[str, Any]]

I also updated the target-python-version to 3.10 as datamodel-codegen's validation wants 3.10+.

We have from __future__ import annotations for being able to use the | on older pythons.

Thanks @xrmx - I've set use-union-operator to true in aef08e0

… into codeboten/generate-config-model-from-schema

MikeGoldsmith · 2026-02-04T14:53:06Z

I'm helping pick this up from @codeboten - I've opened the following PR to their branch that fixes the codegeneration tooling and also sets the use-union-operator option @xrmx suggested:

fix code-generation command and regenerate models codeboten/opentelemetry-python#13

…el-from-schema fix code-generation command and regenerate models

…el-from-schema.2 Fix lint errors and update uv.lock file

Signed-off-by: alex boten <223565+codeboten@users.noreply.github.com>

MikeGoldsmith · 2026-02-05T20:01:06Z

I've been reviewing the CI failures and I don't think they are related to the changes in this PR.

Misc 0 - typecheck

lots of errors even when running against main
no errors from files we added, eg sdk/src/opentelemetry/sdk/_configuration/models.py

opentelemetry-sdk pypy-3.9 Ubuntu

Error: MetricsTimeoutError: test timeout
Found this tracking issue
- Debugging - InMemoryMetricReader: MetricsTimeoutError('Timed out while flushing metric readers') #4196

contrib_0 / exporter-richconsole

separate contrib package

If you think any of the changes are related, let me know. Thanks.

cc @open-telemetry/python-approvers @open-telemetry/python-maintainers

… into codeboten/generate-config-model-from-schema

datamodel-codegen section was inserted between [tool.pyright] and its include/exclude config, causing pyright to check entire repo (599 files) instead of just included paths. Moved datamodel-codegen section after pyright config.

MikeGoldsmith · 2026-02-11T11:39:49Z

I found the problem with the CI type checks, I had the new tool definition under the wrong section. It's fixed now.

cc @open-telemetry/python-approvers

MikeGoldsmith · 2026-02-11T11:40:51Z

PS the check-links error seems to be transient. The most recent failure is referencing (#3038) which is a valid link. I don't have the ability to re-run, could someone do that for me?

… into codeboten/generate-config-model-from-schema

Pyright doesn't recognize that pipe operators are valid with from __future__ import annotations on Python 3.9.

Testing if dev dependency updates in uv.lock are causing contrib test failures. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

MikeGoldsmith · 2026-02-13T11:17:24Z

Hmm, the contrib CI failures are related to the uv.lock updates. Looking into this now.

MikeGoldsmith · 2026-02-13T11:31:59Z

Okay, fixed - I think maybe something for weird after merging main into this branch. Reverting and regenerating the uv.lock seems to have fixed it 🎉

… into codeboten/generate-config-model-from-schema

…com:codeboten/opentelemetry-python into codeboten/generate-config-model-from-schema

pmcollins · 2026-02-17T15:12:24Z

Might be nice to add a test that just does a from opentelemetry.sdk._configuration import models to make sure the generated code imports successfully by the python versions configured in CI.

MikeGoldsmith · 2026-02-17T17:08:28Z

Thanks @pmcollins - I've added the test, and it shows that the use-union-operator datamodel gen option doesn't work for python 3.9. We may need to disable that option while we still support that python version.

cc @xrmx what do you think?

… into codeboten/generate-config-model-from-schema

MikeGoldsmith · 2026-02-19T12:12:32Z

I've updated to set use-union-operator to false now. The post-processing script still updates the TypeAlias as before. This should now be compatible with python 3.9 and I've left a comment to say we can re-enable it once we drop support for Python 3.9.

xrmx reviewed Jan 16, 2026

View reviewed changes

MikeGoldsmith added 2 commits February 4, 2026 12:35

update tox command’s deps and allowlist

72c3729

add use-union-operator to datamodel-codegen and regenerate models file

a2dfa41

MikeGoldsmith mentioned this pull request Feb 4, 2026

fix code-generation command and regenerate models codeboten/opentelemetry-python#13

Merged

MikeGoldsmith added 2 commits February 4, 2026 12:51

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

659ab65

… into codeboten/generate-config-model-from-schema

add changelog

dd6a2cd

MikeGoldsmith and others added 2 commits February 4, 2026 15:06

disable union-operator and set target python to 3.10

99e9570

Merge pull request #13 from honeycombio/codeboten/generate-config-mod…

43f2c09

…el-from-schema fix code-generation command and regenerate models

codeboten marked this pull request as ready for review February 4, 2026 15:42

codeboten requested a review from a team as a code owner February 4, 2026 15:42

MikeGoldsmith mentioned this pull request Feb 4, 2026

Add configuration prototype #3631

Open

MikeGoldsmith and others added 5 commits February 5, 2026 13:32

ignore generated file for linting

1a3bde8

fix TypeAlias import for python 3.9 in generated models file

6936e54

update uv.lock with new dev dependencies

7949792

Merge pull request #14 from honeycombio/codeboten/generate-config-mod…

9f5f21e

…el-from-schema.2 Fix lint errors and update uv.lock file

run precommit

81ac395

Signed-off-by: alex boten <223565+codeboten@users.noreply.github.com>

This was referenced Feb 6, 2026

config: load and validate generated config models #4898

Draft

Proposal: SDK Autoconfiguration #4856

Open

MikeGoldsmith added 2 commits February 11, 2026 09:57

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

45bc753

… into codeboten/generate-config-model-from-schema

Fix pyright config structure in pyproject.toml

801a425

datamodel-codegen section was inserted between [tool.pyright] and its include/exclude config, causing pyright to check entire repo (599 files) instead of just included paths. Moved datamodel-codegen section after pyright config.

Merge branch 'main' into codeboten/generate-config-model-from-schema

ba73218

xrmx added this to @xrmx's Python PR digest Feb 12, 2026

xrmx moved this to Ready for review in @xrmx's Python PR digest Feb 12, 2026

MikeGoldsmith added 2 commits February 12, 2026 17:01

set use-union-operator to true

aef08e0

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

3ee990e

… into codeboten/generate-config-model-from-schema

MikeGoldsmith and others added 2 commits February 13, 2026 10:11

Exclude generated models.py from pyright checks

0d60e15

Pyright doesn't recognize that pipe operators are valid with from __future__ import annotations on Python 3.9.

Revert uv.lock to test contrib failures

4db86b3

Testing if dev dependency updates in uv.lock are causing contrib test failures. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Update uv.lock for datamodel-code-generator dependencies

9232c0f

MikeGoldsmith added 3 commits February 16, 2026 16:33

Merge branch 'main' into codeboten/generate-config-model-from-schema

3aef211

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

52d978f

… into codeboten/generate-config-model-from-schema

Merge branch 'codeboten/generate-config-model-from-schema' of github.…

e6ba0dc

…com:codeboten/opentelemetry-python into codeboten/generate-config-model-from-schema

add test to verify can import models across python versions

5f95777

MikeGoldsmith added 4 commits February 17, 2026 17:14

add ruff ignore for models file and inline imports

9e77e17

add pylint excludes to test

acc9755

Merge branch 'main' of github.com:open-telemetry/opentelemetry-python…

11336bd

… into codeboten/generate-config-model-from-schema

set use-union-operator to false & regenerate models

c027c7c

pmcollins approved these changes Feb 20, 2026

View reviewed changes

	use-title-as-name = true
	use-title-as-name = true
	use-union-operator = true

Conversation

codeboten commented Jan 15, 2026

Description

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

xrmx Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

xrmx Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

MikeGoldsmith commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MikeGoldsmith commented Feb 5, 2026

Uh oh!

MikeGoldsmith commented Feb 11, 2026

Uh oh!

MikeGoldsmith commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MikeGoldsmith commented Feb 13, 2026

Uh oh!

MikeGoldsmith commented Feb 13, 2026

Uh oh!

pmcollins commented Feb 17, 2026

Uh oh!

MikeGoldsmith commented Feb 17, 2026

Uh oh!

MikeGoldsmith commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

MikeGoldsmith commented Feb 4, 2026 •

edited

Loading

MikeGoldsmith commented Feb 11, 2026 •

edited

Loading