|
1 | 1 | --- |
2 | | -title: Troubleshoot Datadog agent installation failures in Azure |
3 | | -description: "Step-by-step troubleshooting to resolve Datadog agent installation failures caused by a missing Default API key or misconfiguration." |
4 | | -author: v-albemi |
5 | | -ms.author: v-albemi |
6 | | -ms.service: Datadog integration |
| 2 | +title: Troubleshoot Datadog Agent Installation Failures in Azure |
| 3 | +description: Resolve Datadog agent installation failures caused by a missing or incorrect default API key. |
| 4 | +author: |
| 5 | +ms.author: jarrettr |
| 6 | +ms.service: partner-services |
7 | 7 | ms.topic: troubleshooting-general |
8 | 8 | ms.date: 09/22/2025 |
| 9 | +ai-usage: ai-assisted |
9 | 10 |
|
10 | | -customer intent: As a {role}, I want {what} so that {why}. |
| 11 | +# customer intent: As an Azure administrator or user, I want to resolve an installation failure that's caused by a missing or incorrect default API key. |
11 | 12 |
|
12 | 13 | --- |
13 | 14 |
|
14 | | -# Troubleshoot Datadog agent installation failures |
| 15 | +# Datadog agent installation fails |
15 | 16 |
|
16 | | -This article helps you troubleshoot Datadog agent installation failures on Azure virtual machines and App Services when the installation fails because the Datadog API key is not configured as the Default Key or the agent configuration is incorrect. |
17 | | - |
18 | | -Use this article when Datadog agent installation fails or the agent is installed but does not report metrics or logs. |
| 17 | +This article helps you troubleshoot Datadog agent installation failures on Azure virtual machines and app services when the installation fails because the Datadog API key isn't configured as the default key. |
19 | 18 |
|
20 | 19 | ## Prerequisites |
21 | 20 |
|
22 | | -- Access to the Datadog account that manages API keys (API key admin or owner). |
23 | | -- Access to the Azure portal with permissions to view or configure the Datadog integration and to restart VMs or App Services if required. |
24 | | -- Basic familiarity with the Datadog agent configuration and how to view agent logs on the target OS. |
25 | | - |
26 | | -## Potential quick workarounds |
27 | | - |
28 | | -1. In the Datadog API Keys screen, select an API key as the Default Key and retry the installation. |
29 | | -2. Manually configure the Datadog agent on the VM or App Service with a valid API key and restart the agent. |
30 | | -3. If the installation was attempted from the portal, try using a different browser or an incognito/private window to rule out UI caching issues. |
31 | | - |
32 | | -## Troubleshooting checklist |
33 | | - |
34 | | -Follow these steps in order. After each change, retry the installation or restart the agent and verify telemetry. |
35 | | - |
36 | | -### 1) Verify Default Key in Datadog |
37 | | - |
38 | | -- In the Datadog portal, open API Keys (or the Datadog integration configuration in Azure, if applicable). |
39 | | -- Confirm one API key is marked as the Default Key. The Default Key is used when installing the Datadog agent from the integration screen. |
40 | | -- If no Default Key is selected, select an existing valid API key as the Default Key or create a new key and mark it as default. |
41 | | - |
42 | | -### 2) Re-run the installation from the integration |
43 | | - |
44 | | -- After selecting a Default Key, retry the Datadog agent installation from the Azure Datadog integration screen. |
45 | | -- Wait for the installation to complete and check the installation status or operation logs in the portal. |
46 | | - |
47 | | -### 3) Manually validate agent configuration on the VM/App Service |
48 | | - |
49 | | -- On Linux VMs, check /etc/datadog-agent/datadog.yaml and confirm api_key is present and matches the expected key. |
50 | | -- On Windows VMs, check C:\ProgramData\Datadog\datadog.yaml for the api_key setting. |
51 | | -- For App Services, verify application settings or extension configuration include the correct Datadog API key. |
52 | | - |
53 | | -### 4) Inspect installation and agent logs |
54 | | - |
55 | | -- Review installation logs from the Azure integration or extension operation to see error messages related to missing API key. |
56 | | -- Check Datadog agent logs on the VM for errors about authentication or failed connections to Datadog endpoints. |
57 | | - |
58 | | -### 5) Verify network connectivity |
59 | | - |
60 | | -- Ensure outbound HTTPS (TCP 443) to Datadog ingestion endpoints is allowed by NSGs, firewalls, and proxies. |
61 | | -- Test connectivity from the VM or a jump host (example): |
62 | | - |
63 | | - ```bash |
64 | | - curl -v <api.datadoghq.com> |
65 | | - ``` |
66 | | - |
67 | | -- If a proxy is required, ensure the agent is configured to use the proxy. |
68 | | - |
69 | | -### 6) Retry installation with explicit API key |
70 | | - |
71 | | -- If the portal installation continues to fail, install or configure the agent manually and supply the API key explicitly in the agent configuration file, then start the agent. |
72 | | - |
| 21 | +- Access to the Azure portal with permissions to view or configure the Datadog integration and to restart VMs or app services, if required. |
| 22 | + |
73 | 23 | ## Causes and solutions |
74 | 24 |
|
75 | | -### Cause: No Default API key selected in Datadog |
| 25 | +### Cause: No Default API key is selected |
76 | 26 |
|
77 | | -Solution: |
| 27 | +#### Solution |
78 | 28 |
|
79 | | -1. In the Datadog portal, select an API key as the Default Key in API Keys settings. |
80 | | -2. Retry installation from the Azure integration. |
| 29 | +1. In the Azure portal, go to the Datadog resource. |
| 30 | +1. In the left pane, select **Keys** under **Settings**. |
| 31 | +1. Under **API Keys**, select or create a default key. |
| 32 | +1. Try again to install the agent. |
81 | 33 |
|
82 | 34 | ### Cause: Incorrect API key configured on the resource |
83 | 35 |
|
84 | | -Solution: |
85 | | - |
86 | | -1. Verify the api_key value in the agent configuration file on the VM or App Service. |
87 | | -2. Update the file with the correct key and restart the agent service. |
88 | | - |
89 | | -### Cause: Network or proxy blocking agent outbound traffic |
90 | | - |
91 | | -Solution: |
92 | | - |
93 | | -1. Allow outbound HTTPS to Datadog ingestion endpoints in NSGs, firewalls, or proxy rules. |
94 | | -2. Configure the agent to use the corporate proxy if required. |
95 | | - |
96 | | -### Cause: Installation UI/cache or permission issues |
97 | | - |
98 | | -Solution: |
99 | | - |
100 | | -1. Try the installation from a private browser session or clear browser cache. |
101 | | -2. Confirm the account performing the installation has permissions to use the selected API key and to deploy extensions on the target VM/App Service. |
102 | | - |
103 | | -## Advanced troubleshooting and data collection |
104 | | - |
105 | | -If you need to escalate to Datadog or Azure support, collect the following information: |
106 | | - |
107 | | -- Resource names and IDs for affected VMs or App Services |
108 | | -- Datadog API key ID (do not share the secret key in support requests unless explicitly requested) |
109 | | -- Timestamps (UTC) when installation was attempted |
110 | | -- Installation or extension operation logs from the Azure portal |
111 | | -- Datadog agent logs from the affected resource |
112 | | -- Network test results (curl, Test-NetConnection) showing connectivity to Datadog endpoints |
| 36 | +#### Solution |
113 | 37 |
|
114 | | -When opening a support request, provide a concise description of the steps you already performed and include the items above. |
| 38 | +1. In the Azure portal, go to the Datadog resource. |
| 39 | +1. In the left pane, select, select **Keys** under **Settings**. |
| 40 | +1. Under **API Keys**, change the default key. |
| 41 | +1. Uninstall the Datadog agent and reinstall it. |
115 | 42 |
|
116 | 43 | ## Related content |
117 | 44 |
|
118 | 45 | - [Datadog agent installation docs](https://docs.datadoghq.com/agent/) |
119 | 46 | - [Datadog Azure integration documentation](https://docs.datadoghq.com/integrations/azure/) |
120 | | -- [Manage extensions on Azure virtual machines](https://learn.microsoft.com/azure/virtual-machines/extensions) |
| 47 | +- [Manage extensions on Azure virtual machines](/azure/virtual-machines/extensions/overview) |
0 commit comments