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 registry tip to ocb #5028

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add registry tip to ocb #5028

wants to merge 8 commits into from

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Aug 13, 2024

A small addition to the collector builder documentation, that the registry can be used to find configuration for components.

@svrnm svrnm requested a review from a team August 13, 2024 08:02
@opentelemetrybot opentelemetrybot requested a review from a team August 13, 2024 08:02
@opentelemetrybot opentelemetrybot requested review from atoulme and removed request for a team August 13, 2024 08:02
Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Couple of wording suggestions

content/en/docs/collector/custom-collector.md Outdated Show resolved Hide resolved
content/en/docs/collector/custom-collector.md Outdated Show resolved Hide resolved
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
@svrnm
Copy link
Member Author

svrnm commented Sep 5, 2024

@open-telemetry/collector-approvers PTAL

@opentelemetrybot opentelemetrybot requested a review from a team September 5, 2024 14:53
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Copyedits

Comment on lines 170 to 174
To find components that you can add to your custom Collector, take a look
the
[OpenTelemetry Registry](https://opentelemetry.io/ecosystem/registry/?language=collector).
In addition to available components, the Registry provides the full string you need to
add to your `builder-config.yaml`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To find components that you can add to your custom Collector, take a look
the
[OpenTelemetry Registry](https://opentelemetry.io/ecosystem/registry/?language=collector).
In addition to available components, the Registry provides the full string you need to
add to your `builder-config.yaml`.
For a list of components that you can add to your custom collector, see the [OpenTelemetry Registry](/ecosystem/registry/?language=collector). Note that registry entries provide the full string you need to add to your `builder-config.yaml`.

By the way, what is "the full string" -- i.e., it is a full string of what? The component name or ID?

Copy link
Contributor

Choose a reason for hiding this comment

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

Btw, IMHO, "collector" should be in lowercase (as I suggest in the previous comment) in "custom collector" because we're not talking about the OTel Collector. WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

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

the "full string" is something like this:

exporters:
    - gomod:
        github.com/open-telemetry/opentelemetry-collector-contrib/exporter/influxdbexporter v0.108.0

I see how this is not clear, the "full component name and version you need" might be better?

It's still an OpenTelemetry Collector, it's just a custom one, I guess?

Copy link
Contributor

Choose a reason for hiding this comment

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

I see how this is not clear, the "full component name and version you need" might be better?

Yes. I see that you've made this change already. Thanks.

It's still an OpenTelemetry Collector, it's just a custom one, I guess?

Well, the fact that you write "an OpenTelemetry Collector" means that even you don't think that it is the Collector. IMHO, the Collector should refer to a fixed (for any given version) binary. Does that make sense?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm, there is no fixed binary of the collector afaik, even for the ones we deliver as community there is "Core" and "Contrib" and some other distributions. My understanding so far was, that we say Collector when we mean an OpenTelemetry collector build from https://github.com/open-telemetry/opentelemetry-collector, this includes the "Whatever Distribution of OpenTelemetry Collector", and custom Collectors, but if someone has a component that collects telemetry or whatever it's a collector.

@theletterf
Copy link
Member

/fix:all

@opentelemetrybot
Copy link
Collaborator

@opentelemetrybot
Copy link
Collaborator

fix:all was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

Co-authored-by: Juraci Paixão Kröhling <[email protected]>
@opentelemetrybot opentelemetrybot requested review from a team September 6, 2024 09:17
@opentelemetrybot opentelemetrybot requested a review from a team September 9, 2024 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Need SIG Review
Development

Successfully merging this pull request may close these issues.

7 participants