Skip to content

Commit 8f38fc1

Browse files
committed
Checkpoint
1 parent 4c70163 commit 8f38fc1

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

articles/search/search-traffic-analytics.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Collect search traffic telemetry data
2+
title: Search traffic telemetry data
33
titleSuffix: Azure Cognitive Search
44
description: Enable search traffic analytics for Azure Cognitive Search, collect telemetry and user-initiated events using Application Insights, and then analyze findings in a Power BI report.
55

@@ -9,37 +9,38 @@ ms.author: heidist
99

1010
ms.service: cognitive-search
1111
ms.topic: conceptual
12-
ms.date: 12/20/2019
12+
ms.date: 03/18/2020
1313
---
1414

15-
# Collect search traffic telemety data in Azure Cognitive Search
15+
# Collect telemetry data for search traffic analytics
1616

17-
Search traffic analytics is a pattern for implementing a feedback loop for your search service. The objective is to collect telemetry on user-initiated click events and keyboard inputs. Using this information, you can determine the effectiveness of your search solution, including popular search terms, clickthrough rate, and which query inputs yield zero results.
17+
Search traffic analytics is a pattern for implementing a feedback loop for your Azure Cognitive Search service. The objective is to collect telemetry on user-initiated click events and keyboard inputs. Using this information, you can determine the effectiveness of your search solution, including popular search terms, clickthrough rate, and which query inputs yield zero results.
1818

1919
This pattern takes a dependency on [Application Insights](https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview) (a feature of [Azure Monitor](https://docs.microsoft.com/azure/azure-monitor/)) to collect user data. You will also need to add instrumentation to your client code, as described in this article. Finally, you will need a reporting mechanism to analyze the data. We recommend Power BI but you can use any tool that connects to Application Insights.
2020

2121
> [!NOTE]
22-
> The pattern described in this article is for advanced scenarios and clickstream data generated by your client. Alternatively, you can report on log information generated by your search service. For more information about service log reports, see [Monitor resource consumption and query activity](search-monitor-usage.md).
22+
> The pattern described in this article is for advanced scenarios and clickstream data generated by your client. Alternatively, you can report on log information generated by your search service. For more information about service log reports, see [Collect and analyze log data](search-monitor-logs.md).
2323
2424
## Identify relevant search data
2525

26-
To have useful search metrics, it's necessary to log some signals from the users of the search application. These signals signify content that users are interested in and that they consider relevant to their needs.
26+
To have useful search metrics, it's necessary to log some signals from the users of the search application. These signals signify content that users are interested in and that they consider relevant.
2727

28-
There are two signals Search Traffic Analytics needs:
28+
Two signals are needed for search traffic analytics:
2929

3030
+ User-generated search events: only search queries initiated by a user are interesting. Search requests used to populate facets, additional content or any internal information, are not important and they skew and bias your results.
3131

3232
+ User-generated click events: By clicks in this document, we refer to a user selecting a particular search result returned from a search query. A click generally means that a document is a relevant result for a specific search query.
3333

34-
By linking search and click events with a correlation ID, it's possible to analyze the behaviors of users on your application. These search insights are impossible to obtain with only search traffic logs.
34+
By linking search and click events with a correlation ID, you'll gain more insights into how your application performing.
3535

3636
## Add search traffic analytics
3737

38-
The signals mentioned in the preceding section must be gathered from the search application as the user interacts with it. Application Insights is an extensible monitoring solution, available for multiple platforms, with flexible instrumentation options. Usage of Application Insights lets you take advantage of the Power BI search reports created by Azure Cognitive Search to make the analysis of data easier.
38+
The signals mentioned in the preceding section must be gathered from the search application as the user interacts with it.
39+
Application Insights is an extensible monitoring solution, available for multiple platforms, with flexible instrumentation options. Usage of Application Insights lets you take advantage of the Power BI search reports created by Azure Cognitive Search to make the analysis of data easier.
3940

4041
In the [portal](https://portal.azure.com) page for your Azure Cognitive Search service, the Search Traffic Analytics page contains a cheat sheet for following this telemetry pattern. You can also select or create an Application Insights resource, and see the necessary data, all in one place.
4142

42-
![Search Traffic Analytics instructions][1]
43+
![Search Traffic Analytics page in the portal](media/search-traffic-analytics/azuresearch-trafficanalytics.png "Search Traffic Analytics page in the portal")
4344

4445
## 1 - Select a resource
4546

@@ -164,10 +165,10 @@ Every time that a user clicks on a document, that's a signal that must be logged
164165
*JavaScript*
165166

166167
appInsights.trackEvent("Click", {
167-
SearchServiceName: <service name>,
168-
SearchId: <search id>,
169-
ClickedDocId: <clicked document id>,
170-
Rank: <clicked document position>
168+
SearchServiceName: <service name>,
169+
SearchId: <search id>,
170+
ClickedDocId: <clicked document id>,
171+
Rank: <clicked document position>
171172
});
172173

173174
## 3 - Analyze in Power BI

0 commit comments

Comments
 (0)