Meta tags:
description= Collect logs from Heroku’s Logplex, the router responsible for receiving logs from your Heroku apps;
keywords= heroku,logplex,component,source,logs;
Headings (most frequently used words):
decoding, framing, tls, auth, chunked_gelf, length_delimited, lossy, protobuf, max_length, keepalive, deprecated, avro, gelf, vrl, character_delimited, configuration, acknowledgements, enabled, source, influxdb, json, native_json, syslog, max_frame_length, newline_delimited, octet_counting, heroku, logplex, outputs, output, types, telemetry, how, it, works, vector, site, footer, example, configurations, address, query_parameters, component_id, logs, metrics, authorization, context, state, transport, layer, security, about, components, setup, community, download, password, strategy, username, codec, signal_types, method, max_connection_age_jitter_factor, max_connection_age_secs, alpn_protocols, ca_file, crt_file, key_file, key_pass, server_name, verify_certificate, verify_hostname, warning, line, 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, http_server_handler_duration_seconds, http_server_requests_received_total, http_server_responses_sent_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, schema, strip_schema_id_prefix, validation, desc_file, message_type, use_json_names, timezone, delimiter, decompression, pending_messages_limit, timeout_secs, length_field_is_big_endian, length_field_length, length_field_offset, fields,
Text of the page (most frequently used words):
the (468), optional (133), vector (116), #component (84), this (64), from (44), data (38), for (37), which (35), decoding (35), type (33), string (33), when (32), and (31), that (29), are (29), output (27), bytes (27), logs (27), host (25), source (25), literal (25), metrics (24), originated (24), file (23), default (23), hostname (23), message (23), framing (23), options (21), events (21), system (21), examples (21), not (21), length (21), can (20), process (20), component_id (20), name (20), required (20), relevant (20), tls (19), with (19), instance (19), pid (19), running (19), component_type (19), kind (19), component_kind (19), http (19), object (19), gelf (19), buffer (18), number (18), specific (17), maximum (17), path (16), true (15), vrl (15), method (15), log (15), certificate (15), decoder (15), codec (15), format (14), raw (14), byte (14), server (13), used (13), event (13), use (13), json (13), sources (12), mode (12), set (12), bool (12), protobuf (12), aws (12), configuration (11), messages (11), sequences (11), decodes (11), authentication (10), address (10), uri (10), field (10), character (10), uint (10), enum (10), invalid (10), utf (10), heroku_logs (9), custom (9), request (9), counter (9), types (9), must (9), avro (9), acknowledgements (9), has (8), authorization (8), basic (8), outputs (8), enabled (8), more (8), traces (8), influxdb (8), heroku (8), all (7), gcp (7), you (7), local (7), header (7), strategy (7), auth (7), using (7), time (7), level (7), send (7), deprecated (7), error (7), connection (7), only (7), connections (7), whether (7), memory (7), delimited (7), frames (7), length_delimited (7), chunked_gelf (7), option (7), instead (7), syslog (7), datadog (6), components (6), specified (6), errors (6), false (6), example (6), username (6), password (6), how (6), gauge (6), metric (6), pem (6), order (6), value (6), limit (6), end (6), my_source_id (6), logplex (6), github (5), each (5), input (5), additional (5), also (5), client (5), code (5), histogram (5), status (5), total (5), duration (5), origins (5), internal (5), remote (5), key (5), names (5), does (5), character_delimited (5), description (5), decompression (5), replaced (5), fffd (5), replacement (5), determines (5), replace (5), failing (5), lossy (5), otlp (5), strict (5), schema (5), prometheus (5), model (5), chat (4), sinks (4), new (4), uses (4), openssl (4), behavior (4), result (4), any (4), requests (4), supports (4), timestamp (4), utilization (4), hold (4), received (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), note (4), than (4), fields (4), will (4), see (4), outgoing (4), verification (4), valid (4), provided (4), absolute (4), application (4), parameters (4), include (4), query_parameters (4), keepalive (4), octet_counting (4), max_length (4), processing (4), malformed (4), such (4), unbounded (4), lead (4), usage (4), newline_delimited (4), prefixed (4), chunks (4), program (4), signal (4), native_json (4), native (4), validation (4), spec (4), specification (4), style (4), reference (4), kafka (4), docs (4), architecture (4), rss (3), releases (3), download (3), going (3), transforms (3), pubsub (3), updates (3), protocols (3), due (3), via (3), state (3), token (3), parts (3), some (3), table (3), uuid (3), means (3), headers (3), access (3), between (3), seconds (3), favor (3), produced (3), accepted (3), other (3), passed (3), batch (3), stream (3), unless (3), key_file (3), der (3), pkcs (3), additionally (3), inline (3), incoming (3), information (3), supported (3), configures (3), query (3), may (3), large (3), setting (3), being (3), continue (3), delimiter (3), frame (3), graylog (3), automatically (3), encoded (3), remap (3), relaxed (3), opentelemetry (3), protocol (3), experimental (3), apache (3), socket (3), websocket (3), splunk (3), hec (3), azure (3), kinesis (3), administration (2), deployment (2), installation (2), setup (2), receive (2), defaults (2), environment (2), transport (2), security (2), stateless (2), its (2), context (2), return (2), checks (2), reject (2), enrichment (2), let (2), say (2), expect (2), split (2), here (2), multiple (2), was (2), ingested (2), mean (2), source_buffer_max_size_events (2), source_buffer_max_size_bytes (2), been (2), emitted (2), tagged (2), cumulatively (2), sink (2), useful (2), performance (2), issues (2), stage (2), within (2), filter (2), dropped (2), into (2), console (2), extracted (2), erlang (2), individual (2), through (2), line (2), namespacing (2), understand (2), risks (2), verifying (2), presented (2), enables (2), certificates (2), issuer (2), validates (2), effect (2), host_certificate (2), identify (2), crt_file (2), crt (2), 509 (2), alpn (2), they (2), defined (2), list (2), included (2), jitter (2), out (2), max_connection_age_jitter_factor (2), applies (2), before (2), max_connection_age_secs (2), actual (2), float (2), octet (2), counting (2), there (2), risk (2), user (2), controlled (2), consider (2), reasonably (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), timeout (2), reached (2), pending (2), takes (2), payload (2), auto (2), zlib (2), gzip (2), handles (2), where (2), timezone (2), zone (2), language (2), deserializer (2), parse (2), systems (2), proto (2), package (2), descriptor (2), strictly (2), rfc (2), decoded (2), sdk (2), loki (2), following (2), documentation (2), trace (2), boolean (2), acknowledgement (2), handled (2), enabling (2), global (2), open (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), 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), 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, previous, thank, joining, our, newsletter, sign, emails, latest, content, page, maturity, enable, adjust, location, variable, openssl_conf, usr, ssl, cnf, layer, meaning, consistent, across, augments, helpful, keys, get_enrichment_table_record, auth_data, could, then, look, column, else, returning, should, fail, didn, start, heroku_logs_source, currently, provides, greater, flexibility, writing, looks, backed, csv, strategies, defining, connecting, works, difference, recorded, expressed, fractional, source_lag_time_seconds, smoothed, over, 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, responses, sent, http_server_responses_sent_total, http_server_requests_received_total, spent, handling, http_server_handler_duration_seconds, component_sent_events_total, component_sent_event_bytes_total, component_received_events_total, separate, batching, mostly, low, debugging, small, batches, 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, exact, source_type, procid, proc_id, containing, plain, text, equivalent, command, gethostname, app, app_name, post, shown, below, different, details, warning, downstream, connect, present, common, entry, subject, alternative, extension, verify_hostname, validity, expired, issued, trusted, operates, hierarchical, manner, checking, leaf, but, until, reaches, root, create, requires, have, initiate, upstream, verify_certificate, www, com, indication, sni, server_name, password1, key_pass_env_var, passphrase, unlock, encrypted, key_pass, private, identity, require, archive, certificate_authority, ca_file, declare, during, negotiation, peer, prioritized, sets, alpn_protocols, param, array, these, override, values, body, conflicting, specifying, results, accepts, wildcard, matching, pattern, url, 300, 600, random, configured, added, spread, storms, amount, exist, closed, sending, response, disable, feature, 100000000, close, 110, factor, varint, compatible, encoding, unsigned, bit, integer, chosen, underlying, boundaries, segments, length_field_offset, representing, length_field_length, little, length_field_is_big_endian, fully, drops, timed, timeout_secs, incomplete, starts, dropping, ensuring, bounded, grow, matches, pending_messages_limit, account, excluded, calculation, concatenation, chunk, payloads, composed, whole, single, longer, per, decompress, none, detect, based, magic, delimits, ascii_char, separated, form, way, marks, begins, ends, est5edt, america, new_york, apply, conversions, contain, explicit, indicate, database, execute, final, contents, target, compilation, abort, trying, duplicate, removed, while, preserving, tries, signals, allows, optimize, know, expected, avoid, attempting, first, attempt, parsing, priority, 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, passes, them, old, includes, structured, 5424, 3164, three, detects, buffers, forward, implementation, relax, enforcement, codecs, maintained, much, receiver, adheres, exception, characters, allowed, reason, datum, strip, prefix, described, confluent, strip_schema_id_prefix, record, timemillis, fixed, decimal, date, definition, variants, apache_avro, encoder, decoders, determine, concatenated, base64, expression, https, credentials, without, encryption, beyond, what, itself, localhost, listen, disabling, controls, toml, yaml, advanced, minimal, configurations, receives, drains, view, egress, yes, delivery, least, once, role, stable, collect, router, responsible, receiving, your, apps, versioning, meta, glossary, variables, cli, secrets, template, syntax, unit, tests, webhdfs, exporter, postgres, papertrail, relic, mezmo, logdna, keep, honeycomb, chronicle, unstructured, elasticsearch, doris, databricks, zerobus, databend, clickhouse, blackhole, monitor, ingestion, blob, axiom, sns, streams, appsignal, window, throttle, tag, cardinality, sample, reduce, lua, incremental, exclusive, delay, dedupe, ec2, metadata, aggregate, stdin, static, scrape, pushgateway, postgresql, okta, nginx, mongodb, logstash, journald, 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):
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 keepalive optional object configuration of http server keepalive parameters keepalive max_connection_age_jitter_factor optional float the factor by which to jitter the max_connection_age_secs value a value of 0 1 means that the actual duration will be between 90 and 110 of the specified maximum duration default 0 1 keepalive max_connection_age_secs optional uint the maximum amount of time a connection may exist before it is closed by sending a connection close header on the http response set this to a large value like 100000000 to disable this feature only applies to http 0 9 http 1 0 and http 1 1 requests a random jitter configured by max_connection_age_jitter_factor is added to the specified duration to spread out connection storms examples 600 default 300 seconds query_parameters optional string a list of url query parameters to include in the log event accepts the wildcard character for query parameters matching a specified pattern specifying results in all query parameters included in the log event these override any values included in the body with conflicting names array string literal examples application source param tls optional object configures the tls options for incoming outgoing connections 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 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 line an individual event from a batch of events received through an http post request fields app_name required string literal the app name field extracted from log message examples erlang host required string literal the local hostname equivalent to the gethostname command examples my host local message required string literal the message field containing the plain text message examples hi from erlang proc_id required string literal the procid field extracted from log message examples console source_type required string literal the name of the source type examples heroku_logs timestamp required timestamp the exact time the event was ingested into vector examples 2020 10 10 t17 07 36 452332 z telemetry metrics link 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_received_bytes_total counter the number of raw bytes accepted by this component from source 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_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 http_server_handler_duration_seconds histogram the duration spent handling a http request 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 method optional the http method of the request path the path that produced the error pid optional the process id of the vector instance status optional the http status code of the request http_server_requests_received_total counter the total number of http requests received compone...
|