Statsd (deprecated) 🔗
Caution
This integration is deprecated and will be removed in a future release. During this period only critical security and bug fixes are provided. When End of Support is reached, the monitor will be removed and no longer be supported, and you won’t be able to use it to send data to Splunk Observability Cloud.
To forward statsd metrics to Splunk Observability Cloud use the StatsD receiver instead.
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the statsd monitor type to collect statsd metrics. It listens on a configured address and port to receive the statsd metrics.
This integration supports certain Stats types, which are dispatched as counter or gauges types in Splunk Observability Cloud, as displayed in the table. Statsd extensions such as tags are not supported.
Statsd type |
Splunk Observability Cloud type |
|---|---|
|
|
|
|
|
|
|
|
This integration is available for Kubernetes and Linux.
Benefits 🔗
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata Catalog.
Installation 🔗
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.
Verify the installation 🔗
To verify the installation, send statsd metrics locally with netcat
as follows, then verify in Splunk Observability Cloud that the metric
arrived:
$ echo "statsd.test:1|g" | nc -w 1 -u 127.0.0.1 8125
For Kubernetes environments, use the status.hostIP environment
variable to verify the installation. This environment variable is the IP
address of the node where the pod is running.
Configuration 🔗
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.
Example 🔗
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/statsd:
type: statsd
... # Additional config
Next, add the monitor to the service.pipelines.metrics.receivers
section of your configuration file:
service:
pipelines:
metrics:
receivers: [smartagent/statsd]
Configuration settings 🔗
The following table shows the configuration options for the statsd
monitor:
Option |
Required |
Type |
Description |
|---|---|---|---|
|
No |
|
|
|
No |
|
|
|
No |
|
|
|
No |
|
|
The nested converters configuration object has the following fields:
Option |
Required |
Type |
Description |
|---|---|---|---|
|
No |
|
A pattern to match against statsd metric names. |
|
No |
|
|
Metrics 🔗
By default this monitor has no fixed metrics. Instead, it will create metrics based on your configuration.
All metrics are custom. See the section below to learn how metrics can be collected with this monitor.
Add dimensions to statsd metrics 🔗
The statsd monitor can parse keywords from a statsd metric name by a set of converters configured by a user, as shown in the following example:
converters:
- pattern: "cluster.cds_{traffic}_{mesh}_{service}-vn_{}.{action}"
...
This converter parses traffic, mesh, service, and action
as dimensions from the
cluster.cds_egress_ecommerce-demo-mesh_gateway-vn_tcp_8080.update_success
metric. If a section has only a pair of brackets without a name, it does
not capture a dimension.
When multiple converters are provided, a metric is converted by the first converter with a matching pattern to the metric name.
Format metric names 🔗
You can customize a metric name by providing a format string within the converter configuration, as shown in the following example:
converters:
- pattern: "cluster.cds_{traffic}_{mesh}_{service}-vn_{}.{action}"
metricName: "{traffic}.{action}"
The metrics that match to the given pattern are reported to
Infrastructure Monitoring as {traffic}.{action}. For instance,
metric
cluster.cds_egress_ecommerce-demo-mesh_gateway-vn_tcp_8080.update_success
is reported as egress.update_success.
metricName is required for a converter configuration. A converter is
deactivated if metricName is not provided.
Data points get a host dimension of the current host that the agent
is running on, not the host from which the statsd metric was sent. For
this reason, send statsd metrics to a local agent instance. If you don’t
want the host dimension, you can set disableHostDimensions: true
on the monitor configuration.
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.