DogStatsD works by sending metrics generated from your application to the Agent over a transport protocol. This protocol can be UDP (User Datagram Protocol) or UDS (Unix Domain Socket).
When DogStatsD is used to send a large volume of metrics to a single Agent, if proper measures are not taken, it is common to end up with the following symptoms:
Most of the time the symptoms can be alleviated by tweaking some configuration options described below.
Datadog recommends using the latest version of the official DogStatsD clients for every major programming language.
Some StatsD and DogStatsD clients, by default, send one metric per datagram. This adds considerable overhead on the client, the operating system, and the Agent. If your client supports buffering multiple metrics in one datagram, enabling this option brings noticeable improvements.
dogstatsd_buffer_size) and the network/OS max datagram size.Here are a few examples for official DogStatsD supported clients:
By default, Datadog’s official Golang library DataDog/datadog-go uses buffering. The size of each packet and the number of messages use different default values for UDS and UDP. See DataDog/datadog-go for more information about the client configuration.
package main
import (
"log"
"github.com/DataDog/datadog-go/statsd"
)
func main() {
// In this example, metrics are buffered by default with the correct default configuration for UDP.
statsd, err := statsd.New("127.0.0.1:8125")
if err != nil {
log.Fatal(err)
}
statsd.Gauge("example_metric.gauge", 1, []string{"env:dev"}, 1)
}
By using Datadog’s official Python library datadogpy, the example below uses a buffered DogStatsD client that sends metrics in a minimal number of packets. With buffering automatic flushing is performed at packet size limit and every 300ms (configurable).
from datadog import DogStatsd
# If using client v0.43.0+
dsd = DogStatsd(host="127.0.0.1", port=8125, disable_buffering=False)
dsd.gauge('example_metric.gauge_1', 123, tags=["environment:dev"])
dsd.gauge('example_metric.gauge_2', 1001, tags=["environment:dev"])
dsd.flush() # Optional manual flush
# If using client before v0.43.0, context manager is needed to use buffering
dsd = DogStatsd(host="127.0.0.1", port=8125)
with dsd:
dsd.gauge('example_metric.gauge_1', 123, tags=["environment:dev"])
dsd.gauge('example_metric.gauge_2', 1001, tags=["environment:dev"])
statsd global instance) cannot be shared across processes but are thread-safe. Because of this, the parent process and each child process must create their own instances of the client or the buffering must be explicitly disabled by setting disable_buffering to True. See the documentation on datadog.dogstatsd for more details.By using Datadog’s official Ruby library [dogstatsd-ruby][1], the example below creates a buffered DogStatsD client instance that sends metrics in one packet when the flush is triggered:
require 'datadog/statsd'
statsd = Datadog::Statsd.new('127.0.0.1', 8125)
statsd.increment('example_metric.increment', tags: ['environment:dev'])
statsd.gauge('example_metric.gauge', 123, tags: ['environment:dev'])
# synchronous flush
statsd.flush(sync: true)
single_thread to true. See the dogstatsd-ruby repo on GitHub for more details.By using Datadog’s official Java library java-dogstatsd-client, the example below creates a buffered DogStatsD client instance with a maximum packet size of 1500 bytes, meaning all metrics sent from this instance of the client are buffered and sent in packets of 1500 packet-length at most:
import com.timgroup.statsd.NonBlockingStatsDClient;
import com.timgroup.statsd.StatsDClient;
import java.util.Random;
public class DogStatsdClient {
public static void main(String[] args) throws Exception {
StatsDClient Statsd = new NonBlockingStatsDClientBuilder()
.prefix("namespace").
.hostname("127.0.0.1")
.port(8125)
.maxPacketSizeBytes(1500)
.build();
Statsd.incrementCounter("example_metric.increment", ["environment:dev"]);
Statsd.recordGaugeValue("example_metric.gauge", 100, ["environment:dev"]);
}
}
By using Datadog’s official C# library dogstatsd-csharp-client, the example below creates a DogStatsD client with UDP as transport:
using StatsdClient;
public class DogStatsdClient
{
public static void Main()
{
var dogstatsdConfig = new StatsdConfig
{
StatsdServerName = "127.0.0.1",
StatsdPort = 8125,
};
using (var dogStatsdService = new DogStatsdService())
{
dogStatsdService.Configure(dogstatsdConfig);
// Counter and Gauge are sent in the same datagram
dogStatsdService.Counter("example_metric.count", 2, tags: new[] { "environment:dev" });
dogStatsdService.Gauge("example_metric.gauge", 100, tags: new[] { "environment:dev" });
}
}
}
By using Datadog’s official PHP library php-datadogstatsd, the example below creates a buffered DogStatsD client instance that sends metrics in one packet when the block completes:
<?php
require __DIR__ . '/vendor/autoload.php';
use DataDog\BatchedDogStatsd;
$client = new BatchedDogStatsd(
array('host' => '127.0.0.1',
'port' => 8125,
)
);
$client->increment('example_metric.increment', array('environment'=>'dev'));
$client->increment('example_metric.increment', $sampleRate->0.5 , array('environment'=>'dev'));
It is possible to reduce the traffic from your DogStatsD client to the Agent by setting a sample rate value for your client. For example, a sample rate of 0.5 halves the number of UDP packets sent. This solution is a trade-off: you decrease traffic but slightly lose in precision and granularity.
For more information and code examples, see DogStatsD “Sample Rate” Parameter Explained.
UDS is an inter-process communication protocol used to transport DogStatsD payloads. It has very little overhead when compared to UDP and lowers the general footprint of DogStatsD on your system.
Most operating systems add incoming UDP and UDS datagrams containing your metrics to a buffer with a maximum size. Once the max is reached, datagrams containing your metrics start getting dropped. It is possible to adjust the values to give the Agent more time to process incoming metrics:
On most Linux distributions, the maximum size of the kernel buffer is set to 212992 by default (208 KiB). This can be confirmed using the following commands:
$ sysctl net.core.rmem_max
net.core.rmem_max = 212992
To set the maximum size of the DogStatsD socket buffer to 25MiB run:
sysctl -w net.core.rmem_max=26214400
Add the following configuration to /etc/sysctl.conf to make this change permanent:
net.core.rmem_max = 26214400
Then set the Agent dogstatsd_so_rcvbuf configuration option to the same number in datadog.yaml:
dogstatsd_so_rcvbuf: 26214400
See the Note on sysctl in Kubernetes section if you are deploying the Agent or DogStatsD in Kubernetes.
For UDS sockets, Linux is internally buffering datagrams in a queue if the reader is slower than the writer. The size of this queue represents the maximum number of datagrams that Linux buffers per socket. This value can be queried with the following command:
sysctl net.unix.max_dgram_qlen
If the value is < 512, you can increase it to 512 or more using this command:
sysctl -w net.unix.max_dgram_qlen=512
Add the following configuration to /etc/sysctl.conf to make this change permanent:
net.unix.max_dgram_qlen = 512
In the same manner, the net.core.wmem_max could be incremented to 4MiB to improve
client writing performances:
net.core.wmem_max = 4194304
Then set the Agent dogstatsd_so_rcvbuf configuration option to the same number in datadog.yaml:
dogstatsd_so_rcvbuf: 4194304
If you are using Kubernetes to deploy the Agent and/or DogStatsD and you want to configure the sysctls as mentioned above, set their value per container. If the net.* sysctls is namespaced, you can set them per pod. See the Kubernetes documentation on Using sysctls in a Kubernetes Cluster.
Avoid extra CPU usage by sending packets with an adequate size to the DogStatsD server in the Datadog Agent. The latest versions of the official DogStatsD clients send packets with a size optimized for performance.
You can skip this section if you are using one of the latest Datadog DogStatsD clients.
If the packets sent are too small, the Datadog Agent packs several together to process them in batches later in the pipeline. The official DogStatsD clients are capable of grouping metrics to have the best ratio of the number of metrics per packet.
The Datadog Agent performs most optimally if the DogStatsD clients send packets the size of the dogstatsd_buffer_size. The packets must not be larger than the buffer size, otherwise, the Agent can’t load them completely in the buffer without the metrics being malformed. Use the corresponding configuration field in your DogStatsD clients.
The Agent tries to absorb the burst of metrics sent by the DogStatsD clients, but to do so, it needs to use memory. Even if this is for a short amount of time and even if this memory is quickly released to the OS, a spike happens and that could be an issue in containerized environments where limit on memory usage could evict pods or containers.
Avoid sending metrics in bursts in your application - this prevents the Datadog Agent from reaching its maximum memory usage.
Another thing to look at to limit the maximum memory usage is to reduce the buffering. The main buffer of the DogStatsD server within the Agent is configurable with the dogstatsd_queue_size field (since Datadog Agent 6.1.0), its default value of 1024 induces an approximate maximum memory usage of 768MB.
This example decreases the max memory usage of DogStatsD to approximately 384MB:
dogstatsd_queue_size: 512
See the next section on burst detection to help you detect bursts of metrics from your applications.
DogStatsD has a stats mode in which you can see which metrics are the most processed.
To enable the stats mode, you can either:
dogstatsd_stats_enable to true in your configuration fileDD_DOGSTATSD_STATS_ENABLE to truedatadog-agent config set dogstatsd_stats true command to enable it at runtime. You can disable it at runtime using the command datadog-agent config set dogstatsd_stats false.When this mode is enabled, run the command datadog-agent dogstatsd-stats. A list of the processed metrics is returned in descending order by the metrics received.
While running in this mode, the DogStatsD server runs a burst detection mechanism. If a burst is detected, a warning log is emitted. For example:
A burst of metrics has been detected by DogStatSd: here is the last 5 seconds count of metrics: [250 230 93899 233 218]
DogStatsD clients send telemetry metrics by default to the Agent. This allows you to better troubleshoot where bottlenecks exist. Each metric is tagged with the client language and the client version. These metrics are not counted as custom metrics.
Each client shares a set of common tags.
| Tag | Description | Example |
|---|---|---|
client | The language of the client | client:py |
client_version | The version of the client | client_version:1.2.3 |
client_transport | The transport used by the client (udp or uds) | client_transport:uds |
Note: When using UDP, network errors can’t be detected by the client and the corresponding metrics do not reflect byte or packet drops.
Starting with version 0.34.0 of the Python client.
datadog.dogstatsd.client.metricsmetrics sent to the DogStatsD client by your application (before sampling).datadog.dogstatsd.client.eventsevents sent to the DogStatsD client by your application.datadog.dogstatsd.client.service_checksservice_checks sent to the DogStatsD client by your application.datadog.dogstatsd.client.bytes_sentdatadog.dogstatsd.client.bytes_droppeddatadog.dogstatsd.client.packets_sentdatadog.dogstatsd.client.packets_droppedTo disable telemetry, use the disable_telemetry method:
statsd.disable_telemetry()
See DataDog/datadogpy for more information about the client configuration.
Starting with version 4.6.0 of the Ruby client.
datadog.dogstatsd.client.metricsmetrics sent to the DogStatsD client by your application (before sampling).datadog.dogstatsd.client.eventsevents sent to the DogStatsD client by your application.datadog.dogstatsd.client.service_checksservice_checks sent to the DogStatsD client by your application.datadog.dogstatsd.client.bytes_sentdatadog.dogstatsd.client.bytes_droppeddatadog.dogstatsd.client.packets_sentdatadog.dogstatsd.client.packets_droppedTo disable telemetry, set the disable_telemetry parameter to true:
Datadog::Statsd.new('localhost', 8125, disable_telemetry: true)
See DataDog/dogstatsd-ruby for more information about the client configuration.
Starting with version 3.4.0 of the Go client.
datadog.dogstatsd.client.metricsmetrics sent to the DogStatsD client by your application (before sampling).datadog.dogstatsd.client.eventsevents sent to the DogStatsD client by your application.datadog.dogstatsd.client.service_checksservice_checks sent to the DogStatsD client by your application.datadog.dogstatsd.client.bytes_sentdatadog.dogstatsd.client.bytes_droppeddatadog.dogstatsd.client.bytes_dropped_queuedatadog.dogstatsd.client.bytes_dropped_writerdatadog.dogstatsd.client.packets_sentdatadog.dogstatsd.client.packets_droppeddatadog.dogstatsd.client.packets_dropped_queuedatadog.dogstatsd.client.packets_dropped_writerdatadog.dogstatsd.client.metric_dropped_on_receiveWithChannelMode()). Starting with version 3.6.0 of the Go client.To disable telemetry, use the WithoutTelemetry setting:
statsd, err: = statsd.New("127.0.0.1:8125", statsd.WithoutTelemetry())
See DataDog/datadog-go for more information about the client configuration.
Starting with version 2.10.0 of the Java client.
datadog.dogstatsd.client.metricsmetrics sent to the DogStatsD client by your application (before sampling).datadog.dogstatsd.client.eventsevents sent to the DogStatsD client by your application.datadog.dogstatsd.client.service_checksservice_checks sent to the DogStatsD client by your application.datadog.dogstatsd.client.bytes_sentdatadog.dogstatsd.client.bytes_droppeddatadog.dogstatsd.client.packets_sentdatadog.dogstatsd.client.packets_droppeddatadog.dogstatsd.client.packets_dropped_queueTo disable telemetry, use the enableTelemetry(false) builder option:
StatsDClient client = new NonBlockingStatsDClientBuilder()
.hostname("localhost")
.port(8125)
.enableTelemetry(false)
.build();
See DataDog/java-dogstatsd-client for more information about the client configuration.
Starting with version 1.5.0 of the PHP client the telemetry is enabled by
default for the BatchedDogStatsd client and disabled by default for the
DogStatsd client.
datadog.dogstatsd.client.metricsmetrics sent to the DogStatsD client by your application (before sampling).datadog.dogstatsd.client.eventsevents sent to the DogStatsD client by your application.datadog.dogstatsd.client.service_checksservice_checks sent to the DogStatsD client by your application.datadog.dogstatsd.client.bytes_sentdatadog.dogstatsd.client.bytes_droppeddatadog.dogstatsd.client.packets_sentdatadog.dogstatsd.client.packets_droppedTo enable or disable telemetry use the disable_telemetry argument. Beware,
using telemetry with the DogStatsd client increases network usage
significantly. It is advised to use the BatchedDogStatsd when using telemetry.
To enable it on the DogStatsd client:
use DataDog\DogStatsd;
$statsd = new DogStatsd(
array('host' => '127.0.0.1',
'port' => 8125,
'disable_telemetry' => false,
)
);
To disable telemetry on the BatchedDogStatsd client:
use DataDog\BatchedDogStatsd;
$statsd = new BatchedDogStatsd(
array('host' => '127.0.0.1',
'port' => 8125,
'disable_telemetry' => true,
)
);
See DataDog/php-datadogstatsd for more information about the client configuration.
Starting with version 5.0.0 of the .NET client.
datadog.dogstatsd.client.metricsmetrics sent to the DogStatsD client by your application (before sampling).datadog.dogstatsd.client.eventsevents sent to the DogStatsD client by your application.datadog.dogstatsd.client.service_checksservice_checks sent to the DogStatsD client by your application.datadog.dogstatsd.client.bytes_sentdatadog.dogstatsd.client.bytes_droppeddatadog.dogstatsd.client.packets_sentdatadog.dogstatsd.client.packets_droppeddatadog.dogstatsd.client.packets_dropped_queueTo disable telemetry, set TelemetryFlushInterval at null:
var dogstatsdConfig = new StatsdConfig
{
StatsdServerName = "127.0.0.1",
StatsdPort = 8125,
};
// Disable Telemetry
dogstatsdConfig.Advanced.TelemetryFlushInterval = null;
See DataDog/dogstatsd-csharp-client for more information about the client configuration.
Additional helpful documentation, links, and articles:
