Skip to content

Commit 97a920d

Browse files
authored
Add namedpipereceiver (#29320)
**Description:** This adds a new receiver that reads from a named pipe, using the previously created namedpipeinput stanza operator (#28841). Because that operator does the majority of the work, this is mostly boilerplate + a few tests to confirm that it works e2e. Link to tracking Issue: #27234 **Testing:** Added a few tests, loading the config, and actually creating a receiver to verify that it can read logs from the pipe. **Documentation:** None, yet. /cc @djaglowski - where should I add docs for this if any?
1 parent 447468f commit 97a920d

File tree

17 files changed

+577
-0
lines changed

17 files changed

+577
-0
lines changed

.chloggen/namedpipe_receiver.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: new_component
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: namedpipereceiver
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Add "namedpipereceiver" that allows ingesting logs over a Named Pipe
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [27234]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ receiver/memcachedreceiver/ @open-telemetry/collect
227227
receiver/mongodbatlasreceiver/ @open-telemetry/collector-contrib-approvers @djaglowski @schmikei
228228
receiver/mongodbreceiver/ @open-telemetry/collector-contrib-approvers @djaglowski @schmikei
229229
receiver/mysqlreceiver/ @open-telemetry/collector-contrib-approvers @djaglowski
230+
receiver/namedpipereceiver/ @open-telemetry/collector-contrib-approvers @djaglowski
230231
receiver/nginxreceiver/ @open-telemetry/collector-contrib-approvers @djaglowski
231232
receiver/nsxtreceiver/ @open-telemetry/collector-contrib-approvers @dashpole @schmikei
232233
receiver/opencensusreceiver/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ body:
221221
- receiver/mongodb
222222
- receiver/mongodbatlas
223223
- receiver/mysql
224+
- receiver/namedpipe
224225
- receiver/nginx
225226
- receiver/nsxt
226227
- receiver/opencensus

.github/ISSUE_TEMPLATE/feature_request.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ body:
215215
- receiver/mongodb
216216
- receiver/mongodbatlas
217217
- receiver/mysql
218+
- receiver/namedpipe
218219
- receiver/nginx
219220
- receiver/nsxt
220221
- receiver/opencensus

.github/ISSUE_TEMPLATE/other.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ body:
215215
- receiver/mongodb
216216
- receiver/mongodbatlas
217217
- receiver/mysql
218+
- receiver/namedpipe
218219
- receiver/nginx
219220
- receiver/nsxt
220221
- receiver/opencensus

receiver/namedpipereceiver/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include ../../Makefile.Common

receiver/namedpipereceiver/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Named Pipe Receiver
2+
3+
<!-- status autogenerated section -->
4+
| Status | |
5+
| ------------- |-----------|
6+
| Stability | [alpha]: logs |
7+
| Distributions | [contrib] |
8+
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fnamedpipe%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fnamedpipe) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fnamedpipe%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fnamedpipe) |
9+
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@djaglowski](https://www.github.com/djaglowski) |
10+
11+
[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
12+
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
13+
<!-- end autogenerated section -->
14+
15+
This receiver supports opening a Unix Named Pipe (aka FIFO), and reading logs from it.
16+
17+
## Prerequisites
18+
19+
Named pipes are only supported on Unix operating systems.
20+
21+
22+
## Configuration
23+
24+
The following settings are required:
25+
26+
- `path`: The path to open the named pipe at.
27+
28+
The following settings are optional:
29+
30+
- `mode`: The mode bits to set on the opened pipe (default: 666)
31+
32+
## Example Configuration
33+
34+
```yaml
35+
receivers:
36+
namedpipe:
37+
path: /tmp/pipe
38+
mode: 0600
39+
```

receiver/namedpipereceiver/doc.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
//go:generate mdatagen metadata.yaml
5+
6+
// Package namedpipereceiver implements a receiver that can be used by the
7+
// OpenTelemetry collector to receive logs using the stanza log agent
8+
package namedpipereceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/namedpipereceiver"

receiver/namedpipereceiver/go.mod

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/namedpipereceiver
2+
3+
go 1.20
4+
5+
require (
6+
github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal v0.91.0
7+
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza v0.89.0
8+
github.com/stretchr/testify v1.8.4
9+
go.opentelemetry.io/collector/component v0.91.0
10+
go.opentelemetry.io/collector/confmap v0.91.0
11+
go.opentelemetry.io/collector/consumer v0.91.0
12+
go.opentelemetry.io/collector/receiver v0.91.0
13+
go.uber.org/zap v1.26.0
14+
)
15+
16+
require (
17+
github.com/cenkalti/backoff/v4 v4.2.1 // indirect
18+
github.com/cespare/xxhash/v2 v2.2.0 // indirect
19+
github.com/davecgh/go-spew v1.1.1 // indirect
20+
github.com/expr-lang/expr v1.15.7 // indirect
21+
github.com/fsnotify/fsnotify v1.7.0 // indirect
22+
github.com/gogo/protobuf v1.3.2 // indirect
23+
github.com/golang/protobuf v1.5.3 // indirect
24+
github.com/hashicorp/go-version v1.6.0 // indirect
25+
github.com/influxdata/go-syslog/v3 v3.0.1-0.20230911200830-875f5bc594a4 // indirect
26+
github.com/json-iterator/go v1.1.12 // indirect
27+
github.com/knadh/koanf/maps v0.1.1 // indirect
28+
github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
29+
github.com/knadh/koanf/v2 v2.0.1 // indirect
30+
github.com/leodido/ragel-machinery v0.0.0-20181214104525-299bdde78165 // indirect
31+
github.com/mitchellh/copystructure v1.2.0 // indirect
32+
github.com/mitchellh/mapstructure v1.5.1-0.20220423185008-bf980b35cac4 // indirect
33+
github.com/mitchellh/reflectwalk v1.0.2 // indirect
34+
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
35+
github.com/modern-go/reflect2 v1.0.2 // indirect
36+
github.com/pmezard/go-difflib v1.0.0 // indirect
37+
go.opencensus.io v0.24.0 // indirect
38+
go.opentelemetry.io/collector v0.91.0 // indirect
39+
go.opentelemetry.io/collector/config/configtelemetry v0.91.0 // indirect
40+
go.opentelemetry.io/collector/extension v0.91.0 // indirect
41+
go.opentelemetry.io/collector/featuregate v1.0.0 // indirect
42+
go.opentelemetry.io/collector/pdata v1.0.0 // indirect
43+
go.opentelemetry.io/otel v1.21.0 // indirect
44+
go.opentelemetry.io/otel/metric v1.21.0 // indirect
45+
go.opentelemetry.io/otel/trace v1.21.0 // indirect
46+
go.uber.org/multierr v1.11.0 // indirect
47+
golang.org/x/net v0.18.0 // indirect
48+
golang.org/x/sys v0.15.0 // indirect
49+
golang.org/x/text v0.14.0 // indirect
50+
gonum.org/v1/gonum v0.14.0 // indirect
51+
google.golang.org/genproto/googleapis/rpc v0.0.0-20230822172742-b8732ec3820d // indirect
52+
google.golang.org/grpc v1.59.0 // indirect
53+
google.golang.org/protobuf v1.31.0 // indirect
54+
gopkg.in/yaml.v3 v3.0.1 // indirect
55+
)
56+
57+
replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza => ../../pkg/stanza
58+
59+
replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage => ../../extension/storage
60+
61+
replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal => ../../internal/coreinternal
62+
63+
replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil => ../../pkg/pdatautil
64+
65+
replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest => ../../pkg/pdatatest
66+
67+
replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/golden => ../../pkg/golden

0 commit comments

Comments
 (0)