From 54af4f604492ad12e0b079a30a4c9779bd270dc4 Mon Sep 17 00:00:00 2001 From: Andrzej Stencel Date: Tue, 7 May 2024 17:37:07 +0200 Subject: [PATCH] [chore][processor/remotetap] fix component name in README (#32582) --- processor/remotetapprocessor/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/processor/remotetapprocessor/README.md b/processor/remotetapprocessor/README.md index e273bba5de7c..a44711d6dad2 100644 --- a/processor/remotetapprocessor/README.md +++ b/processor/remotetapprocessor/README.md @@ -1,4 +1,4 @@ -# Websocket Processor +# Remote Tap Processor | Status | | | ------------- |-----------| @@ -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 -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 @@ -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`. @@ -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 ```