otelcol.receiver.solace
otelcol.receiver.solace
accepts traces from a
Solace PubSub+ Event Broker and forwards it to other otelcol.*
components.
Note
otelcol.receiver.solace
is a wrapper over the upstream OpenTelemetry Collectorsolace
receiver from theotelcol-contrib
distribution. Bug reports or feature requests will be redirected to the upstream repository, if necessary.
You can specify multiple otelcol.receiver.solace
components by giving them different labels.
Usage
otelcol.receiver.solace "<LABEL>" {
queue = "<QUEUE>"
auth {
// sasl_plain or sasl_xauth2 or sasl_external block
}
output {
traces = [...]
}
}
Arguments
You can use the following arguments with otelcol.receiver.solace
:
Name | Type | Description | Default | Required |
---|---|---|---|---|
queue | string | Name of the Solace telemetry queue to get span trace messages from. | yes | |
broker | string | Name of the Solace broker using AMQP over TLS. | "localhost:5671" | no |
max_unacknowledged | int | Maximum number of unacknowledged messages the Solace broker can transmit. | 10 | no |
queue
must have the format queue://#telemetry-myTelemetryProfile
.
Blocks
You can use the following blocks with otelcol.receiver.solace
:
Block | Description | Required |
---|---|---|
output | Configures where to send received telemetry data. | yes |
authentication | Configures authentication for connecting to the Solace broker. | yes |
authentication >
sasl_external | Authenticates against the Solace broker with SASL External. | no |
authentication >
sasl_plain | Authenticates against the Solace broker with SASL PLAIN. | no |
authentication >
sasl_xauth2 | Authenticates against the Solace broker with SASL XOauth2. | no |
debug_metrics | Configures the metrics which this component generates to monitor its state. | no |
flow | Configures the behaviour to use when temporary errors are encountered from the next component. | no |
flow >
delayed_retry | Sets the flow control strategy to delayed retry which will wait before trying to push the message to the next component again. | no |
tls | Configures TLS for connecting to the Solace broker. | no |
The > symbol indicates deeper levels of nesting.
For example, authentication
> tls
refers to a tls
block defined inside an authentication
block.
One SASL authentication block is required in the authentication
block.
sasl_external
must be used together with the tls
block.
output
Required
The output
block configures a set of components to forward resulting telemetry data to.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
logs | list(otelcol.Consumer) | List of consumers to send logs to. | [] | no |
metrics | list(otelcol.Consumer) | List of consumers to send metrics to. | [] | no |
traces | list(otelcol.Consumer) | List of consumers to send traces to. | [] | no |
You must specify the output
block, but all its arguments are optional.
By default, telemetry data is dropped.
Configure the metrics
, logs
, and traces
arguments accordingly to send telemetry data to other components.
Warning
Having multiple consumers may result in duplicated traces in case of errors because of the retry strategy. It’s recommended to only set one consumer for this component.
authentication
The authentication
block configures how to authenticate for connecting to the Solace broker.
It doesn’t support any arguments and is configured fully through inner blocks.
sasl_external
The sasl_xauth2
block configures how to authenticate to the Solace broker with SASL External.
It doesn’t support any arguments or blocks.
It must be used with the
tls
block.
sasl_plain
The sasl_plain
block configures how to authenticate to the Solace broker with SASL PLAIN.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
password | string | The password to use. | yes | |
username | string | The username to use. | yes |
sasl_xauth2
The sasl_xauth2
block configures how to authenticate to the Solace broker with SASL XOauth2.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
bearer | string | The bearer in plain text. | yes | |
username | string | The username to use. | yes |
debug_metrics
The debug_metrics
block configures the metrics that this component generates to monitor its state.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
disable_high_cardinality_metrics | boolean | Whether to disable certain high cardinality metrics. | true | no |
disable_high_cardinality_metrics
is the Alloy equivalent to the telemetry.disableHighCardinalityMetrics
feature gate in the OpenTelemetry Collector.
It removes attributes that could cause high cardinality metrics.
For example, attributes with IP addresses and port numbers in metrics about HTTP and gRPC connections are removed.
Note
If configured,
disable_high_cardinality_metrics
only applies tootelcol.exporter.*
andotelcol.receiver.*
components.
flow
The flow
block configures the behaviour to use when temporary errors are encountered from the next component.
It doesn’t support any arguments and is configured fully through inner blocks.
delayed_retry
The delayed_retry
block sets the flow control strategy to delayed retry
which will wait before trying to push the message to the next component again.
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
delay | string | The time to wait before retrying. | "10ms" | no |
tls
The following arguments are supported:
Name | Type | Description | Default | Required |
---|---|---|---|---|
ca_file | string | Path to the CA file. | no | |
ca_pem | string | CA PEM-encoded text to validate the server with. | no | |
cert_file | string | Path to the TLS certificate. | no | |
cert_pem | string | Certificate PEM-encoded text for client authentication. | no | |
cipher_suites | list(string) | A list of TLS cipher suites that the TLS transport can use. | [] | no |
curve_preferences | list(string) | Set of elliptic curves to use in a handshake. | [] | no |
include_system_ca_certs_pool | boolean | Whether to load the system certificate authorities pool alongside the certificate authority. | false | no |
insecure_skip_verify | boolean | Ignores insecure server TLS certificates. | no | |
insecure | boolean | Disables TLS when connecting to the configured server. | no | |
key_file | string | Path to the TLS certificate key. | no | |
key_pem | secret | Key PEM-encoded text for client authentication. | no | |
max_version | string | Maximum acceptable TLS version for connections. | "TLS 1.3" | no |
min_version | string | Minimum acceptable TLS version for connections. | "TLS 1.2" | no |
reload_interval | duration | The duration after which the certificate is reloaded. | "0s" | no |
server_name | string | Verifies the hostname of server certificates when set. | no |
If the server doesn’t support TLS, you must set the insecure
argument to true
.
To disable tls
for connections to the server, set the insecure
argument to true
.
If you set reload_interval
to "0s"
, the certificate never reloaded.
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_file
If cipher_suites
is left blank, a safe default list is used.
Refer to the
Go TLS documentation for a list of supported cipher suites.
The curve_preferences
argument determines the set of
elliptic curves to prefer during a handshake in preference order.
If not provided, a default list is used.
The set of elliptic curves available are X25519
, P521
, P256
, and P384
.
Exported fields
otelcol.receiver.solace
doesn’t export any fields.
Component health
otelcol.receiver.solace
is only reported as unhealthy if given an invalid
configuration.
Debug information
otelcol.receiver.solace
doesn’t expose any component-specific debug
information.
Example
This example forwards read telemetry data through a batch processor before finally sending it to an OTLP-capable endpoint:
otelcol.receiver.solace "default" {
queue = "queue://#telemetry-testprofile"
broker = "localhost:5672"
auth {
sasl_plain {
username = "alloy"
password = "password"
}
}
tls {
insecure = true
insecure_skip_verify = true
}
output {
traces = [otelcol.processor.batch.default.input]
}
}
otelcol.processor.batch "default" {
output {
traces = [otelcol.exporter.otlp.default.input]
}
}
otelcol.exporter.otlp "default" {
client {
endpoint = sys.env("<OTLP_ENDPOINT>")
}
}
Compatible components
otelcol.receiver.solace
can accept arguments from the following components:
- Components that export
OpenTelemetry
otelcol.Consumer
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.