Skip to content

Commit b11e531

Browse files
authored
docs: add troubleshooting section (#1800)
* add troubleshooting section * add no traces and support section * fix typo
1 parent b5df0ea commit b11e531

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,3 +163,4 @@ Indices and tables
163163
advanced_usage
164164
contributing
165165
release_notes
166+
troubleshooting

docs/troubleshooting.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
===============
2+
Troubleshooting
3+
===============
4+
5+
Traces not showing up in the app
6+
================================
7+
8+
The most common reason for traces not being received by Datadog is an agent
9+
communication issue:
10+
11+
- Ensure the Datadog agent is running and reachable over the network if not on
12+
the same host.
13+
- Ensure that ``ddtrace`` is configured with the hostname and port of the
14+
agent. See :ref:`Configuration` for the configuration variables.
15+
16+
To verify that a connection is being made to the agent, enable start-up logs
17+
with the environment variable ``DD_TRACE_STARTUP_LOGS=true``. A diagnostic log
18+
that looks like ``DATADOG TRACER DIAGNOSTIC...`` will be displayed with the
19+
connection error if there is a problem connecting to the agent.
20+
21+
22+
Failed to send traces... ``ConnectionRefusedError``
23+
===================================================
24+
25+
``Failed to send traces to Datadog Agent...: ConnectionRefusedError(111, 'Connection refused')``
26+
27+
The Datadog Agent has a limit to the number of connections it can receive. This
28+
can be configured with the instructions here: https://docs.datadoghq.com/tracing/troubleshooting/agent_rate_limits/#max-connection-limit.
29+
30+
31+
Still having issues?
32+
====================
33+
34+
If none of the above was able to resolve the issue then please reach out to
35+
Datadog support at [email protected]. Or view the other support options
36+
listed here: https://www.datadoghq.com/support/.

0 commit comments

Comments
 (0)