From 201e657f6e8be9725fdcb77660caaca6ec55b212 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Sat, 27 May 2023 16:51:09 -0700 Subject: [PATCH] [chore] add metadata support to websocketprocessor (#22841) * [chore] add metadata support to websocketprocessor * generate README --- processor/websocketprocessor/README.md | 7 +++++++ processor/websocketprocessor/doc.go | 9 +++++++++ processor/websocketprocessor/factory.go | 8 ++------ .../internal/metadata/generated_status.go | 14 ++++++++++++++ processor/websocketprocessor/metadata.yaml | 7 +++++++ 5 files changed, 39 insertions(+), 6 deletions(-) create mode 100644 processor/websocketprocessor/doc.go create mode 100644 processor/websocketprocessor/internal/metadata/generated_status.go create mode 100644 processor/websocketprocessor/metadata.yaml diff --git a/processor/websocketprocessor/README.md b/processor/websocketprocessor/README.md index 17db0d8f9451..e77388391677 100644 --- a/processor/websocketprocessor/README.md +++ b/processor/websocketprocessor/README.md @@ -1,5 +1,12 @@ # Websocket Processor + +| Status | | +| ------------- |-----------| +| Stability | [development]: logs, metrics, traces | +| Distributions | [] | +[development]: https://github.com/open-telemetry/opentelemetry-collector#development + The WebSocket 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. diff --git a/processor/websocketprocessor/doc.go b/processor/websocketprocessor/doc.go new file mode 100644 index 000000000000..1237c41fdcc2 --- /dev/null +++ b/processor/websocketprocessor/doc.go @@ -0,0 +1,9 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +//go:generate mdatagen metadata.yaml + +// Package websocketprocessor can be positioned anywhere in a pipeline, allowing +// 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. +package websocketprocessor // import "github.com/open-telemetry/opentelemetry-collector-contrib/processor/websocketprocessor" diff --git a/processor/websocketprocessor/factory.go b/processor/websocketprocessor/factory.go index 2e4ef997d610..5b7c43233495 100644 --- a/processor/websocketprocessor/factory.go +++ b/processor/websocketprocessor/factory.go @@ -4,18 +4,14 @@ package websocketprocessor // import "github.com/open-telemetry/opentelemetry-collector-contrib/processor/websocketprocessor" import ( - "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/processor" -) -const ( - typeStr = "websocket" - stability = component.StabilityLevelDevelopment + "github.com/open-telemetry/opentelemetry-collector-contrib/processor/websocketprocessor/internal/metadata" ) func NewFactory() processor.Factory { return processor.NewFactory( - typeStr, + metadata.Type, createDefaultConfig, ) } diff --git a/processor/websocketprocessor/internal/metadata/generated_status.go b/processor/websocketprocessor/internal/metadata/generated_status.go new file mode 100644 index 000000000000..7c381305db7f --- /dev/null +++ b/processor/websocketprocessor/internal/metadata/generated_status.go @@ -0,0 +1,14 @@ +// Code generated by mdatagen. DO NOT EDIT. + +package metadata + +import ( + "go.opentelemetry.io/collector/component" +) + +const ( + Type = "websocket" + LogsStability = component.StabilityLevelDevelopment + MetricsStability = component.StabilityLevelDevelopment + TracesStability = component.StabilityLevelDevelopment +) diff --git a/processor/websocketprocessor/metadata.yaml b/processor/websocketprocessor/metadata.yaml new file mode 100644 index 000000000000..798e805f404a --- /dev/null +++ b/processor/websocketprocessor/metadata.yaml @@ -0,0 +1,7 @@ +type: websocket + +status: + class: processor + stability: + development: [logs, metrics, traces] + distributions: []