Skip to content

Commit 301db02

Browse files
Merge pull request #2558 from HeidiSteen/heidist-monitor
[azure search] Added enable diagnostic settings section
2 parents f428e7b + a743c73 commit 301db02

File tree

3 files changed

+31
-5
lines changed

3 files changed

+31
-5
lines changed

articles/search/monitor-azure-cognitive-search.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,42 @@ title: Monitor Azure AI Search
33
description: Start here to learn how to monitor Azure AI Search.
44
ms.date: 01/27/2025
55
ms.custom: horz-monitor
6-
ms.topic: conceptual
6+
ms.topic: how-to
77
author: HeidiSteen
88
ms.author: heidist
99
ms.service: azure-ai-search
1010
---
1111

1212
# Monitor Azure AI Search
1313

14-
[!INCLUDE [horz-monitor-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-intro.md)]
14+
This article explains how to configure logging and where to find information about search service operations.
15+
16+
## Enable diagnostic logging
17+
18+
Resource logging is available through Azure Monitor. Although some search service activity is reported automatically with no upfront configuration, resource logs about operations and data access require that you create a diagnostic setting and specify a storage option.
19+
20+
If you create more than one diagnostic setting, you must have different destinations for each one.
21+
22+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your search service.
23+
24+
1. Under **Monitoring** > **Diagnostic settings**, select **Add diagnostic setting**.
25+
26+
1. Provide a name that identifies the service and level of logging, such as "my-search-service-all-logs" or "my-search-service-audit-logs".
27+
28+
1. Under **Logs**, choose a category:
29+
30+
- **audit** to capture information about user and group identity access to content and operations
31+
- **Operation Logs** to capture information about operations on a search service.
32+
- **allLogs** to collect everything.
33+
34+
Verbose logging can be expensive to store and complex to manage and store. You might want to start with **allLogs** and then switch to more scoped logging if it meets your information requirements.
35+
36+
1. For a destination, we recommend **Send to Log Analytics workspace** so that you can run Kusto queries against the data.
37+
38+
1. Save the settings.
1539

1640
> [!NOTE]
17-
> Azure AI Search doesn't monitor individual user access to content on the search service. If you require this level of monitoring, you need to implement it in your client application.
41+
> If you're using [key-based authentication](search-security-api-keys.md), Azure AI Search can't monitor individual user access to content on the search service. If you require this level of monitoring, you need to implement it in your client application.
1842
1943
[!INCLUDE [horz-monitor-resource-types](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-resource-types.md)]
2044

@@ -35,6 +59,8 @@ For the available resource log categories, their associated Log Analytics tables
3559

3660
In Azure AI Search, activity logs reflect control plane activity such as service creation and configuration, or API key usage or management. Entries often include **Get Admin Key**, one entry for every call that [provided an admin API key](search-security-api-keys.md) on the request. There are no details about the call itself, just a notification that the admin key was used.
3761

62+
API keys can be disabled for data plane operations, such as creating or querying an index, but on the control plane they're used in the Azure portal to return service information.
63+
3864
The following screenshot shows Azure AI Search activity log signals you can configure in an alert.
3965

4066
:::image type="content" source="media/search-monitor-usage/activity-log-signals.png" alt-text="Screenshot of the activity log signals that can be used in an alert." border="true":::

articles/search/search-manage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Some features add to the cost of running the service:
9898

9999
### Enable diagnostic logging
100100

101-
[Enable diagnostic logging](monitor-azure-cognitive-search.md) to track user activity. If you skip this step, you still get [activity logs](/azure/azure-monitor/essentials/activity-log) and [platform metrics](/azure/azure-monitor/essentials/data-platform-metrics#types-of-metrics) automatically, but if you want index and query usage information, you should enable diagnostic logging and choose a destination for logged operations.
101+
[Enable diagnostic logging](monitor-azure-cognitive-search.md#enable-diagnostic-logging) to track user activity. If you skip this step, you still get [activity logs](/azure/azure-monitor/essentials/activity-log) and [platform metrics](/azure/azure-monitor/essentials/data-platform-metrics#types-of-metrics) automatically, but if you want index and query usage information, you should enable diagnostic logging and choose a destination for logged operations.
102102

103103
We recommend Log Analytics Workspace for durable storage so that you can run system queries in the Azure portal.
104104

articles/search/vector-search-how-to-configure-vectorizer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Vectorizers are now generally available as long as you use a generally available
3434

3535
+ [Visual Studio Code](https://code.visualstudio.com/download) with a [REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) to send the query and accept a response.
3636

37-
We recommend that you enable diagnostic logging on your search service to confirm vector query execution.
37+
We recommend that you [enable diagnostic logging](monitor-azure-cognitive-search.md#enable-diagnostic-logging) on your search service to confirm vector query execution.
3838

3939
## Supported embedding models
4040

0 commit comments

Comments
 (0)