Description
OpenSearch provides four categories of statistical metrics for user application data: core metrics, traffic metrics, user analysis metrics, and query analysis metrics.
Core metrics
Metric | Definition | Calculation method | Dependency | Description |
PVs | The number of successful search requests, including paging requests. PV is the abbreviation for page view. | Counts each search request for which a success response is returned. | N/A | Calculates the number of successful search requests on the current day. |
UVs | The number of users who have visited search results pages. UV is the abbreviation for unique visitor. | Counts each user only once regardless of how many times the user has visited search results pages. | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Calculates the number of users who have sent search requests on the current day. |
Paging Rate | The percentage of successful paging requests to all the successful search requests. | Divides the number of successful paging requests by PVs. | N/A | Calculates the percentage of successful paging requests to all the successful search requests to assess the effects of search retrieval and search results sorting. |
Zero-result Rate | The percentage of search requests whose search results contain no items to all the successful search requests. | Divides the number of search requests whose search results contain no items by PVs. | N/A | Calculates the percentage of search requests whose search results contain no items to all the successful search requests to assess the effect and content diversity of search retrieval. |
Average PVs per User | The average number of successful search requests per user. | Divides PVs by UVs. | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Calculates the average number of successful search requests per user. More search requests indicate that users are interested in searching but often need to search for many times to obtain the expected results. |
User Retention Rate on Next Day | The percentage of users who have sent search requests for two consecutive days to users who sent search requests on the previous day. | Divides the intersection of UVs (t-1) and UVs (t) by UVs (t-1). | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Indicates user stickiness. |
Traffic metrics
Metric | Definition | Calculation method | Dependency | Description |
PVs | The number of successful search requests, including paging requests. | Counts each search request for which a success response is returned. | N/A | Calculates the number of successful search requests on the current day. |
UVs | The number of users who have visited search results pages. | Counts each user only once regardless of how many times the user has visited search results pages. | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Calculates the number of users who have sent search requests on the current day. |
Average PVs per User | The average number of successful search requests per user. | Divides PVs by UVs. | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Calculates the average number of successful search requests per user. More search requests indicate that users are interested in searching but often need to search for many times to obtain the expected results. |
Search Queries | The total number of search queries used by all users after deduplication by user. For each user, the same search query that the user uses multiple times is counted only once. | Aggregates the number of deduplicated search queries from each user. The same search query that is used by two users is counted twice. | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Calculates the total number of search queries used by all users after deduplication by user. Deduplication prevents repeated counting of paging requests and repeated searches. |
Average Search Queries per User | The average number of deduplicated search queries per user. | Divides Search Queries by UVs. | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Calculates the average number of deduplicated search queries per user. Deduplication prevents repeated counting of paging requests and repeated searches. |
Distinct Search Queries | The number of distinct and deduplicated search queries that have retrieval results and that are used by all users. | The number of search queries used by all users after deduplication. The same search query that is used by multiple users is counted only once. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Indicates the diversity of search queries. |
Paging Rate | The percentage of successful paging requests to all the successful search requests. | Divides the number of successful paging requests by PVs. | N/A | Calculates the percentage of successful paging requests to all the successful search requests to assess the effects of search retrieval and search results sorting. |
Zero-result Rate | The percentage of search requests whose search results contain no items to all the successful search requests. | Divides the number of search requests whose search results contain no items by PVs. | N/A | Calculates the percentage of search requests whose search results contain no items to all the successful search requests to assess the effect and content diversity of search retrieval. |
Rate of Few Items | The percentage of search requests whose search results contain no more than five items to all the successful search requests. | Divides the number of search requests whose search results contain no more than five items by PVs. | N/A | Calculates the percentage of search requests whose search results contain no more than five items to all the successful search requests to assess the effect and content diversity of search retrieval. |
Request Failures | The number of failed search requests. These requests fail due to reasons such as throttling. | Counts each failed search request. | N/A | Indicates whether you need to adjust the application, for example, scale out the application. |
Request Failure Rate | The percentage of failed search requests to all search requests. The requests fail due to reasons such as throttling. | Divides Request Failures by the sum of PVs and Request Failures. | N/A | Indicates whether you need to adjust the application, for example, scale out the application. |
User analysis metrics
Metric | Definition | Calculation method | Dependency | Description |
User Retention Rate on Next Day | The percentage of users who have sent search requests for two consecutive days to users who sent search requests on the previous day. | Divides the intersection of UVs (t-1) and UVs (t) by UVs (t-1). | Depends on the user_id field that is specified in search requests when users send requests by using the API or SDK. | Indicates user stickiness. |
Query analysis metrics
Dimension or category | Metric | Definition | Calculation method | Dependency | Description |
High-frequency Search Queries | Query | One of the top 500 most frequently used search queries. | Calculates the use frequency of the search query and compares the value with that of other search queries. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Shows one of the search queries in which users are most interested. |
PVs | The number of successful search requests that are sent to perform searches by using this search query. | Counts each successful search request that is sent to perform a search by using this search query. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Shows one of the search queries in which users are most interested. | |
Average Number of Exposed Items | The average number of items in the search results of this search query. | Divides the total number of items in all search results of this search query by PVs. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the average number of items in the search results of one of the search queries in which users are most interested to assess the effect and content diversity of search retrieval. | |
Search Queries with Few Results | Query | One of the top 100 most frequently used search queries among search queries whose search results contain no more than five items. | Calculates the use frequency and the number of items in the search results of the search query, and compares the values with those of other search queries. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Shows a search query whose search results contain no more than five items to assess the effect and content diversity of search retrieval. |
PVs | The number of successful search requests that are sent to perform searches by using this search query. | Counts each successful search request that is sent to perform a search by using this search query. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the number of times a search query whose search results contain no more than five items is used to assess the severity of the issue that only a few items are returned for this search query. | |
Average Number of Exposed Items | The average number of items in the search results of this search query. | Divides the total number of items in all search results of this search query by PVs. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the average number of items in the search results of one of the search queries in which users are most interested to assess the effect and content diversity of search retrieval. | |
Search Queries with No Results | Query | One of the top 100 most frequently used search queries among search queries whose search results contain no items. | Calculates the use frequency and the number of items in the search results of the search query, and compares the values with those of other search queries. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Shows a search query whose search results contain no items to assess the effect and content diversity of search retrieval. |
PVs | The number of successful search requests that are sent to perform searches by using this search query. | Counts each successful search request that is sent to perform a search by using this search query. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the number of times a search query whose search results contain no items is used to assess the severity of the issue that no items are returned for this search query. | |
Search Queries with Largest Growth Rate | Query | One of the top 100 search queries with the largest PV growth rates on the current day compared with the previous day. The top 100 search queries are sorted in descending order of PV growth rate. The minimum number of PVs of the search queries that can enter the rankings must be 10 or 0.1% of PVs, whichever is greater, on the previous day. | Calculates the PV growth rate of the search query and compares the value with that of other search queries. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Shows one of the recently popular search queries. |
PVs on Previous Day | The number of successful search requests that were sent to perform searches by using this search query on the previous day. | Counts each successful search request that was sent to perform a search by using this search query on the previous day. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the number of times one of the recently popular search queries was used on the previous day. | |
PVs | The number of successful search requests that are sent to perform searches by using this search query on the current day. | Counts each successful search request that is sent to perform a search by using this search query on the current day. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the number of times one of the recently popular search queries is used on the current day. | |
Growth Rate | The PV growth rate of the search query on the current day. | Divides the difference between PVs and PVs on Previous Day by PVs on Previous Day. | N/A | Calculates the PV growth rate of the search query on the current day. | |
Average Number of Exposed Items | The average number of items in the search results of this search query. | Divides the total number of items in all search results of this search query by PVs. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the average number of items in the search results of one of the recently popular search queries to assess the effect and content diversity of search retrieval. | |
Queries with Largest Decline Rate | Query | One of the top 100 search queries with the largest PV decline rates on the current day compared with the previous day. The top 100 search queries are sorted in descending order of PV decline rate. The minimum number of PVs of the search queries that can enter the rankings must be 10 or 0.1% of PVs, whichever is greater, on the current day. | Calculates the PV decline rate of the search query and compares the value with that of other search queries. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. If a search request contains the raw_query field, the value of this field is used as the search query. Otherwise, the value for the default index is used as the search query. If no default index is specified, the search query is empty. | Shows one of the search queries with the largest PV decline rates. |
PVs on Previous Day | The number of successful search requests that were sent to perform searches by using this search query on the previous day. | Counts each successful search request that was sent to perform a search by using this search query on the previous day. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the number of times the search query was used on the previous day. | |
PVs | The number of successful search requests that are sent to perform searches by using this search query on the current day. | Counts each successful search request that is sent to perform a search by using this search query on the current day. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the number of times the search query is used on the current day. | |
Decline Rate | The PV decline rate of the search query on the current day. | Divides the difference between PVs on Previous Day and PVs by PVs on Previous Day. | N/A | ||
Average Number of Exposed Items | The average number of items in the search results of this search query. | Divides the total number of items in all search results of this search query by PVs. | Depends on the raw_query field that is specified in search requests when users send requests by using the API or SDK. This dependency is optional. | Calculates the average number of items in the search results of one of the recent search queries with the largest PV decline rates to assess the effect and content diversity of search retrieval. |
Usage notes
When the business operation report displays metrics for a day, the report displays the metrics for the day before the current day by default. You can use the date picker control to select another day as needed.
By default, the Business Operation Report page displays line charts that show the trends in metrics over the last seven days. You can use the date picker control to select another time period as needed. You can view the line chart of a metric by clicking the corresponding icon.
To view a line chart, perform the following steps: In the left-side navigation pane, choose Report Statistics > Business Operation Report. On the Business Operation Report page, select an application from the Application Name drop-down list and a business scenario from the Business Scenario drop-down list. Click a metric category tab and select a metric from the Change Trends in Metrics drop-down list. Then, use the date picker control to select a time period as needed.
