Skip to content

Commit db3886f

Browse files
committed
add section, update links
1 parent 648372a commit db3886f

File tree

2 files changed

+46
-31
lines changed

2 files changed

+46
-31
lines changed

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

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Monitoring data reference for Azure AI Search
33
description: This article contains important reference material you need when you monitor Azure AI Search.
4-
ms.date: 02/08/2024
4+
ms.date: 02/15/2024
55
ms.custom: horz-monitor
66
ms.topic: reference
77
author: HeidiSteen
@@ -37,25 +37,25 @@ At a minimum your service should have the following two articles:
3737
# Azure AI Search monitoring data reference
3838

3939
<!-- Intro. Required. -->
40-
[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
40+
[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
4141

4242
See [Monitor Azure AI Search](monitor-azure-cognitive-search.md) for details on the data you can collect for Azure AI Search and how to use it.
4343

4444
<!-- ## Metrics. Required section. -->
45-
[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
45+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
4646

4747
<!-- Repeat the following section for each resource type/namespace in your service. -->
4848
### Supported metrics for Microsoft.Search/searchServices
4949
The following table lists the metrics available for the Microsoft.Search/searchServices resource type.
50-
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
50+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
5151
[!INCLUDE [Microsoft.Search/searchServices](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-search-searchservices-metrics-include.md)]
5252

5353
SearchQueriesPerSecond shows the average of the search queries per second (QPS) for the search service. It's common for queries to execute in milliseconds, so only queries that measure as seconds appear in a metric like QPS. The minimum is the lowest value for search queries per second that was registered during that minute. Maximum is the highest value. Average is the aggregate across the entire minute.
5454

5555
For example, within one minute, you might have a pattern like this: one second of high load that is the maximum for SearchQueriesPerSecond, followed by 58 seconds of average load, and finally one second with only one query, which is the minimum.
5656

5757
<!-- ## Metric dimensions. Required section. -->
58-
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
58+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
5959

6060
Azure AI Search has the following dimensions associated with the metrics that capture a count of documents or skills that were executed, "Document processed count" and "Skill execution invocation count".
6161

@@ -70,15 +70,15 @@ Azure AI Search has the following dimensions associated with the metrics that ca
7070
| **SkillType** | The @odata.type of the skill. |
7171

7272
<!-- ## Resource logs. Required section. -->
73-
[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
73+
[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
7474

7575
<!-- Add at least one resource provider/resource type here. Example: ### Supported resource logs for Microsoft.Storage/storageAccounts/blobServices
7676
Repeat this section for each resource type/namespace in your service. -->
7777
### Supported resource logs for Microsoft.Search/searchServices
7878
[!INCLUDE [Microsoft.Search/searchServices](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-search-searchservices-logs-include.md)]
7979

8080
<!-- ## Azure Monitor Logs tables. Required section. -->
81-
[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
81+
[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
8282
### Search Services
8383
Microsoft.Search/searchServices
8484

@@ -88,8 +88,24 @@ Microsoft.Search/searchServices
8888
| [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics) | Logged query and indexing operations. Queries against the AzureDiagnostics table in Log Analytics can include the common properties, the [search-specific properties](#resource-log-search-props), and the [search-specific operations](#resource-log-search-ops) listed in the schema reference section. |
8989
| [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics) | Metric data emitted by Azure AI Search that measures health and performance. |
9090

91+
### Resource log tables
92+
93+
The following table lists the properties of resource logs in Azure AI Search. The resource logs are collected into Azure Monitor Logs or Azure Storage. In Azure Monitor, logs are collected in the AzureDiagnostics table under the resource provider name of `Microsoft.Search`.
94+
95+
| Azure Storage field or property | Azure Monitor Logs property | Description |
96+
|-|-|-|
97+
| time | TIMESTAMP | The date and time (UTC) when the operation occurred. |
98+
| resourceId | Concat("/", "/subscriptions", SubscriptionId, "resourceGroups", ResourceGroupName, "providers/Microsoft.Search/searchServices", ServiceName) | The Azure AI Search resource for which logs are enabled. |
99+
| category | "OperationLogs" | Log categories include `Audit`, `Operational`, `Execution`, and `Request`. |
100+
| operationName | Name | Name of the operation. The operation name can be `Indexes.ListIndexStatsSummaries`, `Indexes.Get`, `Indexes.Stats`, `Indexers.List`, `Query.Search`, `Query.Suggest`, `Query.Lookup`, `Query.Autocomplete`, `CORS.Preflight`, `Indexes.Update`, `Indexes.Prototype`, `ServiceStats`, `DataSources.List`, `Indexers.Warmup`. |
101+
| durationMS | DurationMilliseconds | The duration of the operation, in milliseconds. |
102+
| operationVersion | ApiVersion | The API version used on the request. |
103+
| resultType | (Failed) ? "Failed" : "Success" | The type of response. |
104+
| resultSignature | Status | The HTTP response status of the operation. |
105+
| properties | Properties | Any extended properties related to this category of events. |
106+
91107
<!-- ## Activity log. Required section. -->
92-
[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
108+
[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
93109

94110
The following table lists common operations related to Azure AI Search that may be recorded in the activity log. For a complete listing of all Microsoft.Search operations, see [Microsoft.Search resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftsearch).
95111

@@ -108,14 +124,13 @@ If there are other operations not in the link, list them here in table form. -->
108124

109125
<!-- ## Other schemas. Optional section. Please keep heading in this order. If your service uses other schemas, add the following include and information. -->
110126
<a name="schemas"></a>
111-
[!INCLUDE [horz-monitor-ref-other-schemas](~/articles/reusable-content/azure-monitor/horizontals/horz-monitor-ref-other-schemas.md)]
127+
[!INCLUDE [horz-monitor-ref-other-schemas](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-other-schemas.md)]
112128
<!-- List other schemas and their usage here. These can be resource logs, alerts, event hub formats, etc. depending on what you think is important. You can put JSON messages, API responses not listed in the REST API docs, and other similar types of info here. -->
113129
If you're building queries or custom reports, the data structures that contain Azure AI Search resource logs conform to the following schemas.
114130

115131
For resource logs sent to blob storage, each blob has one root object called **records** containing an array of log objects. Each blob contains records for all the operations that took place during the same hour.
116132

117133
<a name="resource-log-schema"></a>
118-
119134
### Resource log schema
120135

121136
All resource logs available through Azure Monitor share a [common top-level schema](/azure/azure-monitor/essentials/resource-logs-schema#top-level-common-schema). Azure AI Search supplements with [more properties](#resource-log-search-props) and [operations](#resource-log-search-ops) that are unique to a search service.

0 commit comments

Comments
 (0)