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

[connector/servicegraphconnector]fix README for Supported Pipeline Types #36367

Closed
wants to merge 6 commits into from

Conversation

Wudadada
Copy link

Description

This PR corrects the documentation in the README for servicegraphconnector, updating the Supported Pipeline Types section to accurately describe that the connector receives traces and outputs metrics. This update clarifies the correct pipeline configuration, reducing potential confusion for users.

Link to tracking issue

Testing

This change only affects documentation, so no additional tests were needed.

Documentation

@Wudadada Wudadada requested review from jpkrohling and a team as code owners November 14, 2024 02:56
Copy link

linux-foundation-easycla bot commented Nov 14, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Member

@JaredTan95 JaredTan95 left a comment

Choose a reason for hiding this comment

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

nice ctach!

@fatsheep9146 fatsheep9146 added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Nov 15, 2024
Copy link
Contributor

@fatsheep9146 fatsheep9146 left a comment

Choose a reason for hiding this comment

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

There is a failed ci, could you please check about that? https://github.com/open-telemetry/opentelemetry-collector-contrib/actions/runs/11833665410/job/33020325789?pr=36367

Generated code is out of date, please run "make generate" and commit the changes in this PR.

@Wudadada
Copy link
Author

There is a failed ci, could you please check about that? https://github.com/open-telemetry/opentelemetry-collector-contrib/actions/runs/11833665410/job/33020325789?pr=36367

Generated code is out of date, please run "make generate" and commit the changes in this PR.

I think the branch wasn’t up-to-date when running the CI; I’ve updated it now.

@Wudadada
Copy link
Author

After further clarification and re-evaluation, I realized that I misunderstood the definitions of Exporter Pipeline Type and Receiver Pipeline Type for the traces_to_metrics connector.

The correct types are:
• Exporter Pipeline Type: traces, as it processes trace data from the traces pipeline.
• Receiver Pipeline Type: metrics, as it outputs metrics data to the metrics pipeline.

In the PR, I incorrectly proposed that the Exporter Pipeline Type should be metrics and the Receiver Pipeline Type should be traces, which does not align with the intended functionality of the connector. Therefore, I am closing this PR as it is based on a misunderstanding.

Apologies for any confusion caused, and thank you for reviewing!

@Wudadada Wudadada closed this Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
connector/servicegraph Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants