Skip to content

Commit 687eb68

Browse files
Add page for SDK configurations view (#34605)
* Add page for SDK configurations view * Add to side navigation * Fix link * Add additional reason for missing data * Fix inverted conditions in Missing configuration data section Two bullets listed conditions where data IS available rather than conditions where data is MISSING: - "has not been disabled" → "has been disabled" - "is accessible" → "is not accessible" * Fix vale style violations in sdk_configurations.md - Replace "via" with "through" (2 occurrences) - Replace temporal "will not be" with "is not" - Add missing trailing newline * Remove orphaned reference in troubleshooting _index.md Remove unused ref [33] pointing to old /configuration_visibility/ path. Renumber the SDK configurations ref from [34] to [33]. * Move SDK Configurations after existing troubleshooting pages Place the SDK Configurations entry after Tracer Startup Logs, Tracer Debug Logs, and Connection Errors in both the nav menu and the _index.md collapse sections, since those are more commonly used troubleshooting tools. Restore original nav weights for existing pages. * Improve Access section and normalize list style in sdk_configurations.md - Rename "Where to find it" to "Access SDK configurations" - Add intro sentence and explicit step to navigate to APM > Services - Move step 3 description out of the numbered list - Normalize bullet markers from asterisks to hyphens --------- Co-authored-by: Duncan Hewett <8017759+duncanhewett@users.noreply.github.com> Co-authored-by: Brett Blue <brett.blue@datadoghq.com>
1 parent 3de36f8 commit 687eb68

File tree

3 files changed

+63
-1
lines changed

3 files changed

+63
-1
lines changed

config/_default/menus/main.en.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4470,6 +4470,11 @@ menu:
44704470
identifier: tracing_troubleshooting_connection_errors
44714471
parent: tracing_troubleshooting
44724472
weight: 1603
4473+
- name: SDK Configurations
4474+
url: tracing/troubleshooting/sdk_configurations
4475+
identifier: tracing_troubleshooting_sdk_configurations
4476+
parent: tracing_troubleshooting
4477+
weight: 1604
44734478
- name: Agent Rate Limits
44744479
url: tracing/troubleshooting/agent_rate_limits
44754480
identifier: tracing_troubleshooting_rate_limits

content/en/tracing/troubleshooting/_index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,12 @@ During startup, Datadog tracing libraries emit logs that reflect the configurati
316316

317317
{{% /collapse-content %}}
318318

319+
{{% collapse-content title="SDK configurations" level="h4" %}}
320+
321+
Configuration values are automatically reported by the SDKs and can be viewed in the UI. This can be used to troubleshoot instrumentation issues caused by misconfiguration. For details, see the [SDK configurations page][33].
322+
323+
{{% /collapse-content %}}
324+
319325
## Additional support
320326

321327
If you still need additional support, open a ticket with Datadog Support.
@@ -379,4 +385,4 @@ When you open a [support ticket][1], the Datadog support team may ask for the fo
379385
[30]: /tracing/services/inferred_services
380386
[31]: /tracing/trace_pipeline/metrics/#apm-traces-estimated-usage-dashboard
381387
[32]: https://app.datadoghq.com/services
382-
388+
[33]: /tracing/troubleshooting/sdk_configurations/
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: SDK Configurations
3+
description: Use the SDK configurations view to validate setup, and troubleshoot instrumentation issues.
4+
---
5+
6+
## Overview
7+
8+
The SDK Configurations view shows the active configurations of SDKs per service. Configurations are automatically reported from the SDKs. Use the view to:
9+
10+
- Troubleshoot instrumentation issues, including where configurations are inconsistent across instances of a service.
11+
- Validate that a configuration change was deployed correctly across intended instances.
12+
- Identify the source of a configuration value to help fix misconfigurations.
13+
- Discover available configuration options and how they are set.
14+
15+
## Access SDK configurations
16+
17+
To view SDK configurations for a service:
18+
19+
1. Navigate to [**APM** > **Services**][5].
20+
1. Open the **Service Page** for your service.
21+
1. Go to **Service Config** > **SDK & Agent Configurations** tab.
22+
23+
The **SDK Configurations** section displays configurations for active instances of the service.
24+
25+
## Configuration sources
26+
27+
The configuration source shows where a given value is configured:
28+
29+
| Source | Description |
30+
|--------|-------------|
31+
| **Remote Configuration at Runtime** | Set through the Datadog UI using [Configuration at Runtime][1] |
32+
| **Code** | Set in application code |
33+
| **Remote Fleet Automation** | Applied remotely at the host level through [Fleet Automation][2] |
34+
| **Local environment variable** | Set through an environment variable (or system property) in the runtime environment |
35+
| **Local file** | Set in a local configuration file |
36+
| **Default** | Default value provided by the SDK |
37+
38+
## Missing configuration data
39+
40+
Telemetry data is not available in the following situations:
41+
42+
- No service instances have been active in the last 15 minutes.
43+
- Instrumentation telemetry has been disabled in configuration.
44+
- The instrumentation telemetry intake endpoint is not accessible (see [Network Destinations][3]).
45+
- The service name is manually set on spans (a [Service Override][4]).
46+
47+
[1]: /tracing/trace_collection/runtime_config
48+
[2]: /agent/fleet_automation/remote_management
49+
[3]: /agent/configuration/network/#destinations
50+
[4]: /tracing/guide/base_service/#service-overrides
51+
[5]: https://app.datadoghq.com/software

0 commit comments

Comments
 (0)