Heroku Logplex Source

The Vector heroku_logs source receives log data from Heroku log drains via Heroku's logplex system.

Configuration

• Common
• Advanced

• vector.toml
• vector.yaml
• vector.json

[sources.my_source_id]
  type = "heroku_logs" # required
  address = "0.0.0.0:80" # required

• commonrequiredstring

  address

  The address to accept connections on. The address must include a port.

  • Syntax: literal
  • View examples
• optionaltable

  auth

  Options for HTTP Basic Authentication.

  • commonrequiredstring

    password

    The basic authentication password.

    • Syntax: literal
    • View examples
  • commonrequiredstring

    username

    The basic authentication user name.

    • Syntax: literal
    • View examples
• optional[string]

  query_parameters

  A list of URL query parameters to include in the log event. These will override any values included in the body with conflicting names.

  • View examples
• optionaltable

  tls

  Configures the TLS options for incoming connections.

  • optionalstring

    ca_file

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

    • Syntax: literal
    • View examples
  • optionalstring

    crt_file

    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.

    • Syntax: literal
    • View examples
  • optionalbool

    enabled

    Require TLS for incoming connections. If this is set, an identity certificate is also required.

    • Default: false
    • View examples
  • optionalstring

    key_file

    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.

    • Syntax: literal
    • View examples
  • optionalstring

    key_pass

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

    • Syntax: literal
    • View examples
  • optionalbool

    verify_certificate

    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
    • View examples

Output

This component outputs log events with the following fields:

{
  "app_name" : "erlang",
  "host" : "my-host.local",
  "message" : "Hi from erlang",
  "proc_id" : "console",
  "timestamp" : "2020-10-10T17:07:36+00:00"
}

5 items

commonrequired

• commonrequiredstring

  app_name

  The app name field extracted from log message.

  • Syntax: literal
  • View examples
• commonrequiredstring

  host

  The local hostname, equivalent to the gethostname command.

  • Syntax: literal
  • View examples
• commonrequiredstring

  message

  The message field, containing the plain text message.

  • Syntax: literal
  • View examples
• commonrequiredstring

  proc_id

  The procid field extracted from log message.

  • Syntax: literal
  • View examples
• commonrequiredtimestamp

  timestamp

  The exact time the event was ingested into Vector.

  • View examples

Telemetry

This component provides the following metrics that can be retrieved through the internal_metrics source. See the metrics section in the monitoring page for more info.

• counter

  request_read_errors_total

  The total number of request read errors for this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  events_out_total

  The total number of events emitted by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  requests_received_total

  The total number of requests received by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

How It Works

Context

By default, the heroku_logs source will augment events with helpful context keys as shown in the "Output" section.

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.