From 85f600cecd919b52230ead245c87c5268c80256f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ensar=20Saraj=C4=8Di=C4=87?= <dev@ensarsarajcic.com>
Date: Wed, 29 Jan 2025 11:06:43 +0100
Subject: [PATCH] Add missing docs for `websocket_server`

---
 .../configuration/sinks/websocket_server.md   | 14 +++
 .../components/sinks/websocket_server.cue     | 86 +++++++++++++++++++
 .../components/sources/internal_metrics.cue   |  6 ++
 3 files changed, 106 insertions(+)
 create mode 100644 website/content/en/docs/reference/configuration/sinks/websocket_server.md
 create mode 100644 website/cue/reference/components/sinks/websocket_server.cue

diff --git a/website/content/en/docs/reference/configuration/sinks/websocket_server.md b/website/content/en/docs/reference/configuration/sinks/websocket_server.md
new file mode 100644
index 0000000000000..b30978e23b744
--- /dev/null
+++ b/website/content/en/docs/reference/configuration/sinks/websocket_server.md
@@ -0,0 +1,14 @@
+---
+title: Websocket Server
+description: Deliver observability event data to websocket clients
+component_kind: sink
+layout: component
+tags: ["websocket", "component", "sink"]
+---
+
+{{/*
+This doc is generated using:
+
+1. The template in layouts/docs/component.html
+2. The relevant CUE data in cue/reference/components/...
+*/}}
diff --git a/website/cue/reference/components/sinks/websocket_server.cue b/website/cue/reference/components/sinks/websocket_server.cue
new file mode 100644
index 0000000000000..ddcd9d2b3e777
--- /dev/null
+++ b/website/cue/reference/components/sinks/websocket_server.cue
@@ -0,0 +1,86 @@
+package metadata
+
+components: sinks: websocket_server: {
+	_port: 8080
+	title: "WebSocket server"
+
+	classes: {
+		commonly_used: false
+		delivery:      "best_effort"
+		development:   "beta"
+		egress_method: "stream"
+		service_providers: []
+		stateful: false
+	}
+
+	features: {
+		acknowledgements: true
+		auto_generated:   true
+		healthcheck: enabled: true
+		send: {
+			compression: enabled: false
+			encoding: {
+				enabled: true
+				codec: {
+					enabled: true
+					enum: ["json", "text"]
+				}
+			}
+			request: enabled: false
+			tls: {
+				enabled:                true
+				can_verify_certificate: true
+				can_verify_hostname:    true
+				enabled_default:        false
+				enabled_by_scheme:      true
+			}
+			to: {
+				service: services.websocket
+				interface: {
+					socket: {
+						direction: "incoming"
+						protocols: ["tcp"]
+						ssl:  "optional"
+						port: _port
+					}
+				}
+			}
+		}
+	}
+
+	support: {
+		targets: {
+			"aarch64-unknown-linux-gnu":      true
+			"aarch64-unknown-linux-musl":     true
+			"armv7-unknown-linux-gnueabihf":  true
+			"armv7-unknown-linux-musleabihf": true
+			"x86_64-apple-darwin":            true
+			"x86_64-pc-windows-msv":          true
+			"x86_64-unknown-linux-gnu":       true
+			"x86_64-unknown-linux-musl":      true
+		}
+		requirements: []
+		warnings: []
+		notices: []
+	}
+
+	input: {
+		logs: true
+		metrics: {
+			counter:      true
+			distribution: true
+			gauge:        true
+			histogram:    true
+			summary:      true
+			set:          true
+		}
+		traces: true
+	}
+
+	telemetry: metrics: {
+		active_clients:               components.sources.internal_metrics.output.metrics.active_clients
+		open_connections:             components.sources.internal_metrics.output.metrics.open_connections
+		connection_established_total: components.sources.internal_metrics.output.metrics.connection_established_total
+		connection_shutdown_total:    components.sources.internal_metrics.output.metrics.connection_shutdown_total
+	}
+}
diff --git a/website/cue/reference/components/sources/internal_metrics.cue b/website/cue/reference/components/sources/internal_metrics.cue
index 91641a74cb357..4ed3856d866af 100644
--- a/website/cue/reference/components/sources/internal_metrics.cue
+++ b/website/cue/reference/components/sources/internal_metrics.cue
@@ -54,6 +54,12 @@ components: sources: internal_metrics: {
 		}
 
 		// Instance-level "process" metrics
+		active_clients: {
+			description:       "Number of clients attached to a component."
+			type:              "gauge"
+			default_namespace: "vector"
+			tags:              _component_tags
+		}
 		aggregate_events_recorded_total: {
 			description:       "The number of events recorded by the aggregate transform."
 			type:              "counter"