Skip to content

Commit 0642a94

Browse files
authored
[Monitor] Documentation updates (Azure#27271)
* Add a section about log retrieval to ingestion README * docs.microsoft.com -> learn.microsoft.com Signed-off-by: Paul Van Eck <[email protected]>
1 parent 33e744c commit 0642a94

File tree

3 files changed

+26
-21
lines changed

3 files changed

+26
-21
lines changed

sdk/monitor/azure-monitor-ingestion/README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,20 @@ Data collection rules (DCR) define data collected by Azure Monitor and specify h
7575

7676
The DCR must understand the structure of the input data and the structure of the target table. If the two don't match, it can use a transformation to convert the source data to match the target table. You may also use the transform to filter source data and perform any other calculations or conversions.
7777

78-
For more details, refer to [Data collection rules in Azure Monitor](https://docs.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview).
78+
For more details, refer to [Data collection rules in Azure Monitor](https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview).
7979

80-
### Log Analytics Workspace Tables
80+
### Log Analytics workspace tables
8181

8282
Custom logs can send data to any custom table that you create and to certain built-in tables in your Log Analytics workspace. The target table must exist before you can send data to it. The following built-in tables are currently supported:
8383

84-
- [CommonSecurityLog](https://docs.microsoft.com/azure/azure-monitor/reference/tables/commonsecuritylog)
85-
- [SecurityEvents](https://docs.microsoft.com/azure/azure-monitor/reference/tables/securityevent)
86-
- [Syslog](https://docs.microsoft.com/azure/azure-monitor/reference/tables/syslog)
87-
- [WindowsEvents](https://docs.microsoft.com/azure/azure-monitor/reference/tables/windowsevent)
84+
- [CommonSecurityLog](https://learn.microsoft.com/azure/azure-monitor/reference/tables/commonsecuritylog)
85+
- [SecurityEvents](https://learn.microsoft.com/azure/azure-monitor/reference/tables/securityevent)
86+
- [Syslog](https://learn.microsoft.com/azure/azure-monitor/reference/tables/syslog)
87+
- [WindowsEvents](https://learn.microsoft.com/azure/azure-monitor/reference/tables/windowsevent)
88+
89+
### Logs retrieval
90+
91+
The logs that were uploaded using this library can be queried using the [Azure Monitor Query][azure_monitor_query] client library.
8892

8993
## Examples
9094

@@ -164,18 +168,19 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
164168

165169
[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions
166170
[azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs
167-
[azure_monitor_create_using_portal]: https://docs.microsoft.com/azure/azure-monitor/logs/quick-create-workspace
168-
[azure_monitor_overview]: https://docs.microsoft.com/azure/azure-monitor/
171+
[azure_monitor_create_using_portal]: https://learn.microsoft.com/azure/azure-monitor/logs/quick-create-workspace
172+
[azure_monitor_overview]: https://learn.microsoft.com/azure/azure-monitor/
173+
[azure_monitor_query]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-query#readme
169174
[azure_subscription]: https://azure.microsoft.com/free/python/
170175
[changelog]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-ingestion/CHANGELOG.md
176+
[data_collection_endpoint]: https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-endpoint-overview
177+
[data_collection_rule]: https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview
171178
[package]: https://aka.ms/azsdk-python-monitor-ingestion-pypi
172179
[pip]: https://pypi.org/project/pip/
173180
[python_logging]: https://docs.python.org/3/library/logging.html
174181
[python-ingestion-ref-docs]: https://aka.ms/azsdk/python/monitor-ingestion/docs
175182
[samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-ingestion/samples
176183
[source]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/monitor/azure-monitor-ingestion/
177-
[data_collection_endpoint]: https://docs.microsoft.com//azure/azure-monitor/essentials/data-collection-endpoint-overview
178-
[data_collection_rule]: https://docs.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview
179184

180185
[cla]: https://cla.microsoft.com
181186
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/

sdk/monitor/azure-monitor-query/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
The Azure Monitor Query client library is used to execute read-only queries against [Azure Monitor][azure_monitor_overview]'s two data platforms:
44

5-
- [Logs](https://docs.microsoft.com/azure/azure-monitor/logs/data-platform-logs) - Collects and organizes log and performance data from monitored resources. Data from different sources such as platform logs from Azure services, log and performance data from virtual machines agents, and usage and performance data from apps can be consolidated into a single [Azure Log Analytics workspace](https://docs.microsoft.com/azure/azure-monitor/logs/data-platform-logs#log-analytics-and-workspaces). The various data types can be analyzed together using the [Kusto Query Language][kusto_query_language].
6-
- [Metrics](https://docs.microsoft.com/azure/azure-monitor/essentials/data-platform-metrics) - Collects numeric data from monitored resources into a time series database. Metrics are numerical values that are collected at regular intervals and describe some aspect of a system at a particular time. Metrics are lightweight and capable of supporting near real-time scenarios, making them particularly useful for alerting and fast detection of issues.
5+
- [Logs](https://learn.microsoft.com/azure/azure-monitor/logs/data-platform-logs) - Collects and organizes log and performance data from monitored resources. Data from different sources such as platform logs from Azure services, log and performance data from virtual machines agents, and usage and performance data from apps can be consolidated into a single [Azure Log Analytics workspace](https://learn.microsoft.com/azure/azure-monitor/logs/data-platform-logs#log-analytics-and-workspaces). The various data types can be analyzed together using the [Kusto Query Language][kusto_query_language].
6+
- [Metrics](https://learn.microsoft.com/azure/azure-monitor/essentials/data-platform-metrics) - Collects numeric data from monitored resources into a time series database. Metrics are numerical values that are collected at regular intervals and describe some aspect of a system at a particular time. Metrics are lightweight and capable of supporting near real-time scenarios, making them particularly useful for alerting and fast detection of issues.
77

88
**Resources:**
99

@@ -20,7 +20,7 @@ The Azure Monitor Query client library is used to execute read-only queries agai
2020

2121
- Python 3.7 or later
2222
- An [Azure subscription][azure_subscription]
23-
- A [TokenCredential](https://docs.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python) implementation, such as an [Azure Identity library credential type](https://docs.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes).
23+
- A [TokenCredential](https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python) implementation, such as an [Azure Identity library credential type](https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes).
2424
- To query Logs, you need an [Azure Log Analytics workspace][azure_monitor_create_using_portal].
2525
- To query Metrics, you need an Azure resource of any kind (Storage Account, Key Vault, Cosmos DB, etc.).
2626

@@ -70,7 +70,7 @@ For examples of Logs and Metrics queries, see the [Examples](#examples) section.
7070

7171
### Logs query rate limits and throttling
7272

73-
The Log Analytics service applies throttling when the request rate is too high. Limits, such as the maximum number of rows returned, are also applied on the Kusto queries. For more information, see [Query API](https://docs.microsoft.com/azure/azure-monitor/service-limits#la-query-api).
73+
The Log Analytics service applies throttling when the request rate is too high. Limits, such as the maximum number of rows returned, are also applied on the Kusto queries. For more information, see [Query API](https://learn.microsoft.com/azure/azure-monitor/service-limits#la-query-api).
7474

7575
If you're executing a batch logs query, a throttled request will return a `LogsQueryError` object. That object's `code` value will be `ThrottledError`.
7676

@@ -435,11 +435,11 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
435435

436436
[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions
437437
[azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs
438-
[azure_monitor_create_using_portal]: https://docs.microsoft.com/azure/azure-monitor/logs/quick-create-workspace
439-
[azure_monitor_overview]: https://docs.microsoft.com/azure/azure-monitor/
438+
[azure_monitor_create_using_portal]: https://learn.microsoft.com/azure/azure-monitor/logs/quick-create-workspace
439+
[azure_monitor_overview]: https://learn.microsoft.com/azure/azure-monitor/
440440
[azure_subscription]: https://azure.microsoft.com/free/python/
441441
[changelog]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-query/CHANGELOG.md
442-
[kusto_query_language]: https://docs.microsoft.com/azure/data-explorer/kusto/query/
442+
[kusto_query_language]: https://learn.microsoft.com/azure/data-explorer/kusto/query/
443443
[package]: https://aka.ms/azsdk-python-monitor-query-pypi
444444
[pip]: https://pypi.org/project/pip/
445445
[python_logging]: https://docs.python.org/3/library/logging.html

sdk/monitor/azure-monitor-query/TROUBLESHOOTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ MetricsQueryClient have methods to set the `credential`. To provide a valid cred
5858
`azure-identity` dependency. For more details on getting started, refer to
5959
the [README](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-query#create-the-client)
6060
of Azure Monitor Query library. You can also refer to
61-
the [Azure Identity documentation](https://docs.microsoft.com/python/api/overview/azure/identity-readme)
61+
the [Azure Identity documentation](https://learn.microsoft.com/python/api/overview/azure/identity-readme)
6262
for more details on the various types of credential supported in `azure-identity`.
6363

6464
For more help on troubleshooting authentication errors please see the Azure Identity client library [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/TROUBLESHOOTING.md).
@@ -82,7 +82,7 @@ sufficient permissions to query the workspace.
8282
```
8383

8484
1. Check that the application or user that is making the request has sufficient permissions:
85-
* You can refer to this document to [manage access to workspaces](https://docs.microsoft.com/azure/azure-monitor/logs/manage-access#manage-access-using-workspace-permissions)
85+
* You can refer to this document to [manage access to workspaces](https://learn.microsoft.com/azure/azure-monitor/logs/manage-access#manage-access-using-workspace-permissions)
8686
2. If the user or application is granted sufficient privileges to query the workspace, make sure you are
8787
authenticating as that user/application. If you are authenticating using the
8888
[DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential)
@@ -110,7 +110,7 @@ Inner error: {
110110
}
111111
```
112112

113-
The error message in the innererror may include the where the Kusto query has an error. You may also refer to the [Kusto Query Language](https://docs.microsoft.com/azure/data-explorer/kusto/query) reference docs to learn more about querying logs using KQL.
113+
The error message in the innererror may include the where the Kusto query has an error. You may also refer to the [Kusto Query Language](https://learn.microsoft.com/azure/data-explorer/kusto/query) reference docs to learn more about querying logs using KQL.
114114

115115
### Troubleshooting empty log query results
116116

@@ -185,7 +185,7 @@ sufficient permissions to query the workspace.
185185
```
186186

187187
1. Check that the application or user that is making the request has sufficient permissions:
188-
* You can refer to this document to [manage access to workspaces](https://docs.microsoft.com/azure/azure-monitor/logs/manage-access#manage-access-using-workspace-permissions)
188+
* You can refer to this document to [manage access to workspaces](https://learn.microsoft.com/azure/azure-monitor/logs/manage-access#manage-access-using-workspace-permissions)
189189
2. If the user or application is granted sufficient privileges to query the workspace, make sure you are
190190
authenticating as that user/application. If you are authenticating using the
191191
[DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential)

0 commit comments

Comments
 (0)