Skip to content

Commit c39257c

Browse files
drewrelmasjmacd
drewrelmas
and
jmacd
authored
Use upstream filereceiver and fileexporter with updated docs (#278)
Originated from looking at #232 as an easy doc-related first contribution in open-telemetry organization. In fixing 404 doc links, noted that the referenced upstream `filereceiver` was renamed to `otlpjsonfilereceiver`. Consulted with @jmacd and determined the best path forward is to deprecate local copies of `filereceiver` and `fileexporter` in favor of the proper, existing upstream implementations. --------- Co-authored-by: Joshua MacDonald <[email protected]>
1 parent 78b913b commit c39257c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+85
-3906
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
99
## Unreleased
1010

1111
- Update to v0.117.0 collector dependencies. [#277](https://github.com/open-telemetry/otel-arrow/pull/277), [#279](https://github.com/open-telemetry/otel-arrow/pull/279)
12+
- Deprecate local versions of `fileexporter` and `filereceiver` in favor of upstream components with related README changes. [#232](https://github.com/open-telemetry/otel-arrow/issues/232)
1213

1314
## [0.31.0](https://github.com/open-telemetry/otel-arrow/releases/tag/v0.31.0) - 2024-11-19
1415

‎collector/README.md‎

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ This directory contains the primary collector components for using
44
OpenTelemetry Protocol with Apache Arrow as well as a number of useful
55
accessory components that were developed to assist the project.
66

7-
The primary components are:
7+
The primary components (now included in the upstream [Collector-Contrib repository][COLLECTORCONTRIB]) are:
88

9-
- [Exporter][EXPORTER]: for sending OpenTelemetry Protocol with Apache Arrow data
10-
- [Receiver][RECEIVER]: for receiving OpenTelemetry Protocol with Apache Arrow data
9+
- [OTel Arrow Exporter][ARROWEXPORTER]: for sending OpenTelemetry Protocol with Apache Arrow data
10+
- [OTel Arrow Receiver][ARROWRECEIVER]: for receiving OpenTelemetry Protocol with Apache Arrow data
11+
12+
Note that the exporter and receiver components have been included in the official
13+
OpenTelemetry Collector-Contrib release images since v0.105.0.
1114

1215
## Building and distributing these components
1316

14-
The exporter and receiver components are included in the official
15-
OpenTelemetry Collector-Contrib release images since v0.105.0.
17+
See [Building][BUILDING].
1618

1719
## Components included in this repository
1820

@@ -30,14 +32,6 @@ maintainers. These components are:
3032

3133
### For research and validation
3234

33-
- [`exporter/fileexporter`][ARROWFILEEXPORTER]: Derived from the
34-
upstream [fileexporter][UPSTREAMFILEEXPORTER], this component
35-
supports writing files that can be read by the corresponding
36-
`filereceiver` in this package (which the upstream cannot do).
37-
- [`receiver/filereceiver`][ARROWFILERECEIVER]: Derived from the
38-
upstream [filereceiver][UPSTREAMFILERECEIVER], this component
39-
supports reading files written by the corresponding `fileexporter`
40-
in this package (unlike the upstream).
4135
- [`processor/obfuscationprocessor`][OBFUSCATIONPROCESSOR]: Supports
4236
obfuscation of OpenTelemetry data using a [Feistel
4337
cipher](https://en.wikipedia.org/wiki/Feistel_cipher).
@@ -51,23 +45,25 @@ Several Collector-Contrib extensions are included in the build:
5145
- [headersetter][HEADERSETTEREXT]: Allows propagating headers through
5246
a pipeline
5347
- [pprof][PPROFEXT]: Allows use of Golang profiling tools.
48+
- [fileexporter][FILEEXPORTER]: Writes telemetry data to files on disk.
49+
- [otlpjsonfilereceiver][FILERECEIVER]: Reads telemetry data from JSON files.
50+
51+
Note that while previously this repository had its own local versions of a basic fileexporter and filereceiver derived from upstream, it is now recommended to use the upstream [fileexporter][FILEEXPORTER] and [otlpjsonfilereceiver][FILERECEIVER] instead.
5452

5553
From the core collector repository:
5654

5755
- [otelhttpexporter][UPSTREAMHTTPOTLP]: Useful for debugging, sends standard OTLP over HTTP
5856
- [debugexporter][UPSTREAMDEBUG]: Useful for debugging, prints OTLP data to the console
5957

6058
[BUILDING]: ./BUILDING.md
61-
[EXPORTER]: ./exporter/otelarrowexporter/README.md
62-
[RECEIVER]: ./receiver/otelarrowreceiver/README.md
63-
[CONTRIBUTION]: https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/26491
59+
[COLLECTORCONTRIB]: https://github.com/open-telemetry/opentelemetry-collector-contrib
60+
[ARROWEXPORTER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/otelarrowexporter/README.md
61+
[ARROWRECEIVER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/otelarrowreceiver/README.md
6462
[UPSTREAMBATCHPROCESSOR]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/processor/batchprocessor/README.md
6563
[CONCURRENTBATCHPROCESSOR]: ./processor/concurrentbatchprocessor/README.md
66-
[ARROWFILEEXPORTER]: ./exporter/fileexporter/README.md
67-
[ARROWFILERECEIVER]: ./receiver/filereceiver/README.md
68-
[UPSTREAMFILEEXPORTER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/fileexporter/README.md
69-
[UPSTREAMFILERECEIVER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filereceiver/README.md
7064
[OBFUSCATIONPROCESSOR]: ./processor/obfuscationprocessor/README.md
65+
[FILEEXPORTER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/fileexporter/README.md
66+
[FILERECEIVER]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/otlpjsonfilereceiver/README.md
7167
[BASICAUTHEXT]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/basicauthextension/README.md
7268
[HEADERSETTEREXT]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/headerssetterextension/README.md
7369
[PPROFEXT]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/pprofextension/README.md

‎collector/cmd/otelarrowcol/components.go‎

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎collector/cmd/otelarrowcol/go.mod‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ module github.com/open-telemetry/otel-arrow/collector/cmd/otelarrowcol
44

55
go 1.22.0
66

7-
toolchain go1.22.2
7+
toolchain go1.23.4
88

99
require (
10+
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/fileexporter v0.117.0
1011
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/otelarrowexporter v0.117.0
1112
github.com/open-telemetry/opentelemetry-collector-contrib/extension/basicauthextension v0.117.0
1213
github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension v0.117.0
1314
github.com/open-telemetry/opentelemetry-collector-contrib/extension/pprofextension v0.117.0
1415
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/otelarrowreceiver v0.117.0
15-
github.com/open-telemetry/otel-arrow/collector/exporter/fileexporter v0.31.0
16+
github.com/open-telemetry/opentelemetry-collector-contrib/receiver/otlpjsonfilereceiver v0.117.0
1617
github.com/open-telemetry/otel-arrow/collector/processor/concurrentbatchprocessor v0.31.0
1718
github.com/open-telemetry/otel-arrow/collector/processor/obfuscationprocessor v0.31.0
18-
github.com/open-telemetry/otel-arrow/collector/receiver/filereceiver v0.31.0
1919
go.opentelemetry.io/collector/component v0.117.0
2020
go.opentelemetry.io/collector/confmap v1.23.0
2121
go.opentelemetry.io/collector/confmap/provider/envprovider v1.23.0
@@ -42,16 +42,19 @@ require (
4242
github.com/apache/arrow/go/v17 v17.0.0 // indirect
4343
github.com/axiomhq/hyperloglog v0.0.0-20230201085229-3ddf4bad03dc // indirect
4444
github.com/beorn7/perks v1.0.1 // indirect
45+
github.com/bmatcuk/doublestar/v4 v4.7.1 // indirect
4546
github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
4647
github.com/cenkalti/backoff/v4 v4.3.0 // indirect
4748
github.com/cespare/xxhash/v2 v2.3.0 // indirect
4849
github.com/cyrildever/feistel v1.5.5 // indirect
4950
github.com/cyrildever/go-utls v1.9.7 // indirect
50-
github.com/davecgh/go-spew v1.1.1 // indirect
51+
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
5152
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
5253
github.com/dgryski/go-metro v0.0.0-20180109044635-280f6062b5bc // indirect
5354
github.com/ebitengine/purego v0.8.1 // indirect
55+
github.com/elastic/lunes v0.1.0 // indirect
5456
github.com/ethereum/go-ethereum v1.13.1 // indirect
57+
github.com/expr-lang/expr v1.16.9 // indirect
5558
github.com/fatih/color v1.15.0 // indirect
5659
github.com/felixge/httpsnoop v1.0.4 // indirect
5760
github.com/fsnotify/fsnotify v1.8.0 // indirect
@@ -69,15 +72,20 @@ require (
6972
github.com/google/uuid v1.6.0 // indirect
7073
github.com/grpc-ecosystem/grpc-gateway/v2 v2.23.0 // indirect
7174
github.com/hashicorp/go-version v1.7.0 // indirect
75+
github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
7276
github.com/holiman/uint256 v1.2.3 // indirect
7377
github.com/inconshreveable/mousetrap v1.1.0 // indirect
78+
github.com/jonboulle/clockwork v0.4.0 // indirect
7479
github.com/json-iterator/go v1.1.12 // indirect
7580
github.com/klauspost/compress v1.17.11 // indirect
7681
github.com/klauspost/cpuid/v2 v2.2.8 // indirect
7782
github.com/knadh/koanf/maps v0.1.1 // indirect
7883
github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
7984
github.com/knadh/koanf/v2 v2.1.2 // indirect
85+
github.com/leodido/go-syslog/v4 v4.2.0 // indirect
86+
github.com/leodido/ragel-machinery v0.0.0-20190525184631-5f46317e436b // indirect
8087
github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
88+
github.com/magefile/mage v1.15.0 // indirect
8189
github.com/mattn/go-colorable v0.1.13 // indirect
8290
github.com/mattn/go-isatty v0.0.19 // indirect
8391
github.com/mitchellh/copystructure v1.2.0 // indirect
@@ -86,12 +94,14 @@ require (
8694
github.com/modern-go/reflect2 v1.0.2 // indirect
8795
github.com/mostynb/go-grpc-compression v1.2.3 // indirect
8896
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
97+
github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal v0.117.0 // indirect
8998
github.com/open-telemetry/opentelemetry-collector-contrib/internal/grpcutil v0.117.0 // indirect
9099
github.com/open-telemetry/opentelemetry-collector-contrib/internal/otelarrow v0.117.0 // indirect
91100
github.com/open-telemetry/opentelemetry-collector-contrib/internal/sharedcomponent v0.117.0 // indirect
101+
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza v0.117.0 // indirect
92102
github.com/open-telemetry/otel-arrow v0.31.0 // indirect
93103
github.com/pierrec/lz4/v4 v4.1.22 // indirect
94-
github.com/pmezard/go-difflib v1.0.0 // indirect
104+
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
95105
github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
96106
github.com/prometheus/client_golang v1.20.5 // indirect
97107
github.com/prometheus/client_model v0.6.1 // indirect
@@ -105,6 +115,7 @@ require (
105115
github.com/tg123/go-htpasswd v1.2.3 // indirect
106116
github.com/tklauser/go-sysconf v0.3.12 // indirect
107117
github.com/tklauser/numcpus v0.6.1 // indirect
118+
github.com/valyala/fastjson v1.6.4 // indirect
108119
github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect
109120
github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
110121
github.com/x448/float16 v0.8.4 // indirect
@@ -180,11 +191,11 @@ require (
180191
go.uber.org/zap v1.27.0 // indirect
181192
golang.org/x/crypto v0.32.0 // indirect
182193
golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect
183-
golang.org/x/mod v0.18.0 // indirect
194+
golang.org/x/mod v0.19.0 // indirect
184195
golang.org/x/net v0.34.0 // indirect
185196
golang.org/x/sync v0.10.0 // indirect
186197
golang.org/x/text v0.21.0 // indirect
187-
golang.org/x/tools v0.22.0 // indirect
198+
golang.org/x/tools v0.23.0 // indirect
188199
golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
189200
gonum.org/v1/gonum v0.15.1 // indirect
190201
google.golang.org/genproto/googleapis/api v0.0.0-20241104194629-dd2ea8efbc28 // indirect
@@ -197,10 +208,6 @@ require (
197208

198209
replace github.com/open-telemetry/otel-arrow => ../../../
199210

200-
replace github.com/open-telemetry/otel-arrow/collector/exporter/fileexporter => ../../exporter/fileexporter
201-
202-
replace github.com/open-telemetry/otel-arrow/collector/receiver/filereceiver => ../../receiver/filereceiver
203-
204211
replace github.com/open-telemetry/otel-arrow/collector/processor/concurrentbatchprocessor => ../../processor/concurrentbatchprocessor
205212

206213
replace github.com/open-telemetry/otel-arrow/collector/processor/obfuscationprocessor => ../../processor/obfuscationprocessor

0 commit comments

Comments
 (0)