Skip to content

Commit

Permalink
Add missing docs for websocket_server
Browse files Browse the repository at this point in the history
  • Loading branch information
esensar committed Jan 29, 2025
1 parent 8ef766d commit 85f600c
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -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/...
*/}}
86 changes: 86 additions & 0 deletions website/cue/reference/components/sinks/websocket_server.cue
Original file line number Diff line number Diff line change
@@ -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
}
}
6 changes: 6 additions & 0 deletions website/cue/reference/components/sources/internal_metrics.cue
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 85f600c

Please sign in to comment.