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

Remove the primary exporter/receiver components, update references and documentation #230

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Remove the primary exporter/receiver components, update references and documentation #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ definition and Golang libraries for producing and consuming streams of
data in this format.

Exporter and receiver components for the [OpenTelemetry
Collector][OTCDOCS] were developed in parallel and are currently
maintained in this repository.
Collector][OTCDOCS] were developed in parallel, maintained in this
repository through release v0.24.0, and now they are included in
release of the OpenTelemetry Collector-Contrib repository.

- [Exporter][EXPORTER]: Send telemetry data using OpenTelemetry Protocol with Apache Arrow
- [Receiver][RECEIVER]: Receive telemetry data using OpenTelemetry Protocol with Apache Arrow.
Expand Down Expand Up @@ -79,8 +80,8 @@ the easiest way to upgrade this repository is:
[OTCDOCS]: https://opentelemetry.io/docs/collector/
[OTCGH]: https://github.com/open-telemetry/opentelemetry-collector
[OACGH]: https://github.com/open-telemetry/otel-arrow-collector
[EXPORTER]: ./collector/exporter/otelarrowexporter/README.md
[RECEIVER]: ./collector/receiver/otelarrowreceiver/README.md
[EXPORTER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/otelarrowexporter/README.md
[RECEIVER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/otelarrowreceiver/README.md
[DONATION]: https://github.com/open-telemetry/community/issues/1332
[DEVPROCESS]: https://github.com/open-telemetry/otel-arrow-collector/issues/48
[OTLPRECEIVER]: https://github.com/open-telemetry/opentelemetry-collector/receiver/otlpreceiver
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ endif
BUILDER = builder
.PHONY: $(BUILDER)
builder:
$(GOCMD) install go.opentelemetry.io/collector/cmd/builder@v0.102.1
$(GOCMD) install go.opentelemetry.io/collector/cmd/builder@v0.105.0

.PHONY: genotelarrowcol
genotelarrowcol: builder
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ workloads.
We are pleased to release two new collector components, presently
housed in this this repository.

- [OpenTelemetry Protocol with Apache Arrow Receiver](./collector/receiver/otelarrowreceiver/README.md)
- [OpenTelemetry Protocol with Apache Arrow Exporter](./collector/exporter/otelarrowexporter/README.md)
- [OpenTelemetry Protocol with Apache Arrow Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/otelarrowreceiver/README.md)
- [OpenTelemetry Protocol with Apache Arrow Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/otelarrowexporter/README.md)

We are working with the maintainers of the [OpenTelemetry
Collector-Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib)
Expand Down
22 changes: 2 additions & 20 deletions collector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,8 @@ The primary components are:

## Building and distributing these components

We are aware that building and distributing OpenTelemetry collectors
is not a simple task and have prepared dedicated instructions for
building and testing the components in this repository.

[Instructions for building an OpenTelemetry Collector with support for
OpenTelemetry Protocol with Apache Arrow.][BUILDING]

After you have built a collector using one of the documented methods,
see the [examples][EXAMPLES].

[We would prefer to include these components in the OpenTelemetry
Contrib Collector, because it is an officially maintained artifact.
At this time, however, these components are new and the migration
process will take some time to complete.][CONTRIBUTION]
The exporter and receiver components are included in the official
OpenTelemetry Collector-Contrib release images since v0.105.0.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest adding a link to the configuration/installation procedure or to the OpenTelemetry contribs collector builder.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I also noticed some broken links remaining here, will revise.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will do this in a new PR, since this one is fragile.


## Components included in this repository

Expand Down Expand Up @@ -71,11 +59,6 @@ From the core collector repository:
- [otelhttpexporter][UPSTREAMHTTPOTLP]: Useful for debugging, sends standard OTLP over HTTP
- [debugexporter][UPSTREAMDEBUG]: Useful for debugging, prints OTLP data to the console

Also, the build includes a synthetic telemetry data generator:

- [generator][GENERATOR]: Produces synthetic telemetry data.


[BUILDING]: ./BUILDING.md
[EXPORTER]: ./exporter/otelarrowexporter/README.md
[RECEIVER]: ./receiver/otelarrowreceiver/README.md
Expand All @@ -93,5 +76,4 @@ Also, the build includes a synthetic telemetry data generator:
[PPROFEXT]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/pprofextension/README.md
[UPSTREAMHTTPOTLP]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/otlphttpexporter/README.md
[UPSTREAMDEBUG]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/debugexporter/README.md
[GENERATOR]: https://github.com/lightstep/telemetry-generator/blob/main/README.md
[EXAMPLES]: ./examples/README.md
23 changes: 21 additions & 2 deletions collector/cmd/otelarrowcol/components.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading