Skip to content

Add stability as a separate column in Markdown tables#278

Merged
lmolkova merged 10 commits intoopen-telemetry:mainfrom
lmolkova:stability_separate_column
Mar 13, 2024
Merged

Add stability as a separate column in Markdown tables#278
lmolkova merged 10 commits intoopen-telemetry:mainfrom
lmolkova:stability_separate_column

Conversation

@lmolkova
Copy link
Copy Markdown
Member

Follow-up on #272

This PR

  • moves stability to a dedicated column for supported md tables (attributes and metrics).
  • [BREAKING] changes cmd line args controlling rendering:
    • badges were opt-in per stability (--md-enable-stable), now they are opt-out per stability level (--md-disable-stable-badge)
    • default has changed from not rendering badges to rendering them
    • there is no way to opt-out from generating stability column (the default was to not render it at all)

Example:

Attribute Type Description Examples Requirement Level Stability
test.deprecated_experimental_attr boolean Required Deprecated
Removed.
test.deprecated_stable_attr boolean Required Deprecated
Removed.
test.exp_attr boolean Required Experimental
test.stable_attr boolean Required Stable
Name Instrument Type Unit (UCUM) Description Stability
stable_metric Histogram s stable_metric Stable
Name Instrument Type Unit (UCUM) Description Stability
experimental_metric Counter {e} experimental_metric Experimental
Name Instrument Type Unit (UCUM) Description Stability
deprecated_metric UpDownCounter {d} deprecated_metric Deprecated
Removed.

@lmolkova lmolkova requested review from a team February 28, 2024 01:38
@lmolkova lmolkova force-pushed the stability_separate_column branch 2 times, most recently from 8c553d8 to 01b82d1 Compare February 28, 2024 04:22
Copy link
Copy Markdown
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

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

Looks great! Thank you

@lmolkova lmolkova merged commit 3ff0eeb into open-telemetry:main Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants