mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: add Usage Insights documentation (#23982)
* Docs: start on usage insights * Docs: first draft for Usage Insights content * Docs: clean up usage insights docs * Docs: revert prettier updates * Update docs/sources/enterprise/usage-insights.md Co-Authored-By: Emil Tullstedt <emil.tullstedt@grafana.com> * Docs: rewrite presence indicators paragraph * Docs: feedback update * Update docs/sources/enterprise/_index.md Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Docs: headings to sentence case * Update docs/sources/enterprise/usage-insights.md Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/enterprise/usage-insights.md Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/enterprise/usage-insights.md Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/enterprise/usage-insights.md Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Docs: add dashboard insights button image * Docs: add consistency * Docs: add lower case * Update docs/sources/enterprise/usage-insights.md Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com> * Update docs/sources/enterprise/usage-insights.md Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com> * Update docs/sources/enterprise/usage-insights.md Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com> * Docs: singular presence indicator and improved search feedback * Docs: Apply PR feedback Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Grafana Enterprise"
|
||||
description = "Grafana Enterprise overview"
|
||||
keywords = ["grafana", "documentation", "datasource", "permissions", "ldap", "licensing", "enterprise"]
|
||||
keywords = ["grafana", "documentation", "datasource", "permissions", "ldap", "licensing", "enterprise", "insights", "reporting"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Grafana Enterprise"
|
||||
@@ -58,6 +58,10 @@ Supported auth providers:
|
||||
|
||||
[White labeling]({{< relref "white-labeling.md" >}}) allows you to replace the Grafana brand and logo with your own corporate brand and logo. You can also change footer links to point to your custom resources.
|
||||
|
||||
## Usage insights
|
||||
|
||||
[Usage insights]({{< relref "usage-insights.md" >}}) allow you to understand how your Grafana instance is used. You can see who is looking at a dashboard, how often a dashboard is seen, and which dashboards are prone to errors. You'll also be able to discover what are the least and the most used dashboards.
|
||||
|
||||
## Enterprise plugins
|
||||
|
||||
With a Grafana Enterprise license, you get access to premium plugins, including:
|
||||
|
||||
57
docs/sources/enterprise/usage-insights.md
Normal file
57
docs/sources/enterprise/usage-insights.md
Normal file
@@ -0,0 +1,57 @@
|
||||
+++
|
||||
title = "Usage-insights"
|
||||
description = "Usage-insights"
|
||||
keywords = ["grafana", "usage-insights", "enterprise"]
|
||||
aliases = ["/docs/grafana/latest/enterprise/usage-insights/"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Usage-insights"
|
||||
parent = "enterprise"
|
||||
weight = 700
|
||||
+++
|
||||
|
||||
# Usage insights
|
||||
|
||||
Usage insights allows you to have a better understanding of how your Grafana instance is used. The collected data are the number of:
|
||||
|
||||
- Dashboard views (aggregated and per user)
|
||||
- Data source errors
|
||||
- Data source queries
|
||||
|
||||
> Only available in Grafana Enterprise v7.0+.
|
||||
|
||||
## Presence indicator
|
||||
|
||||
The presence indicator is visible to all signed-in users on all dashboards. It shows the avatars of users who interacted with the dashboard recently (last 10 minutes by default). You can see the user's name by hovering your cursor over the user's avatar. The avatars come from [Gravatar](https://gravatar.com) based on the user's email.
|
||||
|
||||
When more users are active on a dashboard than can fit in the presence indicator section, click on the `+X` icon that opens [dashboard insights]({{< relref "#dashboard-insights" >}}) to see more details about recent user activity.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/enterprise/presence_indicators.png" max-width="400px" class="docs-image--no-shadow" >}}
|
||||
|
||||
You can choose your own definition of "recent" by setting it in the [configuration]({{< relref "../installation/configuration.md">}}) file.
|
||||
|
||||
```ini
|
||||
[analytics.views]
|
||||
# Set age for recent active users
|
||||
recent_users_age = 10m
|
||||
```
|
||||
|
||||
## Dashboard insights
|
||||
|
||||
You can see dashboard usage information by clicking on the `Dashboard insights` button in the top bar.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/enterprise/dashboard_insights_button.png" max-width="400px" class="docs-image--no-shadow" >}}
|
||||
|
||||
It shows two kinds of information:
|
||||
|
||||
- **Stats:** Shows the daily query count and error count for the last 30 days.
|
||||
- **Users & activity:** Shows the daily view count for the last 30 days; last activities on the dashboard and recent users (with a limit of 20).
|
||||
|
||||
{{< docs-imagebox img="/img/docs/enterprise/dashboard_insights_stats.png" max-width="400px" class="docs-image--no-shadow" >}}{{< docs-imagebox img="/img/docs/enterprise/dashboard_insights_users.png" max-width="400px" class="docs-image--no-shadow" >}}
|
||||
|
||||
|
||||
## Improved dashboard search
|
||||
|
||||
In the search view, you can sort dashboards using these insights data. It helps you find unused or broken dashboards or discover most viewed ones.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/enterprise/improved_search.png" max-width="650px" class="docs-image--no-shadow" >}}
|
||||
@@ -265,16 +265,18 @@
|
||||
link: /enterprise/enhanced_ldap/
|
||||
- name: Reporting
|
||||
link: /enterprise/reporting/
|
||||
- name: Export dashboard as PDF
|
||||
link: /enterprise/export-pdf/
|
||||
- name: SAML authentication
|
||||
link: /enterprise/saml/
|
||||
- name: Team sync
|
||||
link: /enterprise/team-sync/
|
||||
- name: White labeling
|
||||
link: /enterprise/white-labeling/
|
||||
- name: Usage insights
|
||||
link: /enterprise/usage-insights/
|
||||
- name: License expiration
|
||||
link: /enterprise/license-expiration/
|
||||
- name: Export dashboard as PDF
|
||||
link: /enterprise/export-pdf/
|
||||
- name: Plugins
|
||||
link: /plugins/
|
||||
children:
|
||||
|
||||
Reference in New Issue
Block a user