[chore] add metadata support to websocketprocessor (open-telemetry#22841

) * [chore] add metadata support to websocketprocessor * generate README
bogdandrutu · May 27, 2023 · 201e657 · 201e657
1 parent 9d0181b
commit 201e657
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 6 deletions.
diff --git a/processor/websocketprocessor/README.md b/processor/websocketprocessor/README.md
@@ -1,5 +1,12 @@
 # Websocket Processor
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [development]: logs, metrics, traces   |
+| Distributions | [] |
 
+[development]: https://github.com/open-telemetry/opentelemetry-collector#development
+<!-- end autogenerated section -->
 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
@@ -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
@@ -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
diff --git a/processor/websocketprocessor/metadata.yaml b/processor/websocketprocessor/metadata.yaml
@@ -0,0 +1,7 @@
+type: websocket
+
+status:
+  class: processor
+  stability:
+    development: [logs, metrics, traces]
+  distributions: []