Zipkin receiver 🔗
The Zipkin receiver gathers spans from Zipkin versions 1 and 2. The supported pipeline type is traces. See Process your data with pipelines for more information.
Get started 🔗
Note
This component is included in the default configuration of the Splunk Distribution of the OpenTelemetry Collector when deploying in host monitoring (agent) mode. See Collector deployment modes for more information.
For details about the default configuration, see Configure the Collector for Kubernetes with Helm, Collector for Linux default configuration, or Collector for Windows default configuration. You can customize your configuration any time as explained in this document.
Follow these steps to configure and activate the component:
Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the Zipkin receiver as described in the next section.
Restart the Collector.
Sample configuration 🔗
To activate the Zipkin receiver, add zipkin to the receivers section of your configuration file, as in the following sample configurations.
receivers:
zipkin:
endpoint: 0.0.0.0:9412
To complete the configuration, include the receiver in the traces pipeline of the service section of your configuration file. For example:
service:
pipelines:
traces:
receivers: [zipkin]
The following settings are configurable:
endpoint:host:porton which the receiver is going to receive data.0.0.0.0:9411by default.parse_string_tags: If enabled, the receiver attempts to parse string tags or binary annotations into int/bool/float.falseby default.
Additional settings 🔗
The Zipkin receiver uses helper files for additional capabilities:
HTTP settings, including CORS. See more in GitHub at HTTP Configuration Settings
TLS and mTLS settings. Learn more in GitHub at TLS Configuration Settings .
Settings 🔗
The following table shows the configuration options for the Zipkin receiver:
| Name | Type | Default | Description |
|---|---|---|---|
endpoint | string | localhost:9411 | |
| tls (see fields) | ptr | ServerConfig contains TLS configurations that are specific to server connections in addition to the common configurations. This should be used by components configuring TLS server connections. | |
| cors (see fields) | ptr | ||
| auth (see fields) | ptr | ||
max_request_body_size | int64 | ||
include_metadata | bool | false | |
response_headers | map | ||
compression_algorithms | slice | ||
read_timeout | int64 | ||
read_header_timeout | int64 | ||
write_timeout | int64 | ||
idle_timeout | int64 | ||
parse_string_tags | bool | false | If enabled the zipkin receiver will attempt to parse string tags/binary annotations into int/bool/float. Disabled by default |
Fields of tls
| Name | Type | Default | Description |
|---|---|---|---|
ca_file | string | Path to the CA cert. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA. (optional) | |
ca_pem | string | In memory PEM encoded cert. (optional) | |
include_system_ca_certs_pool | bool | false | If true, load system CA certificates pool in addition to the certificates configured in this struct. |
cert_file | string | Path to the TLS cert to use for TLS required connections. (optional) | |
cert_pem | string | In memory PEM encoded TLS cert to use for TLS required connections. (optional) | |
key_file | string | Path to the TLS key to use for TLS required connections. (optional) | |
key_pem | string | In memory PEM encoded TLS key to use for TLS required connections. (optional) | |
min_version | string | MinVersion sets the minimum TLS version that is acceptable. If not set, TLS 1.2 will be used. (optional) | |
max_version | string | MaxVersion sets the maximum TLS version that is acceptable. If not set, refer to crypto/tls for defaults. (optional) | |
cipher_suites | slice | CipherSuites is a list of TLS cipher suites that the TLS transport can use. If left blank, a safe default list is used. See https://go.dev/src/crypto/tls/cipher_suites.go for a list of supported cipher suites. | |
reload_interval | int64 | ReloadInterval specifies the duration after which the certificate will be reloaded If not set, it will never be reloaded (optional) | |
client_ca_file | string | Path to the TLS cert to use by the server to verify a client certificate. (optional) This sets the ClientCAs and ClientAuth to RequireAndVerifyClientCert in the TLSConfig. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional) | |
client_ca_file_reload | bool | false | Reload the ClientCAs file when it is modified (optional, default false) |
Fields of cors
| Name | Type | Default | Description |
|---|---|---|---|
allowed_origins | slice | ||
allowed_headers | slice | ||
max_age | int |
Fields of auth
| Name | Type | Default | Description |
|---|---|---|---|
authenticator | struct | ID represents the identity for a component. It combines two values:
| |
request_params | slice |
Troubleshooting 🔗
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.
