Heroku Logplex
Collect logs from Heroku’s Logplex, the router responsible for receiving logs from your Heroku apps
Alias
This component was previously called the logplex source. Make sure to update your
Vector configuration to accommodate the name change:
[sources.my_heroku_logs_source]
+type = "heroku_logs"
-type = "logplex"
Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "heroku_logs",
"address": "0.0.0.0:80"
}
}
}[sources.my_source_id]
type = "heroku_logs"
address = "0.0.0.0:80"
---
sources:
my_source_id:
type: heroku_logs
address: 0.0.0.0:80
{
"sources": {
"my_source_id": {
"type": "heroku_logs",
"address": "0.0.0.0:80",
"query_parameters": [
"application"
]
}
}
}[sources.my_source_id]
type = "heroku_logs"
address = "0.0.0.0:80"
query_parameters = [ "application" ]
---
sources:
my_source_id:
type: heroku_logs
address: 0.0.0.0:80
query_parameters:
- application
acknowledgements
optional objectControls how acknowledgements are handled by this source.
This setting is deprecated in favor of enabling acknowledgements at the global or sink level.
Enabling or disabling acknowledgements at the source level has no effect on acknowledgement behavior.
See End-to-end Acknowledgements for more information on how event acknowledgement is handled.
acknowledgements.enabled
optional booladdress
required string literalauth
optional objectauth.password
required string literalauth.username
required string literaldecoding
optional objectdecoding.codec
optional string literal enum| Option | Description |
|---|---|
bytes | Uses the raw bytes as-is. |
gelf | Decodes the raw bytes as a GELF message. |
json | Decodes the raw bytes as JSON. |
native | Decodes the raw bytes as Vector’s native Protocol Buffers format. This codec is experimental. |
native_json | Decodes the raw bytes as Vector’s native JSON format. This codec is experimental. |
syslog | Decodes the raw bytes as a Syslog message. Decodes either as the RFC 3164-style format (“old” style) or the RFC 5424-style format (“new” style, includes structured data). |
bytesframing
optional objectFraming configuration.
Framing handles how events are separated when encoded in a raw byte form, where each event is a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream.
framing.character_delimited
required objectmethod = "character_delimited"framing.character_delimited.delimiter
required uintframing.character_delimited.max_length
optional uintThe maximum length of the byte buffer.
This length does not include the trailing delimiter.
By default, there is no maximum length 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 ensures that processing is not actually unbounded.
framing.method
optional string literal enum| 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. |
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. |
bytesframing.newline_delimited
optional objectmethod = "newline_delimited"framing.newline_delimited.max_length
optional uintThe maximum length of the byte buffer.
This length does not include the trailing delimiter.
By default, there is no maximum length 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 ensures that processing is not actually unbounded.
framing.octet_counting
optional objectmethod = "octet_counting"framing.octet_counting.max_length
optional uintquery_parameters
optional [string]A list of URL query parameters to include in the log event.
These override any values included in the body with conflicting names.
tls
optional objecttls.alpn_protocols
optional [string]Sets the list of supported ALPN protocols.
Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order that they are defined.
tls.ca_file
optional string literalAbsolute 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.
tls.crt_file
optional string literalAbsolute 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.
tls.enabled
optional boolWhether or not 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 literalAbsolute 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.
tls.key_pass
optional string literalPassphrase used to unlock the encrypted key file.
This has no effect unless key_file is set.
tls.verify_certificate
optional boolEnables certificate verification.
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.
Relevant for both incoming and outgoing connections.
Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.
tls.verify_hostname
optional boolEnables 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>
Output Data
Logs
Line
erlanggethostname command.my-host.localHi from erlangconsoleheroku_logs2020-10-10T17:07:36.452332ZTelemetry
Metrics
linkcomponent_discarded_events_total
countercomponent_id instead. The value is the same as component_id.component_errors_total
countercomponent_id instead. The value is the same as component_id.component_received_bytes_total
countercomponent_id instead. The value is the same as component_id.component_received_event_bytes_total
countercomponent_id instead. The value is the same as component_id.component_received_events_count
histogramA 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 instead. The value is the same as component_id.component_received_events_total
countercomponent_id instead. The value is the same as component_id.component_sent_event_bytes_total
countercomponent_id instead. The value is the same as component_id.component_sent_events_total
countercomponent_id instead. The value is the same as component_id.request_read_errors_total
countercomponent_id instead. The value is the same as component_id.requests_received_total
countercomponent_id instead. The value is the same as component_id.source_lag_time_seconds
histogramcomponent_id instead. The value is the same as component_id.How it works
Transport Layer Security (TLS)
tls.* options.