Skip to content

Commit

Permalink
[chore][processor/remotetap] fix component name in README (open-telem…
Browse files Browse the repository at this point in the history
  • Loading branch information
andrzej-stencel authored May 7, 2024
1 parent 37c1827 commit 54af4f6
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions processor/remotetapprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Websocket Processor
# Remote Tap Processor
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
Expand All @@ -11,7 +11,7 @@
[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->
The WebSocket processor, which can be positioned anywhere in a pipeline, allows
The Remote Tap processor, which can be positioned anywhere in a pipeline, allows
data to pass through to the next component. Simultaneously, it makes a portion
of the data accessible to WebSocket clients connecting on a configurable port.
This functionality resembles that of the Unix `tee` command, which enables data
Expand All @@ -22,7 +22,7 @@ any open WebSockets is rate limited by an adjustable amount.

## Config

The WebSocket processor has two configurable fields: `endpoint` and `limit`:
The Remote Tap processor has two configurable fields: `endpoint` and `limit`:

- `endpoint`: The endpoint on which the WebSocket processor listens. Optional. Defaults
to `0.0.0.0:12001`.
Expand All @@ -34,7 +34,8 @@ The WebSocket processor has two configurable fields: `endpoint` and `limit`:
Example configuration:

```yaml
websocket:
endpoint: 0.0.0.0:12001
limit: 1 # rate limit 1 msg/sec
processors:
remotetap:
endpoint: 0.0.0.0:12001
limit: 1 # rate limit 1 msg/sec
```

0 comments on commit 54af4f6

Please sign in to comment.