Meta tags:
description=Receive events from a WebSocket server.;
keywords=websocket,component,source;

Headings (most frequently used words):

auth, decoding, framing, tls, proxy, chunked_gelf, length_delimited, lossy, protobuf, imds, max_length, pong_message, no_proxy, avro, gelf, vrl, character_delimited, https_proxy, http_proxy, value, influxdb, json, native_json, syslog, max_frame_length, newline_delimited, octet_counting, warning, enabled, deprecated, websocket, configuration, environment, variables, outputs, output, types, telemetry, how, it, works, vector, site, footer, example, configurations, connect_timeout_secs, initial_message, initial_message_timeout_secs, ping_interval, ping_message, ping_timeout, uri, component_id, logs, metrics, context, state, transport, layer, security, about, components, setup, community, download, password, service, strategy, token, user, codec, signal_types, method, type, http, https, alpn_protocols, ca_file, crt_file, key_file, key_pass, server_name, verify_certificate, verify_hostname, event, component_discarded_events_total, component_errors_total, component_received_bytes_total, component_received_event_bytes_total, component_received_events_count, component_received_events_total, component_sent_event_bytes_total, component_sent_events_total, source_buffer_max_byte_size, source_buffer_max_event_size, source_buffer_max_size_bytes, source_buffer_max_size_events, source_buffer_utilization, source_buffer_utilization_level, source_buffer_utilization_mean, source_lag_time_seconds, access_key_id, assume_role, credentials_file, external_id, load_timeout_secs, profile, region, secret_access_key, session_name, session_token, schema, strip_schema_id_prefix, validation, desc_file, message_type, use_json_names, source, timezone, delimiter, decompression, pending_messages_limit, timeout_secs, length_field_is_big_endian, length_field_length, length_field_offset, fields, connect_timeout_seconds, max_attempts, read_timeout_seconds,

Text of the page (most frequently used words):
the (457), optional (148), #vector (99), component (80), this (74), string (57), literal (45), for (41), examples (41), when (40), from (39), data (37), auth (37), decoding (36), which (33), and (30), file (30), type (30), message (30), default (29), logs (29), not (29), aws (28), are (27), output (26), bytes (26), required (26), originated (24), set (24), relevant (24), metrics (23), example (23), framing (22), options (21), uri (21), object (21), length (21), tls (20), can (20), host (20), number (20), name (20), that (20), use (20), events (19), websocket (19), hostname (19), specific (19), requests (19), proxy (19), gelf (19), configuration (18), with (18), source (18), buffer (18), process (17), system (17), component_id (17), http (17), uint (17), instance (16), pid (16), running (16), component_type (16), kind (16), component_kind (16), used (16), matches (16), decoder (16), maximum (15), certificate (15), codec (15), level (14), true (14), com (14), raw (13), value (13), json (13), server (12), one (12), bool (12), format (12), enum (12), byte (12), protobuf (12), seconds (11), mode (11), path (11), must (11), option (11), messages (11), sequences (11), decodes (11), sources (10), send (10), has (10), invalid (10), utf (10), all (9), event (9), log (9), you (9), types (9), localhost (9), strategy (9), method (9), character (9), vrl (9), avro (9), authentication (9), outputs (8), over (8), connection (8), will (8), common (8), instead (8), traces (8), influxdb (8), credentials (8), imds (8), time (7), counter (7), foo (7), enabled (7), more (7), priority (7), hosts (7), names (7), include (7), through (7), 8080 (7), also (7), valid (7), remote (7), only (7), key (7), custom (7), memory (7), frames (7), length_delimited (7), chunked_gelf (7), syslog (7), basic (7), role (7), datadog (6), components (6), gauge (6), lowercase (6), variant (6), uppercase (6), another (6), overridden (6), any (6), addresses (6), 127 (6), proxying (6), bar (6), 3128 (6), https (6), pem (6), whether (6), order (6), description (6), delimited (6), field (6), limit (6), bearer (6), my_source_id (6), gcp (6), github (5), local (5), its (5), each (5), input (5), using (5), metric (5), origins (5), internal (5), received (5), 192 (5), 168 (5), no_proxy (5), match (5), global (5), protocol (5), connections (5), ping_interval (5), ping_timeout (5), initial_message (5), does (5), character_delimited (5), timeout (5), decompression (5), replaced (5), fffd (5), replacement (5), determines (5), replace (5), failing (5), lossy (5), otlp (5), strict (5), schema (5), token (5), password (5), prometheus (5), model (5), chat (4), new (4), uses (4), openssl (4), timestamp (4), histogram (4), utilization (4), hold (4), deprecated (4), sanitized (4), pod (4), pod_name (4), pathname (4), peer_path (4), peer_addr (4), container (4), container_name (4), either (4), like (4), other (4), note (4), than (4), error (4), errors (4), false (4), exact (4), fields (4), see (4), allowed (4), list (4), avoid (4), url (4), verification (4), client (4), provided (4), absolute (4), traffic (4), being (4), pong (4), response (4), configured (4), ping (4), sent (4), initial_message_timeout_secs (4), subscribe (4), octet_counting (4), max_length (4), processing (4), malformed (4), such (4), unbounded (4), lead (4), usage (4), newline_delimited (4), header (4), chunks (4), signal (4), native_json (4), native (4), validation (4), spec (4), specification (4), style (4), reference (4), kafka (4), connect_timeout_secs (4), username (4), docs (4), architecture (4), rss (3), releases (3), download (3), going (3), sinks (3), transforms (3), windows (3), updates (3), receive (3), protocols (3), due (3), behavior (3), defaults (3), specified (3), environment (3), state (3), between (3), total (3), accepted (3), passed (3), into (3), payload (3), stream (3), splat (3), range (3), blocks (3), cidr (3), subdomains (3), wildcard (3), domains (3), domain (3), pattern (3), patterns (3), socket (3), should (3), but (3), connect (3), unless (3), outgoing (3), enables (3), key_file (3), der (3), pkcs (3), additionally (3), inline (3), additional (3), supported (3), peer (3), support (3), pong_message (3), ping_message (3), frame (3), there (3), before (3), out (3), while (3), user (3), continue (3), delimiter (3), prefixed (3), graylog (3), automatically (3), program (3), remap (3), relaxed (3), opentelemetry (3), experimental (3), apache (3), authorization (3), service (3), session (3), unique (3), assume (3), region (3), splunk (3), hec (3), azure (3), kinesis (3), administration (2), deployment (2), installation (2), setup (2), via (2), security (2), stateless (2), context (2), how (2), was (2), ingested (2), mean (2), source_buffer_max_size_events (2), source_buffer_max_size_bytes (2), been (2), favor (2), emitted (2), tagged (2), cumulatively (2), useful (2), performance (2), issues (2), stage (2), within (2), filter (2), dropped (2), different (2), namespacing (2), warning (2), come (2), here (2), globally (2), https_proxy (2), http_proxy (2), variables (2), wss (2), requires (2), understand (2), risks (2), verifying (2), presented (2), certificates (2), issuer (2), host_certificate (2), identify (2), incoming (2), information (2), crt_file (2), crt (2), 509 (2), alpn (2), they (2), defined (2), multiple (2), endpoint (2), based (2), proxied (2), external (2), contains (2), contain (2), expected (2), application (2), still (2), pings (2), interval (2), timing (2), octet (2), counting (2), risk (2), controlled (2), consider (2), setting (2), reasonably (2), large (2), safety (2), net (2), prevents (2), enforced (2), resource (2), buffered (2), potentially (2), exhaustion (2), extreme (2), cases (2), trailing (2), newline (2), indicating (2), varint_length_delimited (2), according (2), big (2), endian (2), chunked (2), 388608e (2), max_frame_length (2), reached (2), pending (2), per (2), auto (2), zlib (2), gzip (2), timezone (2), zone (2), may (2), result (2), language (2), deserializer (2), parse (2), systems (2), proto (2), package (2), descriptor (2), strictly (2), rfc (2), sdk (2), loki (2), following (2), reason (2), encoded (2), documentation (2), aqodyxdz (2), access (2), profile (2), assume_role (2), metadata (2), arn (2), iam (2), open (2), acknowledgements (2), aggregator (2), home (2), api (2), pipeline (2), statsd (2), sematext (2), redis (2), pulsar (2), write (2), nats (2), mqtt (2), formerly (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), kubernetes (2), docker (2), agent (2), end (2), concurrency (2), linux (2), observability (2), pipelines (2), blog (2), guides (2), sidebar, 2026, inc, rights, reserved, community, prod, cookies, privacy, team, contact, about, site, footer, next, previous, thank, joining, our, newsletter, sign, emails, latest, content, page, maturity, enable, adjust, location, variable, openssl_conf, usr, ssl, cnf, transport, layer, meaning, consistent, across, augments, helpful, keys, works, difference, recorded, expressed, fractional, source_lag_time_seconds, smoothed, exponentially, weighted, moving, average, ewma, source_buffer_utilization_mean, current, source_buffer_utilization_level, source_buffer_utilization, source_buffer_max_event_size, source_buffer_max_byte_size, component_sent_events_total, component_sent_event_bytes_total, component_received_events_total, separate, sink, batching, mostly, low, debugging, small, batches, batch, topology, component_received_events_count, component_received_event_bytes_total, component_received_bytes_total, occurred, error_type, encountered, component_errors_total, were, discarded, intentionally, transform, intentional, component_discarded_events_total, link, telemetry, 452332, t17, 2020, source_type, info, shown, below, details, downstream, port, part, enabling, present, entry, subject, alternative, extension, verify_hostname, validity, expired, issued, trusted, operates, hierarchical, manner, checking, leaf, until, reaches, root, create, have, initiate, validates, upstream, verify_certificate, www, indication, sni, server_name, password1, key_pass_env_var, effect, passphrase, unlock, encrypted, key_pass, private, identity, require, archive, certificate_authority, ca_file, declare, during, negotiation, prioritized, sets, alpn_protocols, similar, convention, proxies, configure, making, against, entire, substring, matching, listen, receiving, confirms, alive, ignored, established, wait, standard, control, expectation, times, sending, waiting, reply, initial, upon, varint, compatible, encoding, unsigned, bit, integer, chosen, underlying, boundaries, split, segments, length_field_offset, representing, length_field_length, little, length_field_is_big_endian, fully, drops, timed, float, timeout_secs, incomplete, starts, dropping, ensuring, bounded, grow, pending_messages_limit, takes, account, excluded, calculation, concatenation, chunk, payloads, composed, applies, whole, individual, single, longer, decompress, none, detect, magic, delimits, ascii_char, est5edt, america, new_york, apply, conversions, explicit, indicate, database, execute, final, contents, target, compilation, abort, trying, duplicate, removed, preserving, tries, signals, allows, optimize, know, attempting, first, attempt, parsing, signal_types, working, needs, converted, interfacing, naming, conventions, their, job_description, jobdescription, camelcase, snake_case, use_json_names, serializing, message_type, buf, images, work, protoc, desc, desc_file, closely, follows, treat, violations, allowing, accept, don, follow, skips, checks, configures, passes, them, old, includes, structured, 5424, 3164, handles, three, detects, decoded, buffers, line, forward, implementation, means, relax, enforcement, codecs, maintained, much, actual, receiver, adheres, exception, some, characters, datum, strip, prefix, described, confluent, strip_schema_id_prefix, record, timemillis, fixed, duration, decimal, date, definition, variants, apache_avro, encoder, connecting, custom_prefix, auth_header_value, inserted, headers, oauth2, jwt, etc, concatenated, base64, signing, temporary, session_token, indexer, principal, autogenerated, provider, 1736428351340, identifier, your, assumed, rolesessionname, session_name, wjalrxutnfemi, k7mdeng, bpxrficyexamplekey, secret, secret_access_key, west, itself, sts, develop, select, chain, successfully, loading, load_timeout_secs, read, read_timeout_seconds, retries, fetching, tokens, max_attempts, connect_timeout_seconds, authenticating, randomexampleidstring, conjunction, external_id, credentials_file, 123456789098, my_role, akiaiosfodnn7example, access_key_id, toml, yaml, advanced, minimal, configurations, view, egress, delivery, best, effort, status, beta, versioning, meta, glossary, cli, secrets, template, syntax, unit, tests, webhdfs, exporter, postgres, papertrail, relic, mezmo, logdna, keep, honeycomb, chronicle, unstructured, elasticsearch, doris, databricks, zerobus, databend, console, clickhouse, blackhole, monitor, ingestion, blob, axiom, sns, streams, appsignal, window, trace, throttle, tag, cardinality, sample, reduce, lua, incremental, exclusive, delay, dedupe, ec2, aggregate, stdin, static, scrape, pushgateway, postgresql, okta, nginx, mongodb, logstash, journald, heroku, logplex, fluent, exec, eventstoredb, dnstap, demo, ecs, expressions, functions, pgo, optimization, validating, management, guarantees, adaptive, buffering, runtime, sizing, capacity, planning, rollout, high, availability, hardening, architecting, unified, 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,

Text of the page (random words):
ing with data that needs to be converted to json or when interfacing with systems that use json naming conventions default false decoding signal_types optional string signal types to attempt parsing in priority order the deserializer tries to parse signals in the specified order this allows you to optimize performance when you know the expected signal types for example if you only receive traces set this to traces to avoid attempting to parse as logs or metrics first if not specified defaults to trying all types in this order logs metrics traces duplicate signal types are automatically removed while preserving order relevant when codec otlp default logs metrics traces decoding syslog optional object syslog specific decoding options relevant when codec syslog decoding syslog lossy optional bool determines whether to replace invalid utf 8 sequences instead of failing when true invalid utf 8 sequences are replaced with the u fffd replacement character default true decoding vrl required object vrl specific decoding options relevant when codec vrl decoding vrl source required string literal the vector remap language vrl program to execute for each event the final contents of the target are used as the decoding result compilation errors or use of abort in the program result in a decoding error decoding vrl timezone optional string literal the name of the timezone to apply to timestamp conversions that do not contain an explicit time zone the time zone name may be any name in the tz database or local to indicate system local time if not set local is used examples local america new_york est5edt framing optional object framing to use in the decoding framing character_delimited required object options for the character delimited decoder relevant when method character_delimited framing character_delimited delimiter required ascii_char the character that delimits byte sequences framing character_delimited max_length optional uint the maximum length of the byte buffer this length does not include the trailing delimiter by default no maximum length is enforced if events are malformed this can lead to additional resource usage as events continue to be buffered in memory and can potentially lead to memory exhaustion in extreme cases if there is a risk of processing malformed data such as logs with user controlled input consider setting the maximum length to a reasonably large value as a safety net this prevents processing from being unbounded framing chunked_gelf optional object options for the chunked gelf decoder relevant when method chunked_gelf framing chunked_gelf decompression optional string literal enum decompression configuration for gelf messages enum options option description auto automatically detect the decompression method based on the magic bytes of the message gzip use gzip decompression none do not decompress the message zlib use zlib decompression default auto framing chunked_gelf max_length optional uint the maximum length of a single gelf message in bytes messages longer than this length are dropped if this option is not set the decoder does not limit the length of messages and the per message memory is unbounded note a message can be composed of multiple chunks and this limit applies to the whole message not to individual chunks this limit takes into account only the message payload gelf header bytes are excluded from the calculation the message payload is the concatenation of all chunk payloads framing chunked_gelf pending_messages_limit optional uint the maximum number of pending incomplete messages if this limit is reached the decoder starts dropping chunks of new messages ensuring the memory usage of the decoder s state is bounded if this option is not set the decoder does not limit the number of pending messages and the memory usage of its messages buffer can grow unbounded this matches graylog server s behavior framing chunked_gelf timeout_secs optional float the timeout in seconds for a message to be fully received if the timeout is reached the decoder drops all received chunks for the timed out message default 5 framing length_delimited required object options for the length delimited decoder relevant when method length_delimited framing length_delimited length_field_is_big_endian optional bool length field byte order little or big endian default true framing length_delimited length_field_length optional uint number of bytes representing the field length default 4 framing length_delimited length_field_offset optional uint number of bytes in the header before the length field framing length_delimited max_frame_length optional uint maximum frame length default 8 388608e 06 framing max_frame_length optional uint maximum frame length relevant when method varint_length_delimited default 8 388608e 06 framing method optional string literal enum the framing method enum options option description bytes byte frames are passed through as is according to the underlying i o boundaries for example split between messages or stream segments character_delimited byte frames which are delimited by a chosen character chunked_gelf byte frames which are chunked gelf messages length_delimited byte frames which are prefixed by an unsigned big endian 32 bit integer indicating the length newline_delimited byte frames which are delimited by a newline character octet_counting byte frames according to the octet counting format varint_length_delimited byte frames which are prefixed by a varint indicating the length this is compatible with protobuf s length delimited encoding default bytes framing newline_delimited optional object options for the newline delimited decoder relevant when method newline_delimited framing newline_delimited max_length optional uint the maximum length of the byte buffer this length does not include the trailing delimiter by default no maximum length is enforced if events are malformed this can lead to additional resource usage as events continue to be buffered in memory and can potentially lead to memory exhaustion in extreme cases if there is a risk of processing malformed data such as logs with user controlled input consider setting the maximum length to a reasonably large value as a safety net this prevents processing from being unbounded framing octet_counting optional object options for the octet counting decoder relevant when method octet_counting framing octet_counting max_length optional uint the maximum length of the byte buffer initial_message optional string literal an optional message to send to the server upon connection examples subscribe logs initial_message_timeout_secs optional uint number of seconds before timing out while waiting for a reply to the initial message this is only used when initial_message is also configured examples 5 default 2 seconds 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_message optional string literal an optional application level ping message to send over the websocket connection if not set a standard websocket ping control frame is sent instead 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 pong_message optional object string literal the expected application level pong message to listen for as a response to a custom ping_message this is only used when ping_message is also configured when a custom ping is sent receiving this specific message confirms that the connection is still alive pong_message type required string literal enum the matching strategy to use for the pong message enum options option description contains the message must contain the value as a substring exact the entire message must be an exact match examples contains exact pong_message value required string literal the string value to match against proxy optional object proxy configuration configure to proxy traffic through an http s proxy when making external requests similar to common proxy configuration convention you can set different proxies to use based on the type of traffic being proxied you can also set specific hosts that should not be proxied proxy enabled optional bool enables proxying support default true proxy http optional string literal proxy endpoint to use when proxying http traffic must be a valid uri string examples http foo bar 3128 proxy https optional string literal proxy endpoint to use when proxying https traffic must be a valid uri string examples http foo bar 3128 proxy no_proxy optional string a list of hosts to avoid proxying multiple patterns are allowed pattern example match domain names example com matches requests to example com wildcard domains example com matches requests to example com and its subdomains ip addresses 127 0 0 1 matches requests to 127 0 0 1 cidr blocks 192 168 0 0 16 matches requests to any ip addresses in this range splat matches all hosts tls optional object tls configuration tls alpn_protocols optional string sets the list of supported alpn protocols declare the supported alpn protocols which are used during negotiation with a peer they are prioritized in the order that they are defined tls ca_file optional string literal absolute path to an additional ca certificate file the certificate must be in the der or pem x 509 format additionally the certificate can be provided as an inline string in pem format examples path to certificate_authority crt tls crt_file optional string literal absolute path to a certificate file used to identify this server the certificate must be in der pem x 509 or pkcs 12 format additionally the certificate can be provided as an inline string in pem format if this is set and is not a pkcs 12 archive key_file must also be set examples path to host_certificate crt tls enabled optional bool whether to require tls for incoming or outgoing connections when enabled and used for incoming connections an identity certificate is also required see tls crt_file for more information tls key_file optional string literal absolute path to a private key file used to identify this server the key must be in der or pem pkcs 8 format additionally the key can be provided as an inline string in pem format examples path to host_certificate key tls key_pass optional string literal passphrase used to unlock the encrypted key file this has no effect unless key_file is set examples key_pass_env_var password1 tls server_name optional string literal server name to use when using server name indication sni only relevant for outgoing connections examples www example com tls verify_certificate optional bool enables certificate verification for components that create a server this requires that the client connections have a valid client certificate for components that initiate requests this validates that the upstream has a valid certificate if enabled certificates must not be expired and must be issued by a trusted issuer this verification operates in a hierarchical manner checking that the leaf certificate the certificate presented by the client server is not only valid but that the issuer of that certificate is also valid and so on until the verification process reaches a root certificate do not set this to false unless you understand the risks of not verifying the validity of certificates tls verify_hostname optional bool enables hostname verification if enabled the hostname used to connect to the remote host must be present in the tls certificate presented by the remote host either as the common name or as an entry in the subject alternative name extension only relevant for outgoing connections do not set this to false unless you understand the risks of not verifying the remote hostname uri required string literal the websocket uri to connect to this should include the protocol and host but can also include the port path and any other valid part of a uri note using the wss protocol requires enabling tls examples ws localhost 8080 wss example com socket environment variables https_proxy common optional string literal the global url to proxy https requests through if another https proxy is set in the configuration file or at a component level this one will be overridden the lowercase variant has priority over the uppercase one examples http foo bar 3128 http_proxy common optional string literal the global url to proxy http requests through if another http proxy is set in the configuration file or at a component level this one will be overridden the lowercase variant has priority over the uppercase one examples http foo bar 3128 no_proxy common optional string literal list of hosts to avoid proxying globally allowed patterns here include pattern example match domain names example com matches requests to example com wildcard domains example come matches requests to example com and its subdomains ip addresses 127 0 0 1 matches requests to 127 0 0 1 cidr blocks 192 168 0 0 16 matches requests to any ip addresses in this range splat matches all hosts if another no_proxy value is set in the configuration file or at a component level this one is overridden the lowercase variant has priority over the uppercase one examples localhost example com 192 168 0 0 16 http_proxy common optional string literal the global url to proxy http requests through if another http proxy is set in the configuration file or at a component level this one will be overridden the lowercase variant has priority over the uppercase one examples http foo bar 3128 https_proxy common optional string literal the global url to proxy https requests through if another https proxy is set in the configuration file or at a component level this one will be overridden the lowercase variant has priority over the uppercase one examples http foo bar 3128 no_proxy common optional string literal list of hosts to avoid proxying globally allowed patterns here include pattern example match domain names example com matches requests to example com wildcard domains example come matches requests to example com and its subdomains ip addresses 127 0 0 1 matches requests to 127 0 0 1 cidr blocks 192 168 0 0 16 matches requests to any ip addresses in this range splat matches all hosts if another no_proxy value is set in the configuration file or at a component level this one is overridden the lowercase variant has priority over the uppercase one examples localhost example com 192 168 0 0 16 outputs component_id default output stream of the component use this component s id as an input to downstream transforms and sinks output types logs warning the fields shown below will be different if log namespacing is enabled see log namespacing for more details event an event r...