Skip to content

Add stability level info on generated metrics' documentation#13756

Merged
mx-psi merged 5 commits into
open-telemetry:mainfrom
ChrsMark:expose_stability_lvl
Sep 10, 2025
Merged

Add stability level info on generated metrics' documentation#13756
mx-psi merged 5 commits into
open-telemetry:mainfrom
ChrsMark:expose_stability_lvl

Conversation

@ChrsMark
Copy link
Copy Markdown
Member

@ChrsMark ChrsMark commented Sep 3, 2025

Description

This PR exposes the stability level of metrics to their generated documentation. This allows us for defining different stability levels for metrics that a components emits. In the future once a component is stable it should be able to introduce new metrics with lower stability levels for experimental/development reasons.

Related to #13297 and #11878. One prior attempt was #5487.

My proposal here is:

  1. expose the stability in the docs conditionally, (if it exists add it)
  2. (in follow-up PR) If no stability is defined add development by default
  3. (in follow-up PR) Update the Collector contrib components using the above
  4. (in follow-up PR) Consider making the stability a required attribute in the metadata-schema

Link to tracking issue

Fixes #13748

Testing

Tuned

Documentation

Sample generated documentation:

Unit Metric Type Value Type Monotonic Stability
By Sum Int true stable

@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.43%. Comparing base (66f2c45) to head (9a56ddc).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #13756   +/-   ##
=======================================
  Coverage   91.43%   91.43%           
=======================================
  Files         640      640           
  Lines       42665    42665           
=======================================
  Hits        39009    39009           
  Misses       2836     2836           
  Partials      820      820           

☔ View full report in Codecov by Sentry.
📢 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.

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark force-pushed the expose_stability_lvl branch from 6b47a10 to 4367f73 Compare September 3, 2025 09:45
songy23 pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Sep 29, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
songy23 pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Sep 29, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Sep 30, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
edmocosta pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 1, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
dmitryax pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 1, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
andrzej-stencel pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 2, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 3, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
mx-psi pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
atoulme pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
songy23 pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
songy23 pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
#35325
-
#42809

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
graphaelli pushed a commit to graphaelli/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
…etry#42953)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
open-telemetry#35325
-
open-telemetry#42809

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
graphaelli pushed a commit to graphaelli/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
…y#42984)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
open-telemetry#35325
-
open-telemetry#42809

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
graphaelli pushed a commit to graphaelli/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
…#42973)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
open-telemetry#35325
-
open-telemetry#42809

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
graphaelli pushed a commit to graphaelli/opentelemetry-collector-contrib that referenced this pull request Oct 6, 2025
…#42946)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

open-telemetry/opentelemetry-collector#13756
added support for exposing metrics' stability level in the generated
documentation. This PR makes use of this functionality.

We start by setting the stability of all metrics to `development`. More
info about levels can be found at
https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels.

Related to:
- open-telemetry/opentelemetry-collector#11878
- open-telemetry/opentelemetry-collector#13297
-
open-telemetry#35325
-
open-telemetry#42809

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes ~

<!--Describe what testing was performed and which tests were added.-->
#### Testing
~

<!--Describe the documentation added.-->
#### Documentation
Updated

<!--Please delete paragraphs that you did not use before submitting.-->

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@dmitryax
Copy link
Copy Markdown
Member

@ChrsMark why did we chose to make the stability a group with level option instead of flat stability: development

My concern is that it's too verbose and I see that the weaver v2 schema has it flat.

@ChrsMark
Copy link
Copy Markdown
Member Author

@ChrsMark why did we chose to make the stability a group with level option instead of flat stability: development

My concern is that it's too verbose and I see that the weaver v2 schema has it flat.

The current PR didn't add the Stability struct but only made use of it in the templates so as the information is exposed to the docs. This was originally added at #11160.

@dmitryax
Copy link
Copy Markdown
Member

@ChrsMark I see. It was added a year ago... Thanks for clarifying

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[mdatagen] Expose signal stability in generated docs

7 participants