OpenTelemetry

Receive OTLP data through gRPC or HTTP.

status: beta role: daemon role: aggregator delivery: at-least-once acknowledgements: yes egress: stream state: stateless output: log
Page source Edit this page

Warnings

The opentelemetry source only supports log events at this time.

Configuration

Example configurations 

{
  "sources": {
    "my_source_id": {
      "type": "opentelemetry",
      "grpc": {
        "address": "0.0.0.0:4317"
      },
      "http": {
        "address": "0.0.0.0:4318"
      }
    }
  }
}
[sources.my_source_id]
type = "opentelemetry"

  [sources.my_source_id.grpc]
  address = "0.0.0.0:4317"

  [sources.my_source_id.http]
  address = "0.0.0.0:4318"

---
sources:
  my_source_id:
    type: opentelemetry
    grpc:
      address: 0.0.0.0:4317
    http:
      address: 0.0.0.0:4318

{
  "sources": {
    "my_source_id": {
      "type": "opentelemetry",
      "grpc": {
        "address": "0.0.0.0:4317"
      },
      "http": {
        "address": "0.0.0.0:4318"
      }
    }
  }
}
[sources.my_source_id]
type = "opentelemetry"

  [sources.my_source_id.grpc]
  address = "0.0.0.0:4317"

  [sources.my_source_id.http]
  address = "0.0.0.0:4318"

---
sources:
  my_source_id:
    type: opentelemetry
    grpc:
      address: 0.0.0.0:4317
    http:
      address: 0.0.0.0:4318

acknowledgements

optional object

Deprecated

This field is deprecated.

Controls 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 bool
Whether or not end-to-end acknowledgements are enabled for this source.

grpc

required object
Configuration for the opentelemetry gRPC server.

grpc.address

required string literal

The socket address to listen for connections on.

It must include a port.

Examples 
"0.0.0.0:4317"
"localhost:4317"

grpc.tls

optional object
Configures the TLS options for incoming/outgoing connections.
grpc.tls.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.

grpc.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"
grpc.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"
grpc.tls.enabled
optional bool

Whether 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.

grpc.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"
grpc.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"
grpc.tls.verify_certificate
optional bool

Enables 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.

grpc.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.

http

required object
Configuration for the opentelemetry HTTP server.

http.address

required string literal

The socket address to listen for connections on.

It must include a port.

Examples 
"0.0.0.0:4318"
"localhost:4318"

http.tls

optional object
Configures the TLS options for incoming/outgoing connections.
http.tls.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.

http.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"
http.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"
http.tls.enabled
optional bool

Whether 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.

http.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"
http.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"
http.tls.verify_certificate
optional bool

Enables 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.

http.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

logs

Received log events will go to this output stream. Use <component_id>.logs as an input to downstream transforms and sinks.

Output Data

Logs

Event

An individual log event from a batch of events received through an OTLP request
Fields
attributes optional object
Attributes that describe the specific event occurrence.
Examples
{
  "http.status.code": 500,
  "http.url": "http://example.com",
  "my.custom.application.tag": "hello"
}
{
  "http.flavor": "1.1",
  "http.host": "donut.mycie.com",
  "http.method": "post",
  "http.scheme": "https",
  "http.status_code": 500,
  "http.target": "/order",
  "http.user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36"
}
dropped_attributes_count required uint
Counts for attributes dropped due to collection limits.
flags optional uint
Trace flag as defined in W3C Trace Context specification.
message optional string literal
Contains the body of the log record.
Examples
20200415T072306-0700 INFO I like donuts
observed_timestamp required timestamp

The UTC Datetime when the event was observed by the collection system. If this value is unset, or 0, it will be set to the current time.

This field is converted from the observed_time_unix_nano Protobuf field.

Examples
2020-10-10T17:07:36.452332Z
resources optional object
Set of attributes that describe the resource.
Examples
{
  "k8s.pod.uid": "1138528c-c36e-11e9-a1a7-42010a800198",
  "service.name": "donut_shop",
  "service.version": "2.0.0"
}
{
  "container.name": "vector"
}
severity_number optional uint

Numerical value of the severity.

Smaller numerical values correspond to less severe events (such as debug events), larger numerical values correspond to more severe events (such as errors and critical events).

Examples
3
9
17
24
severity_text optional string literal
Severity text (also known as log level).
Examples
TRACE3
INFO
ERROR
FATAL4
span_id optional string literal
Can be set for logs that are part of a particular processing span.
Examples
43222c2d51a7abe3
timestamp required timestamp

The UTC Datetime when the event occurred. If this value is unset, or 0, it will be set to the observed_timestamp field.

This field is converted from the time_unix_nano Protobuf field.

Examples
2020-10-10T17:07:36.452332Z
trace_id optional string literal
Request trace id as defined in W3C Trace Context. Can be set for logs that are part of request processing and have an assigned trace id.
Examples
66346462623365646437363566363230

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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

events_in_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

events_out_total

counter
The total number of events emitted by this component. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

source_lag_time_seconds

histogram
The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

How it works

Context

By default, the opentelemetry 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 grpc.tls.* and http.tls.* options.
Sidebar