Skip to content

Commit 147df73

Browse files
Merge pull request #251534 from bwren/docs-editor/data-collector-api-1694722932
Data Collector API deprecation notice
2 parents 2efbd67 + f29775f commit 147df73

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

articles/azure-monitor/logs/data-collector-api.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ ms.topic: conceptual
55
author: bwren
66
ms.author: bwren
77
ms.date: 08/08/2023
8-
98
---
109

11-
# Send log data to Azure Monitor by using the HTTP Data Collector API (preview)
10+
# Send log data to Azure Monitor by using the HTTP Data Collector API (deprecated)
1211

1312
This article shows you how to use the HTTP Data Collector API to send log data to Azure Monitor from a REST API client. It describes how to format data that's collected by your script or application, include it in a request, and have that request authorized by Azure Monitor. We provide examples for Azure PowerShell, C#, and Python.
1413

1514
> [!NOTE]
16-
> The Azure Monitor HTTP Data Collector API is in public preview.
15+
> The Azure Monitor HTTP Data Collector API has been deprecated and will no longer be functional as of 9/18/2026. It's been replaced by the [Logs ingestion API](logs-ingestion-api-overview.md).
1716
1817
## Concepts
1918
You can use the HTTP Data Collector API to send log data to a Log Analytics workspace in Azure Monitor from any client that can call a REST API. The client might be a runbook in Azure Automation that collects management data from Azure or another cloud, or it might be an alternative management system that uses Azure Monitor to consolidate and analyze log data.
@@ -56,15 +55,17 @@ Any request to the Azure Monitor HTTP Data Collector API must include an authori
5655

5756
Here's the format for the authorization header:
5857

59-
```
58+
59+
```sql
6060
Authorization: SharedKey <WorkspaceID>:<Signature>
6161
```
6262

6363
*WorkspaceID* is the unique identifier for the Log Analytics workspace. *Signature* is a [Hash-based Message Authentication Code (HMAC)](/dotnet/api/system.security.cryptography.hmacsha256) that's constructed from the request and then computed by using the [SHA256 algorithm](/dotnet/api/system.security.cryptography.sha256). Then, you encode it by using Base64 encoding.
6464

6565
Use this format to encode the **SharedKey** signature string:
6666

67-
```
67+
68+
```ruby
6869
StringToSign = VERB + "\n" +
6970
Content-Length + "\n" +
7071
Content-Type + "\n" +
@@ -74,13 +75,15 @@ StringToSign = VERB + "\n" +
7475

7576
Here's an example of a signature string:
7677

77-
```
78+
79+
```ruby
7880
POST\n1024\napplication/json\nx-ms-date:Mon, 04 Apr 2016 08:00:00 GMT\n/api/logs
7981
```
8082

8183
When you have the signature string, encode it by using the HMAC-SHA256 algorithm on the UTF-8-encoded string, and then encode the result as Base64. Use this format:
8284

83-
```
85+
86+
```sql
8487
Signature=Base64(HMAC-SHA256(UTF8(StringToSign)))
8588
```
8689

@@ -166,7 +169,6 @@ The following properties are reserved and shouldn't be used in a custom record t
166169
- TimeGenerated
167170
- RawData
168171

169-
170172
## Data limits
171173
The data posted to the Azure Monitor Data collection API is subject to certain constraints:
172174

@@ -568,6 +570,7 @@ public class ApiExample {
568570

569571
```
570572

573+
571574
---
572575

573576
## Alternatives and considerations
@@ -581,7 +584,9 @@ Although the Data Collector API should cover most of your needs as you collect f
581584
| [Azure Data Explorer](/azure/data-explorer/ingest-data-overview) | Azure Data Explorer, now generally available to the public, is the data platform that powers Application Insights Analytics and Azure Monitor Logs. By using the data platform in its raw form, you have complete flexibility (but require the overhead of management) over the cluster (Kubernetes role-based access control (RBAC), retention rate, schema, and so on). Azure Data Explorer provides many [ingestion options](/azure/data-explorer/ingest-data-overview#ingestion-methods), including [CSV, TSV, and JSON](/azure/kusto/management/mappings) files. | <ul><li> Data that won't be correlated with any other data under Application Insights or Monitor Logs. </li><li> Data that requires advanced ingestion or processing capabilities that aren't available today in Azure Monitor Logs. </li></ul> |
582585

583586

587+
584588
## Next steps
585589
- Use the [Log Search API](./log-query-overview.md) to retrieve data from the Log Analytics workspace.
586590

587591
- Learn more about how to [create a data pipeline with the Data Collector API](create-pipeline-datacollector-api.md) by using a Logic Apps workflow to Azure Monitor.
592+

0 commit comments

Comments
 (0)