Sure, you can handle it. But should you?
Let our experts manage the tech maintenance while you focus on your business.
Let our experts manage the tech maintenance while you focus on your business.
Configuration
app.telemetry dashboards for usage analysis
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2024.
All rights reserved. All hardware and software names used are brand names and/or trademarks of their respective manufacturers.
These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or any other protected rights. The dissemination, publication, or reproduction hereof is prohibited.
For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.
Introduction
The visual usage analysis of the various applications in the app.telemetry dashboard gives you both – a rough overview of all the applications used and a detailed view of individual applications. The different variants of diagrams and tables allow you to always keep track of the usage of Mindbreeze InSpire in your company.
The properties that can be monitored include search queries, interactions with search results and applications. In addition, various time spans are also available. By default, usage data from the last six months is used.
This feature is available out-of-the-box, so no configuration is necessary. But of course, you have the possibility to customize or disable the dashboards and the update-tasks according to your own needs.
Diagrams and tables
A variety of charts and tables are available for you to view.
You can display these by clicking on "Dashboard" in
the Management Center under the menu item "Reporting" -> "Telemetry Details".
In the drop-down menu you can now select which view should be displayed. One possible view is the complete view of all your applications. This can be found under "Insight App Reporting <optional: Name Prefix> " and contains all usage data of all applications.
Furthermore, Minbreeze InSpire automatically detects all your applications and creates a separate dashboard for each application. These can in turn be displayed under "Insight App Reporting <optional: Name Prefix> <application name> ".
Applications that are rarely used are collected under "Other Applications ". In the next chapter ("Configuration") you will learn how to set the limit and when applications are grouped into "Other Applications ".
The following sections now present and describe some sample diagrams and tables of the app.telemetry dashboard.
Note: These sample charts describe the entire applications and not the individual applications. For a view of the respective individual applications, please change the desired application in the drop-down menu under "Dashboard".
Diagram: Applications
This bar chart gives you an overview of all your applications. It shows you on the one hand the number of searches per application and on the other hand "Other Applications " as a separate bar that summarizes all your applications that are under the usage limit.
Table: Applications (Detailed)
This table shows a detailed view of the bar chart above. It also provides insight into the relative usage of the applications.
Table: Other Applications
This table contains all applications that are subordinated under "Other Application" or that are below the specified usage limit (default value = 10%).
Table: Visits, Queries, Result and Answer Clicks
This table shows you the usage data of the last half year per calendar week.
The description of the columns is as follows:
- Week: Calendar week of a year. If no applications are used in a calendar week, the calendar week is not displayed accordingly.
- Unique Visits: The number of different sessions per calendar week. A session can be, for example, starting the browser.
- Queries: The number of queries per calendar week.
- Search Result Clicks: The number of clicks on the results of the total search queries.
- Average Search Result Click Rank: The average position of the clicked search results.
- Answer Result Clicks: The number of clicks on the answers of the total search queries. Any kind of interaction with the answer counts as a click (click on answer text, click on "Open"/"Copy answer to clipboard" dialog, etc).
- Answer Result Click or Select Answer Text Actions: The number of clicks on the answer text, the link of the answer or the open dialog of the entire search queries.
- Answer Result Copy Answer Text Actions: The number of clicks on the "Copy Answer to Clipboard" dialog of the total search queries.
- Answer Result Open Actions: The number of clicks on the "Open" dialog of the total search queries.
Diagram: Visits, Queries, Result and Answer Clicks
This chart visualizes the properties "Week", "Unique Visits", "Queries" and "Search Result Clicks", "Answer Result Clicks" , "Answer Result Clicks or Select Answer Text Actions" , "Answer Result Copy Answer Text Actions", "Answer Result Open Actions" from the table shown above as a line chart.
Diagram: Queries with and without Search Result Clicks
In addition to search queries, this line chart also visualizes the following properties per calendar week:
- Queries with Search Result Clicks: This property describes the number of search queries for which one or more search results were subsequently clicked.
- Queries without Search Result Clicks: The opposite of the above property, i.e. the number of queries for which no search results were subsequently clicked.
- Queries: The number of all search queries and thus the sum of Queries with Search Result Clicks and Queries without Search Result Clicks.
- Queries with Answer Result Clicks: This property describes the number of queries for which one or more answers were subsequently clicked. Any kind of interaction with the answer (click on answer text, click on "Open"/"Copy answer to clipboard" dialog, etc) counts as a click.
- Queries without Answer Result Clicks: The opposite of the above property, i.e. the number of queries for which no answer was subsequently clicked.
- Queries with Answer Text Copied Result Clicks: This property describes the number of search queries where "Copy answer to cache" was clicked afterwards.
- Queries with Opened Answers: This property describes the number of queries that have been opened afterwards.
Answer Result Voting Actions
This table shows you the usage data of the last half year per calendar week.
The description of the columns is as follows:
- Week: Calendar week of a year. If no applications are used in a calendar week, the calendar week is not displayed accordingly.
- Unique Visits: The number of different sessions per calendar week. A session can be, for example, starting the browser.
- Queries: The number of queries per calendar week.
- Answer Result Upvote Actions: The number of upvotes from users for the results of the entire search query.
- Answer Result Downvote Actions: The number of downvotes from users for the results of the entire search query.
Diagram: Top 5 Queries
This bar chart shows the top 5 search terms and their number in the last six months.
In addition, there are also bar charts for the last month and for the last week.
Diagram: Top 20 Queries
This table shows a detailed view of the top 20 search terms used in the last six months.
The description of the columns is as follows:
- Query: The search term.
- Count: The number of search queries per search term.
- Unique Visits: The number of different sessions per search term. A session can be, for example, starting the browser.
- Different Users: The number of different users per search term.
In addition, there are also tables for the last month and for the last week.
Chart: Trending Queries (Monthly)
This line chart shows the trend of the top 5 search terms for the last two months (including the current month). Month in this case means beginning of the month to the end of the month, except for the current month, which is from the beginning of the month to the current date.
In addition, there are also line charts of this type for the last three weeks and the last three days.
Configuration
Note: This feature is available out-of-the-box, so no configuration is necessary. But of course, you have the possibility to configure the dashboards and the update tasks according to your own needs.
In the Management Center under the Setup -> Tasks menu under the Update app.telemetry dashboards list, you can add or edit a task to the dashboard.
By default, there is a task for the Dashboard that runs every 15 minutes. This task is marked with a yellow frame and cannot be deleted or modified (except Schedule and Enable/Disable).
The "Add Task" button can be used to add a new update task.
The following table describes the options that can be set in the process:
Enable / Disable | Tasks can be activated ("Task is enabled") and deactivated ("Task is disabled") with the toggle in the upper right corner. Deactivated tasks remain in the list of tasks, but are no longer executed (despite a defined schedule). | ||||||
Name | Name of the task. A descriptive name should be specified here in order to maintain an overview. | ||||||
Description | Description of the task. Useful if the name of the task is not sufficient for description. | ||||||
Max Duration (in sec.) | Number of seconds, how long the task may run at maximum. If this time is exceeded, the task is aborted. | ||||||
Schedule | Cron Expressions, which describes the execution times of the tasks. The "Add Schedule" button can be used to add and delete any number of cron expressions, and both a graphical editor and a textual editor are available for cron expressions. The "Run now" option can be used to define that a task is executed immediately and only once. The task is executed with the current settings, regardless of whether "Close" or "Save" is selected afterwards. | ||||||
Execution | Three options are available:
|
When you click on the "Show request" button, the "Dashboard Config" settings are displayed first.
The following table describes the options that can be set in the process:
Access Roles | List of users and groups that are allowed to access the dashboard. |
Public Access | If clicked, the dashboards will be available to all app.telemetry users. |
Minimal usage for creating application dashboards | The applications whose percentage usage is lower than the specified value are grouped under "Other Applications". By default the value is 10% |
Custom Dashboard Config Path | The path to the dashboard configuration file. This option should only be customized by experienced users. If empty, /opt/mindbreeze/share/query_log_dashboard/ |
Name prefix | Here you can additionally define a prefix to the name. Example: "Name Prefix" = my company |
If you use a special app.telemetry database, you can configure it with "Use Custom app.telemetry Database Settings".
The following table describes the options that can be set in the process:
Host | Hostname of the app.telemetry database. By default: localhost |
Name | Database name of the app.telemetry database. By default: telemetrydb |
Table Name | Table name of the client service query log log pool. By default: clientservicequerylogmesclientservicequerylog |
User | The database user. By default: telemetryuser |
Password | Password of the database user. |
Disable the feature
By default, the default task is activated and the dashboards are thus generated automatically.
However, you also have the option of deactivating the default task and can delete the already existing dashboards by deleting the respective module under the menu item "Reporting" -> "Configuration" -> "Modules".
Likewise, you also have the option to disable logging of usage data under "Client Services" in the "Personalization Settings" section by unchecking the checkbox for "Enable Personalization".