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.

Sign up for GitHub

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 document defining an OpenTelemetry Collector #4313

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
+60 −0
Open

add document defining an OpenTelemetry Collector #4313

Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
512a3b4
add document defining an openTelemetry Collector
codeboten Nov 27, 2024
c71e06d
adding details regarding components and distributions
codeboten Nov 27, 2024
9d61bf7
typo
codeboten Nov 27, 2024
2405824
Update specification/collector/README.md
codeboten Nov 27, 2024
94e2673
added links
codeboten Nov 27, 2024
b41fb8c
Merge branch 'main' into codeboten/add-spec-for-collector
codeboten Nov 27, 2024
27699e9
Update specification/collector/README.md
codeboten Nov 28, 2024
9844574
Update specification/collector/README.md
codeboten Dec 2, 2024
d6a319f
Update specification/collector/README.md
codeboten Dec 2, 2024
7236f08
Update specification/collector/README.md
codeboten Dec 2, 2024
46829cf
Merge branch 'main' into codeboten/add-spec-for-collector
codeboten Dec 2, 2024
010c65f
Update specification/collector/README.md
codeboten Dec 5, 2024
d6b2ab4
Update specification/collector/README.md
codeboten Dec 5, 2024
4a42bee
Merge branch 'main' into codeboten/add-spec-for-collector
codeboten Dec 6, 2024
abc13c8
add details about configuration file
codeboten Dec 6, 2024
17cc1bf
Merge branch 'main' into codeboten/add-spec-for-collector
codeboten Dec 10, 2024
b589775
Update specification/collector/README.md
codeboten Dec 10, 2024
9229492
Update specification/collector/README.md
codeboten Dec 10, 2024
0704000
Update specification/collector/README.md
codeboten Dec 10, 2024
b0dd212
fix lint
codeboten Dec 10, 2024
b20d4d8
adding details regarding components that may use the same identifier
codeboten Dec 10, 2024
d73e36a
Update specification/collector/README.md
codeboten Dec 11, 2024
61d3666
Update specification/collector/README.md
codeboten Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions specification/collector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--- Hugo front matter used to generate the website version of this page:
path_base_for_github_subdir:
from: tmp/otel/specification/baggage/_index.md
to: baggage/README.md
codeboten marked this conversation as resolved.
Show resolved Hide resolved
--->

# OpenTelemetry Collector
Copy link
Member

Choose a reason for hiding this comment

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

OpenTelemetry Collector is never defined. Is it a source code artifact? A binary?

Copy link
Member

Choose a reason for hiding this comment

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

That's one of the things I was trying to get at here. Since there's no binary plugin mechanism it seems that the source would need to be available for it to be extended in the manner contemplated, but that's not clear or explicit in the current state.


The goal of this document is for users to be able to easily switch between
OpenTelemetry Collector Distros while also ensuring that components produced by
the OpenTelemetry Collector SIG is able to work with any vendor who claims
codeboten marked this conversation as resolved.
Show resolved Hide resolved
support for an OpenTelemetry Collector.

- An OpenTelemetry Collector _MUST_ accept a OpenTelemetry Collector Config file.
- An OpenTelemetry Collector _MUST_ be able to be compiled with any and all
codeboten marked this conversation as resolved.
Show resolved Hide resolved
additional Collector plugins that the user wishes to include.
Copy link
Member

Choose a reason for hiding this comment

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

Should this specification define what an OpenTelemetry Collector plugin is? Is it any component of type receiver, processor, exporter, extension, or config map provider?

Copy link
Member

Choose a reason for hiding this comment

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

Specification needs to define all the terms used in this definition, otherwise it does not remove ambiguity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed plugin to component and added a section to define OpenTelemetry Collector component.

- A compiled instance of an OpenTelemetry Collector – with a specific set of
plugins and features – is referred to as an OpenTelemetry Collector Distro.
codeboten marked this conversation as resolved.
Show resolved Hide resolved
codeboten marked this conversation as resolved.
Show resolved Hide resolved
Loading