Heroku Logplex

Collect logs from Heroku’s Logplex, the router responsible for receiving logs from your Heroku apps

status: beta role: aggregator delivery: at-least-once egress: batch state: stateless output: log previously known as: logplex
Receives log data from Heroku log drains via Heroku’s logplex system.

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",
      "acknowledgements": null,
      "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
    acknowledgements: null
    address: 0.0.0.0:80
{
  "sources": {
    "my_source_id": {
      "type": "heroku_logs",
      "acknowledgements": null,
      "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
    acknowledgements: null
    address: 0.0.0.0:80
    auth: null
    tls: null
    query_parameters:
      - application

acknowledgements

common optional bool
Controls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
default: false

address

required string literal
The address to accept connections on. The address must include a port.
Examples
"0.0.0.0:80"
"localhost:80"

auth

optional object
Options for HTTP Basic Authentication.

auth.password

required string literal
The basic authentication password.

auth.username

required string literal
The basic authentication user name.

query_parameters

optional [string]
A list of URL query parameters to include in the log event. These will override any values included in the body with conflicting names.
Array string literal
Examples
[
  "application",
  "source"
]

tls

optional object
Configures the TLS options for incoming connections.

tls.ca_file

optional string literal
Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.

tls.crt_file

optional string literal
Absolute path to a certificate file used to identify this server, in DER or PEM format (X.509) or PKCS#12, or an in-line certificate in PEM format. If this is set, and is not a PKCS#12 archive, key_file must also be set. This is required if enabled is set to true.

tls.enabled

optional bool
Require TLS for incoming connections. If this is set, an identity certificate is also required.
default: false

tls.key_file

optional string literal
Absolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an in-line private key in PEM format.

tls.key_pass

optional string literal
Pass phrase used to unlock the encrypted key file. This has no effect unless key_file is set.

tls.verify_certificate

optional bool
If true, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. If false (the default), Vector will not request a certificate from the client.
default: false

Output

Logs

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
timestamp required timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z

Telemetry

Metrics

link

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
host required
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 event originates.
peer_path optional
The pathname from which the event originates.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

processed_bytes_total

counter
The number of bytes processed by the component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
container_name optional
The name of the container from which the bytes originate.
file optional
The file from which the bytes originate.
host required
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 bytes originate.
peer_path optional
The pathname from which the bytes originate.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the bytes originate.
uri optional
The sanitized URI from which the bytes originate.

request_read_errors_total

counter
The total number of request read errors for this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

requests_received_total

counter
The total number of requests received by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
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 required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

How it works

Context

By default, the heroku_logs source augments events with helpful context keys.

State

This component is stateless, meaning its behavior is consistent across each input.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols. You can adjust TLS behavior via the tls.* options.