Download PDF
Download page Azure Cognitive Search.
Azure Cognitive Search
Azure Cognitive Search is an AI-powered information retrieval platform used to build mobile and web applications.
You must configure cloud connections to monitor this entity. See Configure Azure Cloud Connection.
Cisco Cloud Observability displays Azure entities on the Observe page. Metrics are displayed for specific entity instances in the list and detail views.
This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.
Detail View
To display the detail view for an Azure Cognitive Search instance:
- Navigate to the Observe page.
- Under Analytics, click Azure Cognitive Search.
The list view now displays. - Click an instance Name to display the detail view.
The detail view displays metrics, key performance indicators, and properties (attributes) related to the instance you selected.
Metrics and Key Performance Indicators
Cisco Cloud Observability displays the following metrics and key performance indicators (KPIs) for Azure Cognitive Search. See Supported metrics for Microsoft.Search/searchServices.
| Display Name | Source Metric Name | Description |
| Document Processed Count |
| Total of the number of documents successfully processed in an indexing operation (either by an indexer or by pushing documents directly). |
| Search Latency (s) |
| Average search latency for queries that execute on the search service. |
| Search Queries Per Second | SearchQueriesPerSecond | 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 will appear in a metric like QPS. The minimum is the lowest value for search queries per second that was registered during that minute. The same applies to the maximum value. Average is the aggregate across the entire minute. 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. |
| Throttled Search Queries Percentage | ThrottledSearchQueriesPercentage | Average percentage of the search queries that were throttled from the total number of search queries that executed during a one-minute interval. |
| Skill Execution Invocation Count | SkillExecutionCount | Total number of skill executions processed during an indexer operation. |
Properties (Attributes)
Cisco Cloud Observability displays the following properties for Azure Cognitive Search.
| Display Name | Property Name | Description |
|---|---|---|
| API Key Authentication Failure Mode | azure.cognitive_search.auth_options.aad_or_api_key.aad_auth_failure_mode | Specifies the behavior when Azure Active Directory (AAD) authentication fails or when an API key is not provided. Possible values are 'Default'; (default behavior), 'Unauthorized; (return a 401 Unauthorized error), or 'NotFound; (return a 404 Not Found error). |
| Disable Local Authentication | azure.cognitive_search.disable_local_auth | A boolean value that indicates whether local authentication is disabled for the search service. |
| Encryption Compliance Status | azure.cognitive_search.encryption_with_cmk.encryption_compliance_status | Indicates the compliance status of the search service encryption. Possible values are 'Compliant', 'NonCompliant', or 'Unknown'. |
| Encryption with customer-managed key enforcement | azure.cognitive_search.encryption_with_cmk.enforcement | Specifies whether encryption with a customer-managed key (CMK) is enforced for the search service. Possible values are 'Enabled' or 'Disabled'. |
| Hosting Mode | azure.cognitive_search.hosting_mode | Specifies the hosting mode of the search service. Possible values are 'Default' and 'HighDensity'. |
| Network Rule Set Bypass | azure.cognitive_search.network_rule_set.bypass | Specifies whether the network rule set is bypassed for traffic to the search service. Possible values are 'AzureServices' to allow traffic only from Azure services, and 'None' to not bypass the network rule set. |
| Partition Count | azure.cognitive_search.partition_count | Specifies the number of partitions in the search service. The default value is 1. |
| Provisioning State | azure.cognitive_search.provisioning_state | Indicates the current provisioning state of the search service. Possible values are 'Succeeded', 'Failed', 'Canceled', 'Creating', 'Deleting', 'Updating', 'Suspended', or 'Resuming'. |
| Public Network Access | azure.cognitive_search.public_network_access | Specifies whether the search service is accessible from the public internet. Possible values are 'enabled' and 'disabled'. |
| Replica Count | azure.cognitive_search.replica_count | The number of replicas for the search service. |
| Status | azure.cognitive_search.status | The status of the search service. |
| Status Details | azure.cognitive_search.status_details | Specifies additional details about the status of the search service. |
| Name | azure.name | The Resource Name of the Azure Resource. |
| Resource Group | azure.resource.group | The resource group of the Azure Resource. |
| Resource ID | azure.resource.id | The fully qualified ID of the Azure Resource. |
| Account ID | cloud.account.id | The cloud account ID the resource is assigned to. |
| Platform | cloud.platform | The cloud platform in use. |
| Region | cloud.region | The location of the Azure Function resource. |
Retention and Purge Time-To-Live (TTL)
For all cloud and infrastructure entities, the retention TTL is 180 minutes (3 hours) and the purge TTL is 525,600 minutes (365 days).
Microsoft Azure, the Microsoft Azure logo, Azure, and any other Microsoft Azure Marks used in these materials are trademarks of Microsoft Corporation or its affiliates in the United States and/or other countries.