OpenTelemetry
Receive OTLP data through gRPC or HTTP.
Warnings
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 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 boolgrpc
required objectopentelemetry
gRPC server.grpc.address
required string literalThe socket address to listen for connections on.
It must include a port.
grpc.tls
optional objectgrpc.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 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.
grpc.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.
grpc.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.
grpc.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.
grpc.tls.key_pass
optional string literalPassphrase used to unlock the encrypted key file.
This has no effect unless key_file
is set.
grpc.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.
grpc.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.
http
required objectopentelemetry
HTTP server.http.address
required string literalThe socket address to listen for connections on.
It must include a port.
http.tls
optional objecthttp.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 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.
http.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.
http.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.
http.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.
http.tls.key_pass
optional string literalPassphrase used to unlock the encrypted key file.
This has no effect unless key_file
is set.
http.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.
http.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
logs
<component_id>.logs
as an input to downstream transforms and sinks.Output Data
Logs
Event
{
"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"
}
20200415T072306-0700 INFO I like donuts
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.
2020-10-10T17:07:36.452332Z
{
"k8s.pod.uid": "1138528c-c36e-11e9-a1a7-42010a800198",
"service.name": "donut_shop",
"service.version": "2.0.0"
}
{
"container.name": "vector"
}
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).
3
9
17
24
TRACE3
INFO
ERROR
FATAL4
43222c2d51a7abe3
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.
2020-10-10T17:07:36.452332Z
66346462623365646437363566363230
Telemetry
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_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
.events_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.events_out_total
countercomponent_sent_events_total
instead.component_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)
grpc.tls.*
and http.tls.*
options.