Skip to content

Commit 1220e00

Browse files
authored
Merge pull request #203944 from HeidiSteen/heidist-fresh
[azure search] Monitoring, REST APIs
2 parents d8dc375 + f66bb09 commit 1220e00

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

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

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,33 @@ ms.custom: subject-monitoring
1313

1414
# Monitoring Azure Cognitive Search
1515

16-
When you have critical applications and business processes relying on Azure resources, you want to monitor those resources for their availability, performance, and operation. This article describes the monitoring data generated by Azure Cognitive Search and how to analyze and alert on this data with Azure Monitor.
16+
This article describes the metrics and usage data collected by Azure Cognitive Search. While these metrics are helpful, you can also expand the scope and durability of monitoring and data collection through Azure Monitor.
1717

18-
## Performance and usage data in Azure portal
18+
## Monitoring in Azure portal
1919

20-
In Azure portal, the search service **Overview** page includes a **Monitoring** tab that summarizes key metrics, including query volume, latency, and throttled queries. This data is collected automatically and stored internally for up to 30 days. Data becomes available for analysis as soon as you create the resource.
20+
In the search services pages in Azure portal, you can find current status of service operations and resource availability.
2121

2222
![Azure Monitor integration in a search service](./media/search-monitor-usage/azure-monitor-search.png "Azure Monitor integration in a search service")
2323

24-
Azure portal pages also include a standard **Activity log** page that reports on search activity at the subscription level. Service administration and control plane operations are reflected in the log.
24+
On the **Overview** page, the **Monitoring** tab summarizes key [query metrics](search-monitor-queries.md), including query volume, latency, and throttled queries. This data is collected automatically and stored internally for up to 30 days. Data becomes available for analysis as soon as you create the resource.
2525

26-
The **Usage** tab reports on available capacity and the quantity of indexes, indexers, data sources, and skillsets relative to the maximum allowed for your [service tier](search-sku-tier.md).
26+
On the **Overview** page, the **Usage** tab reports on available capacity and the quantity of indexes, indexers, data sources, and skillsets relative to the maximum allowed for your [service tier](search-sku-tier.md).
27+
28+
From the menu on the left, open the standard **Activity log** page to view search activity at the subscription level. Service administration and control plane operations through Azure Resource Manager are reflected in the activity log.
2729

2830
> [!NOTE]
2931
> Cognitive Search does not monitor individual user access to search data (sometimes referred to as document-level or row-level access). Indexing and query requests originate from a client application that presents either an admin or query API key on the request.
3032
31-
While these metrics are helpful, you might want to expand the scope and durability of monitoring and data collection. Additional data collection is supported through Azure Monitor.
33+
## Get system data from REST APIs
34+
35+
Although query metrics aren't available through REST, the **Usage** data that's visible in the portal can be obtained programmatically:
36+
37+
* [Service Statistics (REST)](/rest/api/searchservice/get-service-statistics)
38+
* [Index Statistics (REST)](/rest/api/searchservice/get-index-statistics)
39+
* [Document Counts (REST)](/rest/api/searchservice/count-documents)
40+
* [Indexer Status (REST)](/rest/api/searchservice/get-indexer-status)
41+
42+
For REST calls, use an [admin API key](search-security-api-keys.md) and [Postman](search-get-started-rest.md) or another REST client to query your search service.
3243

3344
## Expand monitoring with Azure Monitor
3445

@@ -46,15 +57,6 @@ The following sections build on this article by describing the specific data gat
4657

4758
Azure Cognitive Search collects the same kinds of monitoring data as other Azure resources that are described in [Monitoring data from Azure resources](../azure-monitor/essentials/monitor-azure-resource.md). See the [data reference](monitor-azure-cognitive-search-data-reference.md) for detailed information on the metrics and logs metrics created by Azure Cognitive Search.
4859

49-
In addition to the resource logs collected by Azure Monitor, you can also obtain system data from the search service itself, including statistics, counts, and status:
50-
51-
* [Service Statistics (REST)](/rest/api/searchservice/get-service-statistics)
52-
* [Index Statistics (REST)](/rest/api/searchservice/get-index-statistics)
53-
* [Document Counts (REST)](/rest/api/searchservice/count-documents)
54-
* [Indexer Status (REST)](/rest/api/searchservice/get-indexer-status)
55-
56-
The system information above information can also be read from the Azure portal. For REST calls, use an [admin API key](search-security-api-keys.md) and [Postman](search-get-started-rest.md) or another REST client.
57-
5860
## Collection and routing
5961

6062
Platform metrics and the Activity log are collected and stored automatically, but can be routed to other locations by using a diagnostic setting.

0 commit comments

Comments
 (0)