Meta tags:
description=Aggregate metrics passing through a topology;
keywords=aggregate,component,transform;

Headings (most frequently used words):

graph, metrics, edge_attributes, aggregate, types, node_attributes, deprecated, configuration, input, outputs, output, telemetry, examples, how, it, works, vector, site, footer, example, configurations, inputs, interval_ms, mode, component_id, over, seconds, advantages, of, use, aggregation, behavior, state, about, components, setup, community, download, aggregate_events_recorded_total, aggregate_failed_updates, aggregate_flushes_total, component_discarded_events_total, component_errors_total, component_latency_mean_seconds, component_latency_seconds, component_received_event_bytes_total, component_received_events_count, component_received_events_total, component_sent_event_bytes_total, component_sent_events_total, transform_buffer_max_byte_size, transform_buffer_max_event_size, transform_buffer_max_size_bytes, transform_buffer_max_size_events, transform_buffer_utilization, transform_buffer_utilization_level, transform_buffer_utilization_mean, utilization,

Text of the page (most frequently used words):
the (272), #vector (106), component (84), optional (75), metrics (43), host (37), #transform (30), type (29), this (27), kind (27), counter (25), from (25), metric (24), data (23), value (22), output (22), and (21), incremental (21), process (21), instance (20), pid (20), hostname (20), system (20), running (20), aggregate (19), component_id (19), which (19), component_type (18), component_kind (18), originated (18), absolute (17), that (16), name (16), events (15), logs (15), transforms (14), gauge (14), number (14), aws (13), graph (13), inputs (12), source (12), mode (12), for (11), file (11), event (10), configuration (9), with (9), into (9), tags (9), my_transform_id (9), specific (9), buffer (9), time (9), are (8), single (8), 2021 (8), 12t07 (8), 223543z (8), timestamp (8), com (8), input (8), uri (8), through (8), interval_ms (7), feeds (7), pass (7), unchanged (7), datadog (6), histogram (6), examples (6), string (6), node (6), edge (6), gcp (6), github (5), latest (5), based (5), example (5), types (5), may (5), required (5), level (5), internal (5), auto (5), literal (5), prometheus (5), log (5), model (5), chat (4), sinks (4), components (4), updates (4), state (4), volume (4), would (4), like (4), reduce (4), seconds (4), utilization (4), mean (4), maximum (4), can (4), hold (4), bytes (4), deprecated (4), origins (4), spent (4), default (4), language (4), object (4), docs (4), architecture (4), rss (3), releases (3), download (3), remap (3), behavior (3), between (3), aggregated (3), during (3), interval (3), added (3), less (3), values (3), aggregation (3), use (3), over (3), total (3), sanitized (3), pod (3), pod_name (3), pathname (3), peer_path (3), peer_addr (3), connection (3), used (3), container (3), container_name (3), error (3), supported (3), 10000 (3), width (3), red (3), color (3), graphviz (3), dot (3), attributes (3), edge_attributes (3), reference (3), websocket (3), splunk (3), hec (3), http (3), azure (3), kinesis (3), all (2), going (2), administration (2), deployment (2), installation (2), setup (2), sources (2), ec2 (2), metadata (2), vrl (2), previous (2), receive (2), new (2), stateful (2), across (2), restarts (2), their (2), same (2), series (2), reduction (2), granularity (2), two (2), more (2), summary (2), set (2), distribution (2), systems (2), processing (2), downstream (2), different (2), 5000 (2), json (2), toml (2), yaml (2), indicate (2), idle (2), smoothed (2), using (2), exponentially (2), weighted (2), moving (2), average (2), ewma (2), transform_buffer_max_size_events (2), transform_buffer_max_size_bytes (2), has (2), been (2), favor (2), emitted (2), accepted (2), either (2), tagged (2), cumulatively (2), other (2), issues (2), due (2), topology (2), includes (2), both (2), queued (2), executing (2), itself (2), elapsed (2), fractional (2), spends (2), stage (2), errors (2), encountered (2), filter (2), flushes (2), telemetry (2), stream (2), following (2), configurations (2), sums (2), stdev (2), min (2), max (2), returns (2), enum (2), options (2), some (2), functions (2), only (2), function (2), attribute (2), node_attributes (2), they (2), provided (2), add (2), resulting (2), label (2), window (2), open (2), home (2), api (2), pipeline (2), server (2), statsd (2), socket (2), sematext (2), redis (2), pulsar (2), remote (2), write (2), opentelemetry (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), end (2), concurrency (2), linux (2), observability (2), pipelines (2), support (2), blog (2), guides (2), sidebar, 2026, inc, rights, reserved, community, prod, cookies, privacy, team, contact, about, site, footer, next, thank, you, joining, our, newsletter, sign, emails, content, page, meaning, its, changes, not, preserved, therefore, dependent, will, reset, depend, received, since, most, recent, restart, newer, replace, older, ones, results, while, maintaining, numerical, correctness, processed, period, result, complex, behave, similarly, being, combined, manner, makes, sense, major, advantage, costs, directly, situations, charge, indirectly, requiring, cpu, network, bandwidth, transmit, constrained, ingest, help, overhead, apply, well, advantages, how, works, produced, 5_000, given, ratio, load, completely, simply, waiting, never, updated, every, transform_buffer_utilization_mean, current, transform_buffer_utilization_level, transform_buffer_utilization, transform_buffer_max_event_size, transform_buffer_max_byte_size, component_sent_events_total, component_sent_event_bytes_total, component_received_events_total, note, separate, than, sink, batching, mostly, useful, low, debugging, performance, small, batches, passed, each, batch, component_received_events_count, component_received_event_bytes_total, component_latency_seconds, component_latency_mean_seconds, within, occurred, error_type, component_errors_total, true, were, discarded, intentionally, false, intentional, dropped, component_discarded_events_total, done, aggregate_flushes_total, failed, adds, aggregate_failed_updates, recorded, aggregate_events_recorded_total, link, modified, outputs, table, lists, possible, aware, available, differ, specified, codec, sum, difference, diff, counts, count, uses, description, option, frame, beta, namespace, milliseconds, uint, prefix, array, see, info, wildcards, list, upstream, ids, example_input, collection, related, edges, linked, configure, when, generated, command, extra, 10_000, advanced, minimal, aggregates, multiple, defined, helps, cost, view, egress, status, stable, passing, versioning, security, meta, glossary, environment, variables, cli, secrets, template, syntax, schema, unit, tests, tls, global, webhdfs, exporter, postgres, papertrail, relic, mezmo, logdna, loki, keep, honeycomb, chronicle, unstructured, elasticsearch, doris, traces, databricks, zerobus, databend, console, clickhouse, blackhole, monitor, ingestion, blob, axiom, sns, streams, appsignal, trace, throttle, tag, cardinality, limit, sample, lua, exclusive, delay, dedupe, syslog, stdin, static, scrape, pushgateway, postgresql, okta, nginx, mongodb, logstash, journald, client, heroku, logplex, fluent, descriptor, exec, eventstoredb, dnstap, demo, ecs, apache, expressions, pgo, optimization, validating, management, acknowledgements, guarantees, adaptive, buffering, runtime, sizing, capacity, 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, package, managers, quickstart, concepts, introduction, navbar, dropdown, menu, search, toggle, dark, documentation,

Text of the page (random words):
ollection of graph edge attributes in graphviz dot language related to a single input component graph edge_attributes required string literal a single graph edge attribute in graphviz dot language examples color red label example edge width 5 0 examples example_input color red label example edge width 5 0 graph node_attributes optional object node attributes to add to this component s node in resulting graph they are added to the node as provided graph node_attributes required string literal a single graph node attribute in graphviz dot language examples color red name example node width 5 0 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 interval_ms optional uint the interval between flushes in milliseconds during this time frame metrics beta with the same series data name namespace tags and so on are aggregated default 10000 mode optional string literal enum function to use for aggregation some of the functions may only function on incremental and some only on absolute metrics enum options string literal option description auto default mode sums incremental metrics and uses the latest value for absolute metrics count counts metrics for incremental and absolute metrics diff returns difference between latest value for absolute incremental metrics pass through unchanged latest returns the latest value for absolute metrics incremental metrics pass through unchanged max max value of absolute metric incremental metrics pass through unchanged mean mean value of absolute metric incremental metrics pass through unchanged min min value of absolute metric incremental metrics pass through unchanged stdev stdev value of absolute metric incremental metrics pass through unchanged sum sums incremental metrics absolute metrics pass through unchanged default auto 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 metrics the following metrics are supported counter distribution gauge histogram set summary outputs component_id default output stream of the component use this component s id as an input to downstream transforms and sinks output types metrics the modified input metric event telemetry metrics link aggregate_events_recorded_total counter the number of events recorded by the aggregate transform 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 aggregate_failed_updates counter the number of failed metric updates incremental adds encountered by the aggregate transform 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 aggregate_flushes_total counter the number of flushes done by the aggregate transform 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 component_discarded_events_total counter the number of events dropped by this component 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 component_errors_total counter the total number of errors encountered by this component component_id the vector component id component_kind the vector component kind component_type the vector component type error_type the type of the error host optional the hostname of the system vector is running on pid optional the process id of the vector instance stage the stage within the component at which the error occurred component_latency_mean_seconds gauge the mean elapsed time in fractional seconds that an event spends in a single transform this includes both the time spent queued in the transform s input buffer and the time spent executing the transform itself this value is smoothed over time using an exponentially weighted moving average ewma host optional the hostname of the system vector is running on pid optional the process id of the vector instance component_latency_seconds histogram the elapsed time in fractional seconds that an event spends in a single transform this includes both the time spent queued in the transform s input buffer and the time spent executing the transform itself host optional the hostname of the system vector is running on pid optional the process id of the vector instance component_received_event_bytes_total counter the number of event bytes accepted by this component either from tagged origins like file and uri or cumulatively from other origins component_id the vector component id component_kind the vector component kind component_type the vector component type container_name optional the name of the container from which the data originated file optional the file from which the data originated host optional the hostname of the system vector is running on mode optional the connection mode used by the component peer_addr optional the ip from which the data originated peer_path optional the pathname from which the data originated pid optional the process id of the vector instance pod_name optional the name of the pod from which the data originated uri optional the sanitized uri from which the data originated component_received_events_count histogram a histogram of the number of events passed in each internal batch in vector s internal topology note that this is separate than sink level batching it is mostly useful for low level debugging performance issues in vector due to small internal batches component_id the vector component id component_kind the vector component kind component_type the vector component type container_name optional the name of the container from which the data originated file optional the file from which the data originated host optional the hostname of the system vector is running on mode optional the connection mode used by the component peer_addr optional the ip from which the data originated peer_path optional the pathname from which the data originated pid optional the process id of the vector instance pod_name optional the name of the pod from which the data originated uri optional the sanitized uri from which the data originated component_received_events_total counter the number of events accepted by this component either from tagged origins like file and uri or cumulatively from other origins component_id the vector component id component_kind the vector component kind component_type the vector component type container_name optional the name of the container from which the data originated file optional the file from which the data originated host optional the hostname of the system vector is running on mode optional the connection mode used by the component peer_addr optional the ip from which the data originated peer_path optional the pathname from which the data originated pid optional the process id of the vector instance pod_name optional the name of the pod from which the data originated uri optional the sanitized uri from which the data originated component_sent_event_bytes_total counter the total number of event bytes emitted by this component 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 output optional the specific output of the component pid optional the process id of the vector instance component_sent_events_total counter the total number of events emitted by this component 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_max_byte_size gauge the maximum number of bytes the buffer that feeds into a transform can hold deprecated this metric has been deprecated in favor of transform_buffer_max_size_bytes 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_max_event_size gauge the maximum number of events the buffer that feeds into a transform can hold deprecated this metric has been deprecated in favor of transform_buffer_max_size_events 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_max_size_bytes gauge the maximum number of bytes the buffer that feeds into a transform can hold 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_max_size_events gauge the maximum number of events the buffer that feeds into a transform can hold 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_utilization histogram the utilization level of the buffer that feeds into a transform 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_utilization_level gauge the current utilization level of the buffer that feeds into a transform 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 output optional the specific output of the component pid optional the process id of the vector instance transform_buffer_utilization_mean gauge the mean utilization level of the buffer that feeds into a transform this value is smoothed over time using an exponentially weighted moving average ewma 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 output optional the specific output of the component pid optional the process id of the vector instance utilization gauge a ratio from 0 to 1 of the load on a component a value of 0 would indicate a completely idle component that is simply waiting for input a value of 1 would indicate a that is never idle this value is updated every 5 seconds 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 examples aggregate over 5 seconds given this event metric counter value 1 1 kind incremental name counter 1 tags host my host com timestamp 2021 07 12t07 58 44 223543z metric counter value 2 2 kind incremental name counter 1 tags host my host com timestamp 2021 07 12t07 58 45 223543z metric counter value 1 1 kind incremental name counter 1 tags host different host com timestamp 2021 07 12t07 58 45 223543z metric counter value 22 33 kind absolute name gauge 1 tags host my host com timestamp 2021 07 12t07 58 47 223543z metric counter value 44 55 kind absolute name gauge 1 tags host my host com timestamp 2021 07 12t07 58 45 223543z and this configuration yaml toml json transforms my_transform_id type aggregate inputs my source or transform id interval_ms 5000 transforms my_transform_id type aggregate inputs my source or transform id interval_ms 5_000 transforms my_transform_id type aggregate inputs my source or transform id interval_ms 5000 this vector event is produced metric counter value 3 3 kind incremental name counter 1 tags host my host com timestamp 2021 07 12t07 58 45 223543z metric counter value 1 1 kind incremental name counter 1 tags host different host com timestamp 2021 07 12t07 58 45 223543z metric counter value 44 55 kind absolute name gauge 1 tags host my host com timestamp 2021 07 12t07 58 45 223543z how it works advantages of use the major advantage to aggregation is the reduction of volume it may reduce costs directly in situations that charge by metric event volume or indirectly by requiring less cpu to process and or less network bandwidth to transmit and receive in systems that are constrained by the processing required to ingest metric events it may help to reduce the processing overhead this may apply to transforms and sinks downstream of the aggregate transform as well aggregation behavior metrics are aggregated based on their kind during an interval incremental metrics are added and newer absolute metrics replace older ones in the same series this results in a reduction of volume and less granularity while maintaining numerical correctness as an example two incremental counter metrics with values 10 and 13 processed by the transform during a period would be aggregated into a single incremental counter with a value of 23 two absolute gauge metrics with values 93 and 95 would result in a single absolute gauge with the value of 95 more complex types like distribution histogram set and summary behave similarly with incremental values being combined in a manner that makes sense based on their type state this component is stateful meaning its behavior changes based on previous inputs events state is not preserved across restarts therefore state dependent behavior will reset between restarts and depend on the inputs events received since the most recent restart on this page sign up to receive emails on the latest vector content and new releases thank you for joining our updates newsletter previous remap with vrl next ...