Menu

This is documentation for the next version of Alloy. For the latest stable release, go to the latest version.

Open source

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 Collector solace receiver from the otelcol-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

alloy
otelcol.receiver.solace "LABEL" {
  queue = "QUEUE"
  auth {
    // sasl_plain or sasl_xauth2 or sasl_external block
  }
  output {
    traces  = [...]
  }
}

Arguments

The following arguments are supported:

NameTypeDescriptionDefaultRequired
queuestringName of the Solace telemetry queue to get span trace messages from.yes
brokerstringName of the Solace broker using AMQP over TLS.localhost:5671no
max_unacknowledgedintMaximum number of unacknowledged messages the Solace broker can transmit.10no

queue must have the format queue://#telemetry-myTelemetryProfile.

Blocks

The following blocks are supported inside the definition of otelcol.receiver.solace:

HierarchyBlockDescriptionRequired
authenticationauthenticationConfigures authentication for connecting to the Solace broker.yes
authentication > sasl_plainsasl_plainAuthenticates against the Solace broker with SASL PLAIN.no
authentication > sasl_xauth2sasl_xauth2Authenticates against the Solace broker with SASL XOauth2.no
authentication > sasl_externalsasl_externalAuthenticates against the Solace broker with SASL External.no
flowflowConfigures the behaviour to use when temporary errors are encountered from the next component.no
flow > delayed_retrydelayed_retrySets the flow control strategy to delayed retry which will wait before trying to push the message to the next component again.no
tlstlsConfigures TLS for connecting to the Solace broker.no
debug_metricsdebug_metricsConfigures the metrics which this component generates to monitor its state.no
outputoutputConfigures where to send received telemetry data.yes

One SASL authentication block is required in the authentication block.

sasl_external must be used together with the tls block.

The > symbol indicates deeper levels of nesting. For example, authentication > tls refers to a tls block defined inside an authentication block.

authentication block

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_plain block

The sasl_plain block configures how to authenticate to the Solace broker with SASL PLAIN.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
usernamestringThe username to use.yes
passwordstringThe password to use.yes

sasl_xauth2 block

The sasl_xauth2 block configures how to authenticate to the Solace broker with SASL XOauth2.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
usernamestringThe username to use.yes
bearerstringThe bearer in plain text.yes

sasl_external block

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.

flow block

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 block

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:

NameTypeDescriptionDefaultRequired
delaystringThe time to wait before retrying."10ms"no

tls block

The following arguments are supported:

NameTypeDescriptionDefaultRequired
ca_filestringPath to the CA file.no
ca_pemstringCA PEM-encoded text to validate the server with.no
cert_filestringPath to the TLS certificate.no
cert_pemstringCertificate PEM-encoded text for client authentication.no
insecure_skip_verifybooleanIgnores insecure server TLS certificates.no
include_system_ca_certs_poolbooleanWhether to load the system certificate authorities pool alongside the certificate authority.falseno
insecurebooleanDisables TLS when connecting to the configured server.no
key_filestringPath to the TLS certificate key.no
key_pemsecretKey PEM-encoded text for client authentication.no
max_versionstringMaximum acceptable TLS version for connections."TLS 1.3"no
min_versionstringMinimum acceptable TLS version for connections."TLS 1.2"no
cipher_suiteslist(string)A list of TLS cipher suites that the TLS transport can use.[]no
reload_intervaldurationThe duration after which the certificate is reloaded."0s"no
server_namestringVerifies 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 reload_interval is set to "0s", the certificate never reloaded.

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

  • ca_pem and ca_file
  • cert_pem and cert_file
  • key_pem and key_file

If cipher_suites is left blank, a safe default list is used. See the Go TLS documentation for a list of supported cipher suites.

debug_metrics block

The debug_metrics block configures the metrics that this component generates to monitor its state.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
disable_high_cardinality_metricsbooleanWhether to disable certain high cardinality metrics.trueno
levelstringControls the level of detail for metrics emitted by the wrapped collector."detailed"no

disable_high_cardinality_metrics is the Grafana 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 to otelcol.exporter.* and otelcol.receiver.* components.

level is the Alloy equivalent to the telemetry.metrics.level feature gate in the OpenTelemetry Collector. Possible values are "none", "basic", "normal" and "detailed".

output block

The output block configures a set of components to forward resulting telemetry data to.

The following arguments are supported:

NameTypeDescriptionDefaultRequired
logslist(otelcol.Consumer)List of consumers to send logs to.[]no
metricslist(otelcol.Consumer)List of consumers to send metrics to.[]no
traceslist(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 is recommended to only set one consumer for this component.

Exported fields

otelcol.receiver.solace does not export any fields.

Component health

otelcol.receiver.solace is only reported as unhealthy if given an invalid configuration.

Debug information

otelcol.receiver.solace does not 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:

alloy
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:

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.