Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add stability levels to components output #8289

Conversation

jpkrohling
Copy link
Member

@jpkrohling jpkrohling commented Aug 28, 2023

Fixes open-telemetry/opentelemetry-collector-contrib#9518

Example output:

buildinfo:
    command: otelcorecol
    description: Local OpenTelemetry Collector binary, testing only.
    version: 0.83.0-dev
receivers:
    - name: otlp
      stability:
        logs: Beta
        metrics: Stable
        traces: Stable
processors:
    - name: memory_limiter
      stability:
        logs: Beta
        metrics: Beta
        traces: Beta
    - name: batch
      stability:
        logs: Stable
        metrics: Stable
        traces: Stable
exporters:
    - name: logging
      stability:
        logs: Development
        metrics: Development
        traces: Development
    - name: otlp
      stability:
        logs: Beta
        metrics: Stable
        traces: Stable
    - name: otlphttp
      stability:
        logs: Beta
        metrics: Stable
        traces: Stable
connectors:
    - name: forward
      stability:
        logs-to-logs: Beta
        logs-to-metrics: Undefined
        logs-to-traces: Undefined
        metrics-to-logs: Undefined
        metrics-to-metrics: Beta
        metrics-to-traces: Undefined
        traces-to-logs: Undefined
        traces-to-metrics: Undefined
        traces-to-traces: Beta
extensions:
    - name: memory_ballast
      stability:
        extension: Beta
    - name: zpages
      stability:
        extension: Beta

Signed-off-by: Juraci Paixão Kröhling juraci@kroehling.de

@jpkrohling jpkrohling requested review from a team and mx-psi August 28, 2023 13:32
Signed-off-by: Juraci Paixão Kröhling <juraci@kroehling.de>
@jpkrohling jpkrohling force-pushed the jpkrohling/contrib-9518-add-stability-levels-to-output-components branch from e25788e to c8a82ad Compare August 28, 2023 13:37
@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.21% 🎉

Comparison is base (92f5fe6) 90.18% compared to head (b27b5af) 90.39%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8289      +/-   ##
==========================================
+ Coverage   90.18%   90.39%   +0.21%     
==========================================
  Files         302      303       +1     
  Lines       15859    15946      +87     
==========================================
+ Hits        14303    14415     +112     
+ Misses       1261     1237      -24     
+ Partials      295      294       -1     
Files Changed Coverage Δ
otelcol/command_components.go 95.83% <100.00%> (+5.83%) ⬆️

... and 6 files with indirect coverage changes

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

Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

needs changelog entry, otherwise LGTM

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

This is great! Please add a changelog to capture the enhancement

otelcol/command_components.go Outdated Show resolved Hide resolved
Copy link
Member

@bogdandrutu bogdandrutu left a comment

Choose a reason for hiding this comment

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

Do you know if users would use this output to create their configs? If that is the case, would this break their flow?

I do understand that this is nice to have, but would like to document what is the components command for (it's purpose). If it is only for info only and debugging then let's document that the output is not intended to be stable and programmatically used.

@jpkrohling
Copy link
Member Author

Do you know if users would use this output to create their configs?

They shouldn't.

would like to document what is the components command for (it's purpose)

Good idea, I added a long description to the command to make it clear.

Signed-off-by: Juraci Paixão Kröhling <juraci@kroehling.de>
@jpkrohling
Copy link
Member Author

This is now ready for the next review.

@bogdandrutu bogdandrutu merged commit d29c591 into open-telemetry:main Aug 31, 2023
30 checks passed
@github-actions github-actions bot added this to the next release milestone Aug 31, 2023
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.

Add a command that lists components and their stability and support-levels
4 participants