Skip to content

Commit 61fe5f0

Browse files
committed
updated troubleshooting and best practices section
1 parent b7fdc1d commit 61fe5f0

File tree

3 files changed

+77
-77
lines changed

3 files changed

+77
-77
lines changed

docs/integrations/microsoft-azure/azure-api-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,4 @@ import AppUninstall from '../../reuse/apps/app-uninstall.md';
175175

176176
### HTTP Logs and Metrics Source used by Azure Functions
177177

178-
To troubleshoot metrics collection, follow the instructions in [Troubleshooting Azure Metrics Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#troubleshooting-azure-metrics-source).
178+
To troubleshoot metrics collection, follow the instructions in [Troubleshooting Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source/#troubleshooting).

docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor.md

Lines changed: 0 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -110,81 +110,6 @@ To verify that events are appearing in your event hub:
110110
1. Go to **Resource groups**, and select the resource group you created or selected in [Step 2. Configure Azure resources using ARM Template](#step-2-configure-azure-resources-using-arm-template). Search for `SMAppInsights`. You should find the `SMAppInsights<random-string>` Application Insights. Click it.
111111
1. In the left panel under **Investigate** click on **Failures**. Click on **Count** column on the rightmost panel, it will take you to the trace, select any trace and see the exception message.<br/><img src={useBaseUrl('/img/send-data/azure-metrics/smappinsightfailures.png')} alt="Application insights" style={{border: '1px solid gray'}} width="800" />
112112

113-
## Troubleshooting Azure Metrics Source
114-
115-
### Unable to authenticate to Azure
116-
117-
During Source creation, if you encounter errors such as `Unable to get subscriptions. Please check credentials.` or `Unable to authenticate to Azure`, please verify that your credentials are valid in the Azure portal.
118-
119-
Follow the steps below to solve this issue:
120-
1. Log in to the Azure Portal.
121-
1. Navigate to App registrations and locate the App that was created during the **Deploy to Azure** process.
122-
1. Go to **Certificates & Secrets**.
123-
1. Ensure that a valid **Client Secret** exists. If no secret is present or the existing one has expired, create a new Client Secret.
124-
1. Retry the Source creation process using the updated credentials.
125-
126-
### Subscriptions not present in the View Subscriptions list
127-
128-
If the **View Subscriptions** list does not include expected Azure subscriptions, you can verify that the credentials have sufficient permission to read from the expected subscription. Another possible cause could be a propagation delay. After creating a new app or client secret, Azure may take up to 10 minutes to reflect the changes across its services. Please wait a few minutes and refresh the list.
129-
130-
Follow the steps below to verify and assign proper permissions:
131-
1. In the Azure portal, navigate to **Subscriptions**.
132-
1. Select the target subscription.
133-
1. Go to **Access Control (IAM)** > **Role assignments**.
134-
1. Confirm that the App created during the **Deploy to Azure** step is listed.
135-
1. Ensure it is assigned the **Monitoring Reader** role.
136-
137-
### Missing metrics in Sumo Logic
138-
139-
Azure Monitor displays all metrics, even those without data, but Sumo Logic only collects metrics with actual datapoints.
140-
If you know that certain metrics in Azure contain actual data (non-empty values) and you expected those metrics to appear in Sumo Logic, but they are missing, it’s recommended to reach out to Sumo Logic Support to resolve the issue.
141-
142-
### API throttling by Microsoft
143-
144-
If API requests to Azure are being throttled, resulting in failed or delayed metric ingestion, please review and follow the guidance in the [Best Practices](#best-practices-for-azure-metrics-source) section for reducing the frequency and volume of API calls.
145-
If you continue to experience throttling, please reach out to Sumo Logic Support for assistance.
146-
147-
## Best practices for Azure Metrics Source
148-
149-
The Sumo Logic Azure Metrics Source uses the Azure Monitor API to retrieve metrics from your Azure environment. Following the best practices below will help reduce the number of API requests, avoid hitting Microsoft’s API throttling limits, and ensure efficient and reliable metric collection.
150-
151-
### Limit one source per subscription
152-
153-
Microsoft enforces API throttling for each subscription. Since each Sumo Logic Azure Metrics Source sends independent requests to the Azure Monitor API, Sumo Logic strongly recommends you to use only one Azure Metrics Source per Azure subscription.
154-
155-
note: A single Sumo Logic Source can collect metrics from multiple Azure subscriptions without issue. However, avoid assigning more than one Source to collect from the same subscription, as this may lead to throttling.
156-
157-
### Increase the scan interval to reduce API load
158-
159-
The scan interval determines how often the Azure Metrics Source queries the Azure Monitor API. Adjusting this interval can significantly impact API usage:
160-
- Shorter scan intervals (e.g., 1 minute) result in more frequent API calls.
161-
- Longer scan intervals reduce the request rate, helping to avoid throttling—especially in environments with a high number of resources.
162-
163-
### Recommended scan interval guidelines
164-
165-
| Scan Interval | Maximum Resources per Subscription | Maximum VMs per Subscription for Virtual Machine Guest metrics |
166-
|:--|:--|:--|
167-
| 1 minute | 20,000 (3,000 for users on Azure Sovereign Cloud) | 600 (80 for users on Azure Sovereign Cloud) |
168-
| 5 minutes | 100,000 (15,000 for users on Azure Sovereign Cloud)| 3,000 (400 for users on Azure Sovereign Cloud) |
169-
170-
For a larger number of resources, increase the scan interval further using the Sumo Logic Source Management API.
171-
172-
note: Increasing the scan interval does not reduce metric granularity. The frequency of data collection changes, but the resolution of data points remains unaffected.
173-
174-
### Estimate API request rate per subscription
175-
176-
The API request rate for the Azure Metrics Source depends on the scan interval and the number of resources in a subscription. Since Microsoft enforces API throttling per subscription, you can estimate the rate of requests made per subscription using the following formula:
177-
178-
`(CEILING((T / 50) / N) * N * (180 / S)) + (V * (144 / S))`
179-
180-
Where,
181-
T = Total number of non-VM resources
182-
V = Total number of VMs (only for users collecting Virtual Machine Guest metrics)
183-
N = Number of distinct namespaces with active resources
184-
S = Scan Interval (in minutes)
185-
186-
Understanding this rate helps you proactively configure your Sources to stay within Microsoft’s service limits and avoid interruptions due to throttling.
187-
188113
## Common errors
189114

190115
For common error messages, refer [Event Hub export error messages](/docs/send-data/collect-from-other-data-sources/azure-monitoring/arm-integration-faq#event-hub-export-error-messages) section.

docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ To configure the Azure Metrics Source:
6767
1. **Processing Rules for Metrics (Optional)**. Configure any desired filters, such as allowlist and denylist, as described in [Metrics Include and Exclude Rules](/docs/send-data/collection/processing-rules/metrics-include-and-exclude-rules).
6868
![filtersprocessingrules.png](/img/send-data/filtersprocessingrules.png)
6969

70-
## JSON configuration
70+
## JSON schema
7171

7272
### Configuration Object
7373

@@ -91,3 +91,78 @@ To configure the Azure Metrics Source:
9191
```json reference
9292
https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/azure-metrics/example.json
9393
```
94+
95+
## Troubleshooting
96+
97+
### Unable to authenticate to Azure
98+
99+
During Source creation, if you encounter errors such as `Unable to get subscriptions. Please check credentials.` or `Unable to authenticate to Azure`, please verify that your credentials are valid in the Azure portal.
100+
101+
Follow the steps below to solve this issue:
102+
1. Log in to the Azure Portal.
103+
1. Navigate to App registrations and locate the App that was created during the **Deploy to Azure** process.
104+
1. Go to **Certificates & Secrets**.
105+
1. Ensure that a valid **Client Secret** exists. If no secret is present or the existing one has expired, create a new Client Secret.
106+
1. Retry the Source creation process using the updated credentials.
107+
108+
### Subscriptions not present in the View Subscriptions list
109+
110+
If the **View Subscriptions** list does not include expected Azure subscriptions, you can verify that the credentials have sufficient permission to read from the expected subscription. Another possible cause could be a propagation delay. After creating a new app or client secret, Azure may take up to 10 minutes to reflect the changes across its services. Please wait a few minutes and refresh the list.
111+
112+
Follow the steps below to verify and assign proper permissions:
113+
1. In the Azure portal, navigate to **Subscriptions**.
114+
1. Select the target subscription.
115+
1. Go to **Access Control (IAM)** > **Role assignments**.
116+
1. Confirm that the App created during the **Deploy to Azure** step is listed.
117+
1. Ensure it is assigned the **Monitoring Reader** role.
118+
119+
### Missing metrics in Sumo Logic
120+
121+
Azure Monitor displays all metrics, even those without data, but Sumo Logic only collects metrics with actual datapoints.
122+
If you know that certain metrics in Azure contain actual data (non-empty values) and you expected those metrics to appear in Sumo Logic, but they are missing, it’s recommended to reach out to Sumo Logic Support to resolve the issue.
123+
124+
### API throttling by Microsoft
125+
126+
If API requests to Azure are being throttled, resulting in failed or delayed metric ingestion, please review and follow the guidance in the [Best Practices](#best-practices) section for reducing the frequency and volume of API calls.
127+
If you continue to experience throttling, please reach out to Sumo Logic Support for assistance.
128+
129+
## Best practices
130+
131+
The Sumo Logic Azure Metrics Source uses the Azure Monitor API to retrieve metrics from your Azure environment. Following the best practices below will help reduce the number of API requests, avoid hitting Microsoft’s API throttling limits, and ensure efficient and reliable metric collection.
132+
133+
### Limit one source per subscription
134+
135+
Microsoft enforces API throttling for each subscription. Since each Sumo Logic Azure Metrics Source sends independent requests to the Azure Monitor API, Sumo Logic strongly recommends you to use only one Azure Metrics Source per Azure subscription.
136+
137+
note: A single Sumo Logic Source can collect metrics from multiple Azure subscriptions without issue. However, avoid assigning more than one Source to collect from the same subscription, as this may lead to throttling.
138+
139+
### Increase the scan interval to reduce API load
140+
141+
The scan interval determines how often the Azure Metrics Source queries the Azure Monitor API. Adjusting this interval can significantly impact API usage:
142+
- Shorter scan intervals (e.g., 1 minute) result in more frequent API calls.
143+
- Longer scan intervals reduce the request rate, helping to avoid throttling—especially in environments with a high number of resources.
144+
145+
### Recommended scan interval guidelines
146+
147+
| Scan Interval | Maximum Resources per Subscription | Maximum VMs per Subscription for Virtual Machine Guest metrics |
148+
|:--|:--|:--|
149+
| 1 minute | 20,000 (3,000 for users on Azure Sovereign Cloud) | 600 (80 for users on Azure Sovereign Cloud) |
150+
| 5 minutes | 100,000 (15,000 for users on Azure Sovereign Cloud)| 3,000 (400 for users on Azure Sovereign Cloud) |
151+
152+
For a larger number of resources, increase the scan interval further using the Sumo Logic Source Management API.
153+
154+
note: Increasing the scan interval does not reduce metric granularity. The frequency of data collection changes, but the resolution of data points remains unaffected.
155+
156+
### Estimate API request rate per subscription
157+
158+
The API request rate for the Azure Metrics Source depends on the scan interval and the number of resources in a subscription. Since Microsoft enforces API throttling per subscription, you can estimate the rate of requests made per subscription using the following formula:
159+
160+
`(CEILING((T / 50) / N) * N * (180 / S)) + (V * (144 / S))`
161+
162+
Where,
163+
T = Total number of non-VM resources
164+
V = Total number of VMs (only for users collecting Virtual Machine Guest metrics)
165+
N = Number of distinct namespaces with active resources
166+
S = Scan Interval (in minutes)
167+
168+
Understanding this rate helps you proactively configure your Sources to stay within Microsoft’s service limits and avoid interruptions due to throttling.

0 commit comments

Comments
 (0)