Meta tags:
description=Deliver observability event data to a websocket listener;
keywords=websocket,component,sink;

Headings (most frequently used words):

encoding, auth, tls, cef, csv, syslog, buffer, protobuf, imds, health, checks, enabled, acknowledgements, healthcheck, metrics, avro, gelf, json, extensions, severity, deprecated, websocket, configuration, input, types, telemetry, how, it, works, vector, site, footer, example, configurations, inputs, ping_interval, ping_timeout, uri, logs, traces, state, transport, layer, security, about, components, setup, community, download, password, service, strategy, token, user, value, max_events, max_size, type, when_full, codec, except_fields, metric_tag_values, only_fields, timestamp_format, warning, alpn_protocols, ca_file, crt_file, key_file, key_pass, server_name, verify_certificate, verify_hostname, buffer_byte_size, buffer_discarded_events_total, buffer_events, buffer_received_event_bytes_total, buffer_received_events_total, buffer_sent_event_bytes_total, buffer_sent_events_total, buffer_size_bytes, buffer_size_events, component_discarded_events_total, component_errors_total, component_received_event_bytes_total, component_received_events_count, component_received_events_total, component_sent_bytes_total, component_sent_event_bytes_total, component_sent_events_total, connection_established_total, connection_shutdown_total, open_connections, utilization, require, disable, access_key_id, assume_role, credentials_file, external_id, load_timeout_secs, profile, region, secret_access_key, session_name, session_token, schema, device_event_class_id, device_product, device_vendor, device_version, name, version, capacity, delimiter, double_quote, escape, fields, quote, quote_style, max_chunk_size, pretty, desc_file, message_type, use_json_names, app_name, facility, msg_id, proc_id, rfc, connect_timeout_seconds, max_attempts, read_timeout_seconds,

Text of the page (most frequently used words):
the (434), optional (124), vector (122), component (72), this (66), for (60), string (59), #encoding (53), literal (46), that (39), event (39), are (38), when (37), auth (37), type (36), data (33), required (33), and (31), from (31), aws (29), examples (29), which (27), host (26), events (26), hostname (25), number (25), use (25), default (25), file (24), buffer (23), process (22), metrics (22), instance (21), pid (21), system (21), running (21), path (21), not (21), field (21), tls (20), csv (20), cef (20), value (19), name (19), options (18), component_type (18), kind (18), component_kind (18), component_id (18), originated (18), logs (18), codec (18), relevant (18), enum (18), uri (17), object (17), can (16), set (16), bytes (16), used (16), websocket (15), counter (15), log (15), must (15), certificate (15), format (15), syslog (15), configuration (14), with (14), option (14), json (14), timestamp (13), protobuf (13), message (13), gelf (13), you (12), sinks (11), transform (11), source (11), fields (11), output (10), supported (10), enabled (10), more (10), uint (10), description (10), encodes (10), acknowledgements (10), server (9), sink (9), will (9), than (9), key (9), quotes (9), authentication (9), health (8), has (8), mode (8), metric (8), bool (8), values (8), avro (8), device (8), strategy (8), credentials (8), imds (8), end (8), input (7), like (7), gauge (7), sent (7), localhost (7), 8080 (7), also (7), any (7), using (7), remote (7), inputs (7), less (7), unique (7), basic (7), datadog (6), all (6), components (6), defaults (6), checks (6), false (6), seconds (6), connections (6), connection (6), been (6), protocol (6), only (6), internal (6), types (6), example (6), but (6), valid (6), pem (6), they (6), represent (6), unix (6), serializer (6), encoded (6), necessary (6), writing (6), empty (6), prometheus (6), model (6), bearer (6), role (6), my_sink_id (6), gcp (6), github (5), uses (5), behavior (5), service (5), how (5), total (5), region (5), absolute (5), http (5), either (5), currently (5), provided (5), ping_interval (5), ping_timeout (5), instead (5), otlp (5), version (5), length (5), equal (5), product (5), vendor (5), memory (5), disk (5), token (5), custom (5), password (5), chat (4), openssl (4), each (4), healthcheck (4), require (4), check (4), error (4), were (4), origins (4), other (4), deprecated (4), traces (4), verification (4), client (4), see (4), whether (4), list (4), rfc (4), severity (4), names (4), single (4), tags (4), text (4), 8192 (4), quote (4), record (4), native (4), remap (4), reference (4), specification (4), identifies (4), identifier (4), username (4), docs (4), architecture (4), rss (3), releases (3), download (3), going (3), sources (3), updates (3), protocols (3), due (3), disable (3), etc (3), never (3), every (3), open (3), times (3), specific (3), some (3), configurations (3), sanitized (3), pod (3), pod_name (3), pathname (3), peer_path (3), peer_addr (3), container (3), container_name (3), level (3), histogram (3), true (3), dropped (3), received (3), non (3), following (3), socket (3), should (3), include (3), part (3), connect (3), unless (3), outgoing (3), extension (3), enables (3), key_file (3), der (3), pkcs (3), additionally (3), inline (3), information (3), additional (3), peer (3), order (3), ignored (3), response (3), configured (3), point (3), rfc5424 (3), encoder (3), tag (3), exposed (3), strings (3), same (3), full (3), controls (3), maximum (3), header (3), graylog (3), puts (3), around (3), means (3), delimiter (3), character (3), ascii_char (3), configures (3), escape (3), capacity (3), logfmt (3), your (3), while (3), opentelemetry (3), experimental (3), allowed (3), apache (3), points (3), extensions (3), combination (3), schema (3), lost (3), buffering (3), authorization (3), session (3), assume (3), timeout (3), observability (3), splunk (3), hec (3), azure (3), kinesis (3), administration (2), deployment (2), installation (2), setup (2), transforms (2), about (2), webhdfs (2), content (2), new (2), via (2), specified (2), environment (2), security (2), stateless (2), across (2), state (2), config (2), yaml (2), healthy (2), upon (2), would (2), indicate (2), idle (2), waiting (2), down (2), established (2), emitted (2), may (2), send (2), destination (2), endpoint (2), raw (2), accepted (2), tagged (2), cumulatively (2), note (2), separate (2), useful (2), performance (2), issues (2), passed (2), topology (2), stage (2), within (2), errors (2), intentionally (2), filter (2), buffer_size_events (2), buffer_size_bytes (2), favor (2), telemetry (2), trace (2), wss (2), com (2), requires (2), enabling (2), understand (2), risks (2), verifying (2), present (2), presented (2), common (2), certificates (2), issuer (2), have (2), requests (2), upstream (2), host_certificate (2), identify (2), incoming (2), crt_file (2), crt (2), 509 (2), alpn (2), defined (2), sets (2), wait (2), pong (2), pings (2), interval (2), sending (2), array (2), starts (2), rfc3164 (2), formatting (2), facility (2), user (2), systems (2), proto (2), package (2), desc (2), read (2), descriptor (2), before (2), last (2), null (2), pretty (2), size (2), target (2), keep (2), 500 (2), recommended (2), even (2), strictly (2), always (2), well (2), disabled (2), escaped (2), them (2), raw_message (2), native_json (2), careful (2), modifying (2), removing (2), doing (2), parsing (2), could (2), lead (2), emitting (2), given (2), sdk (2), such (2), loki (2), spec (2), reason (2), pairs (2), keys (2), two (2), products (2), into (2), block (2), acceptance (2), consumption (2), free (2), space (2), performant (2), durable (2), restarted (2), forcefully (2), crashes (2), buffered (2), synchronized (2), aqodyxdz (2), access (2), profile (2), assume_role (2), metadata (2), arn (2), iam (2), global (2), connected (2), handled (2), home (2), api (2), pipeline (2), statsd (2), sematext (2), redis (2), pulsar (2), write (2), nats (2), mqtt (2), formerly (2), kafka (2), influxdb (2), humio (2), greptimedb (2), pubsub (2), stackdriver (2), cloud (2), storage (2), monitoring (2), sqs (2), firehose (2), cloudwatch (2), amqp (2), route (2), windows (2), kubernetes (2), docker (2), agent (2), concurrency (2), linux (2), pipelines (2), support (2), blog (2), guides (2), sidebar, 2026, inc, rights, reserved, community, prod, cookies, privacy, team, contact, site, footer, next, previous, thank, joining, our, newsletter, sign, receive, emails, latest, page, maturity, enable, adjust, location, variable, openssl_conf, usr, local, ssl, cnf, transport, layer, meaning, its, consistent, exit, immediately, failure, pass, flag, ensure, downstream, accessible, ready, accept, performed, initialization, fails, logged, proceed, start, works, ratio, load, completely, simply, updated, utilization, current, open_connections, shut, connection_shutdown_total, connection_established_total, component_sent_events_total, component_sent_event_bytes_total, excluding, query, component_sent_bytes_total, component_received_events_total, batching, mostly, low, debugging, small, batches, batch, component_received_events_count, component_received_event_bytes_total, occurred, error_type, encountered, component_errors_total, discarded, intentional, component_discarded_events_total, buffer_sent_events_total, buffer_sent_event_bytes_total, buffer_received_events_total, buffer_received_event_bytes_total, buffer_events, blocking, buffer_discarded_events_total, buffer_byte_size, link, summary, distribution, table, lists, possible, aware, available, differ, based, port, entry, subject, alternative, verify_hostname, validity, expired, issued, trusted, operates, hierarchical, manner, checking, leaf, until, reaches, root, create, initiate, validates, verify_certificate, www, indication, sni, server_name, password1, key_pass_env_var, effect, passphrase, unlock, encrypted, key_pass, private, identity, archive, certificate_authority, ca_file, declare, during, negotiation, prioritized, alpn_protocols, warning, time, still, there, expectation, between, ping, prefix, info, wildcards, ids, microseconds, unix_us, nanoseconds, unix_ns, milliseconds, unix_ms, floating, unix_float, 3339, rfc3339, timestamp_format, informational, modern, legacy, proc, proc_id, msg, msg_id, semantic, missing, app, app_name, working, already, converted, interfacing, naming, conventions, looks, their, job_description, jobdescription, camelcase, snake_case, use_json_names, serializing, message_type, protobuf_descriptor_set, here, protoc, desc_file, included, only_fields, multiple, show, assigned, arrays, bare, displayed, assignments, metric_tag_values, jsonserializer, chunked, datagram, including, byte, chunking, datagrams, exceed, below, decoding, framing, chunked_gelf, max_chunk_size, excluded, except_fields, numeric, does, parse, float, integer, aren, non_numeric, writes, produces, invalid, contain, terminator, indistinguishable, one, quoting, style, quote_style, these, regex, appear, needs, otherwise, setting, double_quotes, variants, special, escaping, doubling, doubled, double, escapes, double_quote, writer, 8kb, resembles, export, plain, 3164, 5424, suitable, compatible, endpoints, application, buffers, forward, implementation, might, continue, relax, enforcement, codecs, maintained, much, relaxed, strict, actual, receiver, adheres, exception, characters, encode, formatted, lowest_importance, highest_importance, reflects, importance, human, readable, 512, equals, collection, paths, problem, make, sends, messages, device_version, device_vendor, device_product, reported, 1023, device_event_class_id, selected, determines, typically, highest, priority, preferable, temporarily, lose, rather, cause, slowdown, drops, drop_newest, applies, backpressure, signalling, slow, pile, edge, handling, when_full, 500ms, then, least, 256, megabytes, 268435488, amount, allocated, hold, max_size, max_events, individual, found, section, custom_prefix, auth_header_value, inserted, headers, oauth2, jwt, concatenated, base64, signing, temporary, session_token, indexer, per, principal, autogenerated, provider, 1736428351340, assumed, rolesessionname, session_name, wjalrxutnfemi, k7mdeng, bpxrficyexamplekey, secret, secret_access_key, west, itself, sts, develop, select, chain, successfully, loading, load_timeout_secs, read_timeout_seconds, retries, fetching, tokens, max_attempts, connect_timeout_seconds, authenticating, through, randomexampleidstring, external, conjunction, external_id, credentials_file, 123456789098, my_role, akiaiosfodnn7example, access_key_id, disabling, takes, precedence, over, supports, waits, acknowledged, acknowledging, acknowledgement, toml, advanced, minimal, view, egress, stream, yes, delivery, best, effort, status, beta, deliver, listener, versioning, meta, glossary, variables, cli, secrets, template, syntax, unit, tests, exporter, postgres, papertrail, relic, mezmo, logdna, honeycomb, chronicle, unstructured, elasticsearch, doris, databricks, zerobus, databend, console, clickhouse, blackhole, monitor, ingestion, blob, axiom, sns, streams, appsignal, window, throttle, cardinality, limit, sample, reduce, lua, incremental, exclusive, delay, dedupe, ec2, aggregate, vrl, stdin, static, scrape, pushgateway, postgresql, okta, nginx, mongodb, logstash, journald, heroku, logplex, fluent, exec, eventstoredb, dnstap, demo, ecs, expressions, functions, language, pgo, optimization, validating, management, guarantees, adaptive, runtime, sizing, planning, rollout, high, availability, hardening, architecting, unified, aggregator, architectures, production, topologies, roles, installer, archives, manual, ubuntu, rhel, raspbian, nixos, macos, debian, centos, arch, amazon, operating, platforms, yum, rpm, pacman, nix, msi, homebrew, helm, dpkg, apt, managers, quickstart, concepts, introduction, navbar, dropdown, menu, search, toggle, dark, documentation,

Text of the page (random words):
h auth profile optional string literal the credentials profile to use used to select aws credentials from a provided credentials file examples develop default default auth auth region optional string literal the aws region to send sts requests to if not set this defaults to the configured region for the service itself examples us west 2 auth auth secret_access_key required string literal the aws secret access key examples wjalrxutnfemi k7mdeng bpxrficyexamplekey auth auth session_name optional string literal the optional rolesessionname is a unique session identifier for your assumed role should be unique per principal or reason if not set the session name is autogenerated like assume role provider 1736428351340 examples vector indexer role auth auth session_token optional string literal the aws session token see aws temporary credentials examples aqodyxdz aqodyxdz auth password required string literal the basic authentication password relevant when strategy basic examples password password auth service required string literal the aws service name to use for signing relevant when strategy aws auth strategy required string literal enum the authentication strategy to use enum options option description aws aws authentication basic basic authentication the username and password are concatenated and encoded using base64 bearer bearer authentication the bearer token value oauth2 jwt etc is passed as is custom custom authorization header value will be inserted into the headers as authorization value examples aws basic bearer custom auth token required string literal the bearer authentication token relevant when strategy bearer auth user required string literal the basic authentication username relevant when strategy basic examples username username auth value required string literal custom string value of the authorization header relevant when strategy custom examples auth_header_value custom_prefix token buffer optional object configures the buffering behavior for this sink more information about the individual buffer types and buffer behavior can be found in the buffering model section buffer max_events optional uint the maximum number of events allowed in the buffer relevant when type memory default 500 buffer max_size required uint the maximum allowed amount of allocated memory the buffer can hold if type disk then must be at least 256 megabytes 268435488 bytes buffer type optional string literal enum the type of buffer to use enum options option description disk events are buffered on disk this is less performant but more durable data that has been synchronized to disk will not be lost if vector is restarted forcefully or crashes data is synchronized to disk every 500ms memory events are buffered in memory this is more performant but less durable data will be lost if vector is restarted forcefully or crashes default memory buffer when_full optional string literal enum event handling behavior when a buffer is full enum options option description block wait for free space in the buffer this applies backpressure up the topology signalling that sources should slow down the acceptance consumption of events this means that while no data is lost data will pile up at the edge drop_newest drops the event instead of waiting for free space in buffer the event will be intentionally dropped this mode is typically used when performance is the highest priority and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance consumption of events default block encoding required object encoding configuration configures how events are encoded into raw bytes the selected encoding also determines which input types logs metrics traces are supported encoding avro required object apache avro specific encoder options relevant when codec avro encoding avro schema required string literal the avro schema examples type record name log fields name message type string encoding cef required object the cef serializer options relevant when codec cef encoding cef device_event_class_id required string literal unique identifier for each event type identifies the type of event reported the value length must be less than or equal to 1023 encoding cef device_product required string literal identifies the product of a vendor the part of a unique device identifier no two products can use the same combination of device vendor and device product the value length must be less than or equal to 63 encoding cef device_vendor required string literal identifies the vendor of the product the part of a unique device identifier no two products can use the same combination of device vendor and device product the value length must be less than or equal to 63 encoding cef device_version required string literal identifies the version of the problem the combination of the device product vendor and this value make up the unique id of the device that sends messages the value length must be less than or equal to 31 encoding cef extensions optional object the collection of key value pairs keys are the keys of the extensions and values are paths that point to the extension values of a log event the event can have any number of key value pairs in any order encoding cef extensions required string literal this is a path that points to the extension value of a log event encoding cef name required string literal this is a path that points to the human readable description of a log event the value length must be less than or equal to 512 equals cef name by default encoding cef severity required string literal this is a path that points to the field of a log event that reflects importance of the event it must point to a number from 0 to 10 0 lowest_importance 10 highest_importance set to cef severity by default encoding cef version required string literal enum cef version can be either 0 or 1 set to 0 by default enum options option description v0 cef specification version 0 1 v1 cef specification version 1 x examples v0 v1 encoding codec required string literal enum the codec to use for encoding events enum options option description avro encodes an event as an apache avro message cef encodes an event as a cef common event format formatted message csv encodes an event as a csv message this codec must be configured with fields to encode gelf encodes an event as a gelf message this codec is experimental for the following reason the gelf specification is more strict than the actual graylog receiver vector s encoder currently adheres more strictly to the gelf spec with the exception that some characters such as are allowed in field names other gelf codecs such as loki s use a go sdk that is maintained by graylog and is much more relaxed than the gelf spec going forward vector will use that go sdk as the reference implementation which means the codec might continue to relax the enforcement of the specification json encodes an event as json logfmt encodes an event as a logfmt message native encodes an event in the native protocol buffers format this codec is experimental native_json encodes an event in the native json format this codec is experimental otlp encodes an event in the otlp opentelemetry protocol format this codec uses protobuf encoding which is the recommended format for otlp the output is suitable for sending to otlp compatible endpoints with content type application x protobuf protobuf encodes an event as a protobuf message raw_message no encoding this encoding uses the message field of a log event be careful if you are modifying your log events for example by using a remap transform and removing the message field while doing additional parsing on it as this could lead to the encoding emitting empty strings for the given event syslog syslog encoding rfc 3164 and 5424 are supported text plain text encoding this encoding uses the message field of a log event for metrics it uses an encoding that resembles the prometheus export format be careful if you are modifying your log events for example by using a remap transform and removing the message field while doing additional parsing on it as this could lead to the encoding emitting empty strings for the given event examples avro cef csv gelf json logfmt native native_json otlp protobuf raw_message syslog text encoding csv required object the csv serializer options relevant when codec csv encoding csv capacity optional uint sets the capacity in bytes of the internal buffer used in the csv writer this defaults to 8192 bytes 8kb default 8192 encoding csv delimiter optional ascii_char the field delimiter to use when writing csv default encoding csv double_quote optional bool enables double quote escapes this is enabled by default but you can disable it when disabled quotes in field data are escaped instead of doubled default true encoding csv escape optional ascii_char the escape character to use when writing csv in some variants of csv quotes are escaped using a special escape character like instead of escaping quotes by doubling them to use this double_quotes needs to be disabled as well otherwise this setting is ignored default encoding csv fields required string configures the fields that are encoded as well as the order in which they appear in the output if a field is not present in the event the output for that field is an empty string values of type array object and regex are not supported and the output for any of these types is an empty string encoding csv quote optional ascii_char the quote character to use when writing csv default encoding csv quote_style optional string literal enum the quoting style to use when writing csv data enum options option description always always puts quotes around every field necessary puts quotes around fields only when necessary they are necessary when fields contain a quote delimiter or record terminator quotes are also necessary when writing an empty record which is indistinguishable from a record with one empty field never never writes quotes even if it produces invalid csv data non_numeric puts quotes around all fields that are non numeric this means that when writing a field that does not parse as a valid float or integer quotes are used even if they aren t strictly necessary default necessary encoding except_fields optional string list of fields that are excluded from the encoded event encoding gelf optional object the gelf serializer options relevant when codec gelf encoding gelf max_chunk_size optional uint maximum size for each gelf chunked datagram including 12 byte header chunking starts when datagrams exceed this size for graylog target keep at or below 8192 bytes for vector target gelf decoding with chunked_gelf framing up to 65 500 bytes is recommended default 8192 encoding json optional object options for the jsonserializer relevant when codec json encoding json pretty optional bool whether to use pretty json formatting default false encoding metric_tag_values optional string literal enum controls how metric tag values are encoded when set to single only the last non bare value of tags are displayed with the metric when set to full all metric tags are exposed as separate assignments relevant when codec json or codec text enum options option description full all tags are exposed as arrays of either string or null values single tag values are exposed as single strings the same as they were before this config option tags with multiple values show the last assigned value and null values are ignored default single encoding only_fields optional string list of fields that are included in the encoded event encoding protobuf required object options for the protobuf serializer relevant when codec protobuf encoding protobuf desc_file required string literal the path to the protobuf descriptor set file this file is the output of protoc i include path o desc output path proto you can read more here examples etc vector protobuf_descriptor_set desc encoding protobuf message_type required string literal the name of the message type to use for serializing examples package message encoding protobuf use_json_names optional bool use json field names camelcase instead of protobuf field names snake_case when enabled the serializer looks for fields using their json names as defined in the proto file for example jobdescription instead of job_description this is useful when working with data that has already been converted from json or when interfacing with systems that use json naming conventions default false encoding syslog optional object options for the syslog serializer relevant when codec syslog encoding syslog app_name optional string literal path to a field in the event to use for the app name if not provided the encoder checks for a semantic service field if that is also missing it defaults to vector encoding syslog facility optional string literal path to a field in the event to use for the facility defaults to user encoding syslog msg_id optional string literal path to a field in the event to use for the msg id encoding syslog proc_id optional string literal path to a field in the event to use for the proc id encoding syslog rfc optional string literal enum rfc to use for formatting enum options option description rfc3164 the legacy rfc3164 syslog format rfc5424 the modern rfc5424 syslog format default rfc5424 encoding syslog severity optional string literal path to a field in the event to use for the severity defaults to informational encoding timestamp_format optional string literal enum format used for timestamp fields enum options option description rfc3339 represent the timestamp as a rfc 3339 timestamp unix represent the timestamp as a unix timestamp unix_float represent the timestamp as a unix timestamp in floating point unix_ms represent the timestamp as a unix timestamp in milliseconds unix_ns represent the timestamp as a unix timestamp in nanoseconds unix_us represent the timestamp as a unix timestamp in microseconds healthcheck optional object healthcheck configuration healthcheck enabled optional bool whether or not to check the health of the sink when vector starts up default true inputs required string a list of upstream source or transform ids wildcards are supported see configuration for more info array string literal examples my source or transform id prefix ping_interval optional uint the interval in seconds between sending ping s to the remote peer if this option is not configured pings are not sent on an interval if the ping_timeout is not set pings are still sent but there is no expectation of pong response times examples 30 ping_timeout optional uint the number of seconds to wait for a pong response from the remote peer if a response is not received within this time the connection is re established warning this option is ignored if the ping_interval option is not set examples 5 tls optional object tls configuration tls alpn_protocols optional string sets the list of supported alpn protocols declare the supported alpn protocols which are...