Skip to content

Commit

Permalink
Merge pull request #2497 from MicrosoftDocs/main638714377226529995syn…
Browse files Browse the repository at this point in the history
…c_temp

For protected branch, push strategy should use PR and merge to target branch method to work around git push error
  • Loading branch information
learn-build-service-prod[bot] authored Jan 2, 2025
2 parents 4ddc68f + aee1ceb commit a8a1c36
Show file tree
Hide file tree
Showing 7 changed files with 249 additions and 274 deletions.
6 changes: 6 additions & 0 deletions .openpublishing.publish.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
"branch": "main",
"branch_mapping": {}
},
{
"path_to_root": "reusable-content",
"url": "https://github.com/MicrosoftDocs/reusable-content",
"branch": "main",
"branch_mapping": {}
}
],
"branch_target_mapping": {
Expand Down
10 changes: 10 additions & 0 deletions data-explorer/.openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,16 @@
"source_path": "query-exported-azure-monitor-data.md",
"redirect_url": "/azure/data-explorer/query-monitor-data",
"redirect_document_id": false
},
{
"source_path": "using-metrics.md",
"redirect_url": "/azure/data-explorer/monitor-data-explorer",
"redirect_document_id": true
},
{
"source_path": "using-diagnostic-logs.md",
"redirect_url": "/azure/data-explorer/monitor-data-explorer",
"redirect_document_id": false
}
]
}
83 changes: 83 additions & 0 deletions data-explorer/monitor-data-explorer-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Monitoring data reference for Azure Data Explorer
description: This article contains important reference material you need when you monitor Azure Data Explorer by using Azure Monitor.
ms.date: 12/09/2024
ms.custom: horz-monitor
ms.topic: reference
author: shsagir
ms.author: shsagir
ms.service: azure-data-explorer
---

# Azure Data Explorer monitoring data reference

[!INCLUDE [horz-monitor-ref-intro](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]

See [Monitor Azure Data Explorer](monitor-data-explorer.md) for details on the data you can collect for Azure Data Explorer and how to use it.

[!INCLUDE [horz-monitor-ref-metrics-intro](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]

### Supported metrics for Microsoft.Kusto/clusters

The following table lists the metrics available for the Microsoft.Kusto/clusters resource type.

[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]

[!INCLUDE [Microsoft.Kusto/clusters](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-kusto-clusters-metrics-include.md)]

[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]

[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]

- CommandType
- ComponentName
- ComponentType
- ContinuousExportName
- Database
- FailureKind
- IngestionKind
- IngestionResultDetails
- Kind
- MaterializedViewName
- QueryStatus
- Result
- RoleInstance
- SealReason
- State
- Table

[!INCLUDE [horz-monitor-ref-resource-logs](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]

### Supported resource logs for Microsoft.Kusto/clusters

[!INCLUDE [Microsoft.Kusto/clusters](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-kusto-clusters-logs-include.md)]

[!INCLUDE [horz-monitor-ref-logs-tables](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]

### Azure Data Explorer Microsoft.Kusto/Clusters

- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
- [FailedIngestion](/azure/azure-monitor/reference/tables/failedingestion#columns)

For information about error codes, see [Ingestion error codes](error-codes.md).

- [SucceededIngestion](/azure/azure-monitor/reference/tables/succeededingestion#columns)
- [ADXIngestionBatching](/azure/azure-monitor/reference/tables/adxingestionbatching#columns)

For information about batching types, see [Batching policy](/kusto/management/batching-policy?view=azure-data-explorer&preserve-view=true#sealing-a-batch).

- [ADXCommand](/azure/azure-monitor/reference/tables/adxcommand#columns)
- [ADXQuery](/azure/azure-monitor/reference/tables/adxquery#columns)
- [ADXTableUsageStatistics](/azure/azure-monitor/reference/tables/adxtableusagestatistics#columns)
- [ADXTableDetails](/azure/azure-monitor/reference/tables/adxtabledetails#columns)
- [ADXJournal](/azure/azure-monitor/reference/tables/adxjournal#columns)

[!INCLUDE [horz-monitor-ref-activity-log](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]

- [Analytics resource provider operations](/azure/role-based-access-control/resource-provider-operations#analytics)

## Related content

- See [Monitor Azure Data Explorer](monitor-data-explorer.md) for a description of monitoring Azure Data Explorer.
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.
146 changes: 146 additions & 0 deletions data-explorer/monitor-data-explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
---
title: Monitor Azure Data Explorer
description: Learn how to monitor Azure Data Explorer using Azure Monitor, including data collection, analysis, and alerting.
ms.date: 12/09/2024
ms.custom: horz-monitor
ms.topic: conceptual
author: shsagir
ms.author: shsagir
ms.service: azure-data-explorer
---

# Monitor Azure Data Explorer

[!INCLUDE [azmon-horz-intro](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-intro.md)]

## Collect data with Azure Monitor

This table describes how you can collect data to monitor your service, and what you can do with the data once collected:

|Data to collect|Description|How to collect and route the data|Where to view the data|Supported data|
|---------|---------|---------|---------|---------|
|Metric data|Metrics are numerical values that describe an aspect of a system at a particular point in time. Metrics can be aggregated using algorithms, compared to other metrics, and analyzed for trends over time.|- Collected automatically at regular intervals.</br> - You can route some platform metrics to a Log Analytics workspace to query with other data. Check the **DS export** setting for each metric to see if you can use a diagnostic setting to route the metric data.|[Metrics explorer](/azure/azure-monitor/essentials/metrics-getting-started)| [Azure Data Explorer metrics supported by Azure Monitor](monitor-data-explorer-reference.md#metrics)|
|Resource log data|Logs are recorded system events with a timestamp. Logs can contain different types of data, and be structured or free-form text. You can route resource log data to Log Analytics workspaces for querying and analysis.|[Create a diagnostic setting](/azure/azure-monitor/essentials/create-diagnostic-settings) to collect and route resource log data.| [Log Analytics](/azure/azure-monitor/learn/quick-create-workspace)|[Azure Data Explorer resource log data supported by Azure Monitor](monitor-data-explorer-reference.md#resource-logs) |
|Activity log data|The Azure Monitor activity log provides insight into subscription-level events. The activity log includes information like when a resource is modified or a virtual machine is started.|- Collected automatically.</br> - [Create a diagnostic setting](/azure/azure-monitor/essentials/create-diagnostic-settings) to a Log Analytics workspace at no charge.|[Activity log](/azure/azure-monitor/essentials/activity-log)| |

[!INCLUDE [azmon-horz-supported-data](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-supported-data.md)]

## Built in monitoring for Azure Data Explorer

Azure Data Explorer offers metrics and logs to monitor the service.

### Monitor Azure Data Explorer performance, health, and usage with metrics

Azure Data Explorer metrics provide key indicators as to the health and performance of the Azure Data Explorer cluster resources. Use the metrics to monitor Azure Data Explorer cluster usage, health, and performance in your specific scenario as standalone metrics. You can also use metrics as the basis for operational [Azure Dashboards](/azure/azure-portal/azure-portal-dashboards) and [Azure Alerts](/azure/azure-monitor/alerts/alerts-types#metric-alerts).

To use metrics to monitor your Azure Data Explorer resources in the Azure portal:

1. Sign in to the [Azure portal](https://portal.azure.com/).
1. In the left-hand pane of your Azure Data Explorer cluster, search for *metrics*.
1. Select **Metrics** to open the metrics pane and begin analysis on your cluster.


In the metrics pane, select specific metrics to track, choose how to aggregate your data, and create metric charts to view on your dashboard.

The **Resource** and **Metric Namespace** pickers are preselected for your Azure Data Explorer cluster. The numbers in the following image correspond to the numbered list. They guide you through different options in setting up and viewing your metrics.

:::image type="content" source="media/using-metrics/metrics-pane.png" alt-text="Screenshot shows different options for viewing metrics.":::

1. To create a metric chart, select **Metric** name and relevant **Aggregation** per metric. For more information about different metrics, see [supported Azure Data Explorer metrics](monitor-data-explorer-reference.md#metrics).
1. Select **Add metric** to see multiple metrics plotted in the same chart.
1. Select **+ New chart** to see multiple charts in one view.
1. Use the time picker to change the time range (default: past 24 hours).
1. Use [**Add filter** and **Apply splitting**](/azure/azure-monitor/platform/metrics-getting-started#apply-dimension-filters-and-splitting) for metrics that have dimensions.
1. Select **Pin to dashboard** to add your chart configuration to the dashboards so that you can view it again.
1. Set **New alert rule** to visualize your metrics using the set criteria. The new alerting rule includes your target resource, metric, splitting, and filter dimensions from your chart. Modify these settings in the [alert rule creation pane](/azure/azure-monitor/platform/metrics-charts#create-alert-rules).

### Monitor Azure Data Explorer ingestion, commands, queries, and tables using diagnostic logs

Azure Data Explorer is a fast, fully managed data analytics service for real-time analysis on large volumes of data streaming from applications, websites, IoT devices, and more. [Azure Monitor diagnostic logs](/azure/azure-monitor/platform/diagnostic-logs-overview) provide data about the operation of Azure resources. Azure Data Explorer uses diagnostic logs for insights on ingestion, commands, query, and tables. You can export operation logs to Azure Storage, event hub, or Log Analytics to monitor ingestion, commands, and query status. Logs from Azure Storage and Azure Event Hubs can be routed to a table in your Azure Data Explorer cluster for further analysis.

> [!IMPORTANT]
> Diagnostic log data may contain sensitive data. Restrict permissions of the logs destination according to your monitoring needs.
[!INCLUDE [azure-monitor-vs-log-analytics](includes/azure-monitor-vs-log-analytics.md)]

Diagnostic logs can be used to configure the collection of the following log data:

### [Ingestion](#tab/ingestion)

> [!NOTE]
>
> - Ingestion logs are supported for queued ingestion to the **Data ingestion URI** using [Kusto client libraries](/kusto/api/client-libraries?view=azure-data-explorer&preserve-view=true) and [data connectors](integrate-data-overview.md).
> - Ingestion logs aren't supported for streaming ingestion, direct ingestion to the **Cluster URI**, ingestion from query, or `.set-or-append` commands.
> [!NOTE]
>
> Failed ingestion logs are only reported for the final state of an ingest operation, unlike the [Ingestion result](using-metrics.md#ingestion-metrics) metric, which is emitted for transient failures that are retried internally.
- **Successful ingestion operations**: These logs have information about successfully completed ingestion operations.
- **Failed ingestion operations**: These logs have detailed information about failed ingestion operations including error details.
- **Ingestion batching operations**: These logs have detailed statistics of batches ready for ingestion (duration, batch size, blobs count, and [batching types](/kusto/management/batching-policy?view=azure-data-explorer&preserve-view=true#sealing-a-batch)).

### [Commands and Queries](#tab/commands-and-queries)

- **Commands**: These logs have information about admin commands that have reached a final state.
- **Queries**: These logs have detailed information about queries that have reached a final state.

> [!NOTE]
> The command and query log data contains the query text.
### [Tables](#tab/tables)

- **TableUsageStatistics**: These logs have detailed information about the tables whose extents were scanned during query execution. This log doesn't record statistics for queries that are part of commands, such as the [.set-or-append](/kusto/management/data-ingestion/ingest-from-query?view=azure-data-explorer&preserve-view=true) command.

> [!NOTE]
> The `TableUsageStatistics` log data doesn't contain the command or query text.
- **TableDetails**: These logs have detailed information about the cluster's tables.

### [Journal](#tab/journal)

- **Journal**: These logs have detailed information about metadata operations.

---

You can choose to send the log data to a Log Analytics workspace, a storage account, or stream it to an event hub.

Diagnostic logs are disabled by default. Use the following steps to enable diagnostic logs for your cluster:

1. In the [Azure portal](https://portal.azure.com), select the cluster resource that you want to monitor.
1. Under **Monitoring**, select **Diagnostic settings**.

:::image type="content" source="media/using-diagnostic-logs/add-diagnostic-logs.png" alt-text="Screenshot shows the Diagnostic settings page where you can add a setting.":::

1. Select **Add diagnostic setting**.
1. In the **Diagnostic settings** window:

:::image type="content" source="media/using-diagnostic-logs/configure-diagnostics-settings.png" alt-text="Screenshot of the Diagnostic settings screen, on which you configure which monitoring data to collect for your Azure Data Explorer cluster.":::

1. Enter a **Diagnostic setting name**.
1. Select one or more destination targets: a Log Analytics workspace, a storage account, or an event hub.
1. Select logs to be collected: **Succeeded ingestion**, **Failed ingestion**, **Ingestion batching**, **Command**, **Query**, **Table usage statistics**, **Table details**, or **Journal**.
1. Select [metrics](using-metrics.md#supported-azure-data-explorer-metrics) to be collected (optional).
1. Select **Save** to save the new diagnostic logs settings and metrics.

Once the settings are ready, logs start to appear in the configured destination targets: a storage account, an event hub, or Log Analytics workspace.

> [!NOTE]
> If you send logs to a Log Analytics workspace, the `SucceededIngestion`, `FailedIngestion`, `IngestionBatching`, `Command`, `Query`, `TableUsageStatistics`, `TableDetails`, and `Journal` logs are stored in Log Analytics tables named: `SucceededIngestion`, `FailedIngestion`, `ADXIngestionBatching`, `ADXCommand`, `ADXQuery`, `ADXTableUsageStatistics`, `ADXTableDetails`, and `ADXJournal` respectively.
[!INCLUDE [azmon-horz-tools](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-tools.md)]

[!INCLUDE [azmon-horz-export-data](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-export-data.md)]

[!INCLUDE [azmon-horz-kusto](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-kusto.md)]

[!INCLUDE [azmon-horz-alerts-part-one](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-alerts-part-one.md)]

[!INCLUDE [azmon-horz-alerts-part-two](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-alerts-part-two.md)]

[!INCLUDE [azmon-horz-advisor](~/../reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-advisor.md)]

## Related content

- [Azure Data Explorer monitoring data reference](monitor-data-explorer-reference.md)
- [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource)
8 changes: 4 additions & 4 deletions data-explorer/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -504,11 +504,9 @@ items:
href: dealing-with-duplicates.md
- name: Monitor
items:
- name: Monitor Azure Data Explorer with metrics
- name: Monitor Azure Data Explorer
displayName: health, performance
href: using-metrics.md
- name: Use diagnostic logs to monitor ingestion, commands, queries, and tables
href: using-diagnostic-logs.md
href: monitor-data-explorer.md
- name: Use resource health to monitor cluster health
href: monitor-with-resource-health.md
- name: Use Azure Data Explorer Clusters Insights
Expand Down Expand Up @@ -658,6 +656,8 @@ items:
href: policy-reference.md
- name: Bicep and ARM template resource types
href: /azure/templates/microsoft.kusto/allversions
- name: Monitoring data reference
href: monitor-data-explorer-reference.md
- name: PowerShell Az.Kusto
items:
- name: Use Kusto cmdlets in Azure PowerShell
Expand Down
Loading

0 comments on commit a8a1c36

Please sign in to comment.