Meta tags:
description= Deliver observability event data to an MQTT broker;
keywords= mqtt,component,sink;
Headings (most frequently used words):
encoding, tls, cef, csv, syslog, buffer, protobuf, enabled, acknowledgements, healthcheck, avro, gelf, json, extensions, severity, deprecated, mqtt, configuration, input, types, telemetry, how, it, works, vector, site, footer, example, configurations, clean_session, client_id, dangerously_allow_unconfined_template_resolution, host, inputs, keep_alive, max_packet_size, password, port, quality_of_service, retain, topic, user, logs, metrics, state, transport, layer, security, about, components, setup, community, download, max_events, max_size, type, when_full, codec, except_fields, metric_tag_values, only_fields, timestamp_format, 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_bytes_total, buffer_received_events_total, buffer_sent_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_shutdown_total, open_connections, utilization, 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,
Text of the page (most frequently used words):
the (432), optional (117), #vector (116), component (72), this (63), for (54), encoding (53), string (49), buffer (41), that (40), event (40), type (36), literal (36), are (33), data (32), host (31), when (31), from (29), which (28), mqtt (27), events (26), default (26), and (25), hostname (24), use (23), required (23), field (23), file (22), number (22), process (21), instance (20), pid (20), system (20), running (20), stage (20), csv (20), cef (20), tls (19), path (19), metrics (19), options (18), component_type (18), kind (18), component_kind (18), component_id (18), name (18), originated (18), logs (18), codec (18), enum (18), bytes (16), log (16), used (15), must (15), certificate (15), format (15), syslog (15), can (14), value (14), not (14), object (14), json (14), counter (13), aws (13), unique (13), examples (13), timestamp (13), protobuf (13), message (13), gelf (13), configuration (12), with (12), transform (12), identifier (12), example (12), sinks (11), pipeline (11), set (11), relevant (11), enabled (11), bool (11), server (11), source (11), fields (11), output (10), within (10), more (10), description (10), option (10), encodes (10), acknowledgements (10), you (9), than (9), sink (9), false (9), numbered (9), buffer_id (9), supported (9), values (9), quotes (9), uri (8), mode (8), metric (8), com (8), avro (8), device (8), end (8), all (7), has (7), types (7), key (7), uint (7), inputs (7), less (7), datadog (6), components (6), gauge (6), connections (6), will (6), only (6), internal (6), also (6), pem (6), they (6), atleastonce (6), represent (6), unix (6), serializer (6), necessary (6), writing (6), empty (6), any (6), prometheus (6), model (6), my_sink_id (6), gcp (6), github (5), uses (5), behavior (5), defaults (5), input (5), how (5), connection (5), been (5), were (5), sent (5), absolute (5), either (5), like (5), true (5), currently (5), template (5), remote (5), client (5), valid (5), using (5), whether (5), port (5), instead (5), encoded (5), otlp (5), version (5), length (5), equal (5), product (5), vendor (5), memory (5), disk (5), chat (4), due (4), openssl (4), each (4), every (4), total (4), protocol (4), http (4), origins (4), error (4), deprecated (4), enables (4), allowed (4), verification (4), but (4), provided (4), list (4), quality_of_service (4), maximum (4), max_packet_size (4), keep_alive (4), rfc (4), severity (4), names (4), single (4), tags (4), full (4), text (4), controls (4), 8192 (4), quote (4), record (4), native (4), remap (4), reference (4), specification (4), identifies (4), docs (4), architecture (4), rss (3), releases (3), download (3), going (3), sources (3), nats (3), formerly (3), updates (3), protocols (3), security (3), never (3), open (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), other (3), level (3), intentionally (3), filter (3), dropped (3), non (3), unless (3), outgoing (3), extension (3), have (3), key_file (3), der (3), pkcs (3), additionally (3), inline (3), see (3), information (3), additional (3), order (3), 1883 (3), 10240 (3), size (3), keep (3), healthcheck (3), point (3), rfc5424 (3), encoder (3), tag (3), exposed (3), strings (3), same (3), graylog (3), puts (3), around (3), means (3), even (3), delimiter (3), character (3), ascii_char (3), configures (3), escape (3), capacity (3), logfmt (3), while (3), opentelemetry (3), experimental (3), apache (3), points (3), extensions (3), keys (3), combination (3), schema (3), confinement (3), write (3), lost (3), buffering (3), observability (3), websocket (3), splunk (3), hec (3), azure (3), kinesis (3), administration (2), deployment (2), installation (2), setup (2), transforms (2), about (2), mezmo (2), logdna (2), content (2), new (2), via (2), specified (2), environment (2), stateless (2), across (2), state (2), would (2), indicate (2), idle (2), waiting (2), down (2), emitted (2), region (2), may (2), destination (2), endpoint (2), raw (2), accepted (2), tagged (2), cumulatively (2), note (2), separate (2), useful (2), performance (2), issues (2), histogram (2), topology (2), errors (2), discarded (2), intentional (2), buffer_size_events (2), buffer_size_bytes (2), received (2), favor (2), telemetry (2), following (2), user (2), supports (2), syntax (2), topic (2), templates (2), understand (2), risks (2), verifying (2), connect (2), present (2), presented (2), common (2), certificates (2), issuer (2), upstream (2), host_certificate (2), identify (2), incoming (2), crt_file (2), crt (2), 509 (2), alpn (2), defined (2), sets (2), messages (2), should (2), exactlyonce (2), atmostonce (2), service (2), password (2), prefix (2), array (2), address (2), broker (2), starts (2), rfc3164 (2), formatting (2), facility (2), checks (2), systems (2), proto (2), package (2), desc (2), descriptor (2), before (2), last (2), null (2), ignored (2), pretty (2), target (2), 500 (2), recommended (2), strictly (2), always (2), well (2), disabled (2), escaped (2), them (2), disable (2), raw_message (2), native_json (2), careful (2), modifying (2), your (2), removing (2), doing (2), parsing (2), could (2), lead (2), emitting (2), given (2), sdk (2), such (2), loki (2), spec (2), pairs (2), paths (2), part (2), two (2), products (2), traces (2), runtime (2), disables (2), static (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), global (2), connected (2), handled (2), home (2), api (2), statsd (2), socket (2), sematext (2), redis (2), pulsar (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, works, ratio, load, completely, simply, updated, seconds, utilization, current, open_connections, times, shut, connection_shutdown_total, component_sent_events_total, component_sent_event_bytes_total, send, excluding, query, component_sent_bytes_total, component_received_events_total, batching, mostly, low, debugging, small, batches, passed, batch, component_received_events_count, component_received_event_bytes_total, occurred, error_type, encountered, component_errors_total, component_discarded_events_total, buffer_sent_events_total, buffer_sent_bytes_total, buffer_received_events_total, buffer_received_bytes_total, buffer_events, blocking, buffer_discarded_events_total, buffer_byte_size, link, table, lists, possible, aware, available, differ, based, username, parameter, dynamic, per, publish, entry, subject, alternative, verify_hostname, validity, expired, issued, trusted, operates, hierarchical, manner, checking, leaf, until, reaches, root, create, requires, initiate, requests, validates, 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, peer, prioritized, alpn_protocols, retained, retain, quality, tcp, packet, alive, interval, info, wildcards, ids, 127, domain, check, health, 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, etc, protobuf_descriptor_set, read, here, protoc, include, desc_file, included, only_fields, config, multiple, show, assigned, arrays, bare, displayed, assignments, metric_tag_values, jsonserializer, chunked, datagram, including, byte, header, 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, sending, compatible, endpoints, application, buffers, forward, implementation, might, continue, relax, enforcement, codecs, maintained, much, relaxed, strict, actual, receiver, adheres, exception, characters, reason, configured, encode, formatted, lowest_importance, highest_importance, reflects, importance, human, readable, 512, equals, collection, problem, make, sends, device_version, device_vendor, device_product, reported, 1023, device_event_class_id, into, selected, determines, bypasses, both, startup, validation, templated, producer, arbitrary, routing, destinations, flag, opt, out, usable, dangerous, control, dangerously_allow_unconfined_template_resolution, client_id, session, cleaned, login, clean_session, typically, highest, priority, preferable, temporarily, lose, rather, cause, slowdown, drops, drop_newest, applies, backpressure, signalling, slow, pile, edge, wait, handling, when_full, 500ms, then, least, 256, megabytes, 268435488, amount, allocated, hold, max_size, max_events, individual, found, section, enabling, disabling, takes, precedence, over, waits, acknowledged, acknowledging, acknowledgement, 1_883, 10_240, toml, yaml, advanced, minimal, view, egress, stream, yes, delivery, best, effort, status, beta, deliver, versioning, meta, glossary, variables, cli, secrets, unit, tests, webhdfs, exporter, postgres, papertrail, relic, honeycomb, chronicle, unstructured, elasticsearch, doris, databricks, zerobus, databend, console, clickhouse, blackhole, monitor, ingestion, blob, axiom, sns, streams, appsignal, window, trace, throttle, cardinality, limit, sample, reduce, lua, incremental, exclusive, delay, dedupe, ec2, metadata, aggregate, vrl, stdin, 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, 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):
roduct 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 host required string literal mqtt server address the broker s domain name or ip address examples mqtt example com 127 0 0 1 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 keep_alive optional uint connection keep alive interval default 60 max_packet_size optional uint maximum packet size default 10240 password optional string literal mqtt password port optional uint tcp port of the mqtt server to connect to default 1883 quality_of_service optional string literal enum supported quality of service types for mqtt enum options string literal option description atleastonce atleastonce atmostonce atmostonce exactlyonce exactlyonce default atleastonce retain optional bool whether the messages should be retained by the server default false 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 topic required string template mqtt publish topic templates allowed note this parameter supports vector s template syntax which enables you to use dynamic per event values user optional string literal mqtt username input types the following table lists all telemetry data types supported by the component across possible configurations be aware that the available data types may differ based on the specified codec configuration logs log events are supported telemetry metrics link buffer_byte_size gauge the number of bytes currently in the buffer deprecated this metric has been deprecated in favor of buffer_size_bytes buffer_id the unique identifier of the buffer component_id the vector component id component_kind the vector component kind component_type the vector component type host optional the hostname of the system vector is running on pid optional the process id of the vector instance stage the numbered stage within the buffer pipeline buffer_discarded_events_total counter the number of events dropped by this non blocking buffer buffer_id the unique identifier of the buffer component_id the vector component id component_kind the vector component kind component_type the vector component type host optional the hostname of the system vector is running on intentional true if the events were discarded intentionally like a filter transform or false if due to an error pid optional the process id of the vector instance stage the numbered stage within the buffer pipeline buffer_events gauge the number of events currently in the buffer deprecated this metric has been deprecated in favor of ...
|
