Merge pull request #175 from DerGut/congestion-error

Add "Congestion error" section to README
brightcove · Jul 14, 2020 · 08c0d26 · 08c0d26
2 parents 44ed840 + 2c85a6e
commit 08c0d26
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -244,6 +244,13 @@ var client = new StatsD({
 })
 ```
 
+### Congestion error
+
+If you get an error like `Error sending hot-shots message: Error: congestion` with an error code of `1`,
+it is probably because you are sending large volumes of metrics to a single agent/ server.
+This error only arises when using the UDS protocol and means that packages are being dropped.
+Take a look at the [Datadog docs](https://docs.datadoghq.com/developers/dogstatsd/high_throughput/?#over-uds-unix-domain-socket) for some tips on tuning your connection.
+
 ## Unix domain socket support
 
 The 'uds' option as the protocol is to support [Unix Domain Sockets for Datadog](https://docs.datadoghq.com/developers/dogstatsd/unix_socket/).  It has the following limitations: