Instance statistics docs
This commit is contained in:
parent
71a3da05e2
commit
21a2dde024
16 changed files with 98 additions and 71 deletions
|
@ -3,7 +3,7 @@
|
|||
User cohorts are shown for the last #{@cohorts[:months_included]}
|
||||
months. Only users with activity are counted in the cohort total; inactive
|
||||
users are counted separately.
|
||||
= link_to icon('question-circle'), help_page_path('user/admin_area/user_cohorts', anchor: 'cohorts'), title: 'About this feature', target: '_blank'
|
||||
= link_to icon('question-circle'), help_page_path('user/instance_statistics/user_cohorts', anchor: 'cohorts'), title: 'About this feature', target: '_blank'
|
||||
|
||||
.table-holder
|
||||
%table.table
|
||||
|
|
|
@ -4,4 +4,4 @@
|
|||
%h4 Data is still calculating...
|
||||
%p
|
||||
In order to gather accurate feature usage data, it can take 1 to 2 weeks to see your index.
|
||||
= link_to 'Learn more', help_page_path('user/admin_area/monitoring/convdev'), target: '_blank'
|
||||
= link_to 'Learn more', help_page_path('user/instance_statistics/convdev'), target: '_blank'
|
||||
|
|
|
@ -19,7 +19,7 @@
|
|||
index
|
||||
%br
|
||||
score
|
||||
= link_to icon('question-circle', 'aria-hidden' => 'true'), help_page_path('user/admin_area/monitoring/convdev')
|
||||
= link_to icon('question-circle', 'aria-hidden' => 'true'), help_page_path('user/instance_statistics/convdev')
|
||||
|
||||
.convdev-cards.board-card-container
|
||||
- @metric.cards.each do |card|
|
||||
|
|
|
@ -93,7 +93,6 @@ created in snippets, wikis, and repos.
|
|||
- [Postfix for incoming email](reply_by_email_postfix_setup.md): Set up a
|
||||
basic Postfix mail server with IMAP authentication on Ubuntu for incoming
|
||||
emails.
|
||||
- [User Cohorts](../user/admin_area/user_cohorts.md): Display the monthly cohorts of new users and their activities over time.
|
||||
|
||||
[reply by email]: reply_by_email.md
|
||||
[issues by email]: ../user/project/issues/create_new_issue.md#new-issue-via-email
|
||||
|
@ -137,7 +136,6 @@ created in snippets, wikis, and repos.
|
|||
- [Monitoring uptime](../user/admin_area/monitoring/health_check.md): Check the server status using the health check endpoint.
|
||||
- [IP whitelist](monitoring/ip_whitelist.md): Monitor endpoints that provide health check information when probed.
|
||||
- [Monitoring GitHub imports](monitoring/github_imports.md): GitLab's GitHub Importer displays Prometheus metrics to monitor the health and progress of the importer.
|
||||
- [Conversational Development (ConvDev) Index](../user/admin_area/monitoring/convdev.md): Provides an overview of your entire instance's feature usage.
|
||||
|
||||
### Performance Monitoring
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 429 KiB |
|
@ -1,29 +1,5 @@
|
|||
# Conversational Development Index
|
||||
---
|
||||
redirect_to: '../../instance_statistics/convdev.md'
|
||||
---
|
||||
|
||||
> [Introduced][ce-30469] in GitLab 9.3.
|
||||
|
||||
Conversational Development Index (ConvDev) gives you an overview of your entire
|
||||
instance's feature usage, from idea to production. It looks at your usage in the
|
||||
past 30 days, averaged over the number of active users in that time period. It also
|
||||
provides a lead score per feature, which is calculated based on GitLab's analysis
|
||||
of top performing instances, based on [usage ping data][ping] that GitLab has
|
||||
collected. Your score is compared to the lead score, expressed as a percentage.
|
||||
The overall index score is an average over all your feature scores.
|
||||
|
||||
![ConvDev index](img/convdev_index.png)
|
||||
|
||||
The page also provides helpful links to articles and GitLab docs, to help you
|
||||
improve your scores.
|
||||
|
||||
Your GitLab instance's usage ping must be activated in order to use this feature.
|
||||
Usage ping data is aggregated on GitLab's servers for analysis. Your usage
|
||||
information is **not sent** to any other GitLab instances.
|
||||
|
||||
If you have just started using GitLab, it may take a few weeks for data to be
|
||||
collected before this feature is available.
|
||||
|
||||
This feature is accessible only to a system admin, at
|
||||
**Admin area > Overview > ConvDev Index**.
|
||||
|
||||
[ce-30469]: https://gitlab.com/gitlab-org/gitlab-ce/issues/30469
|
||||
[ping]: ../settings/usage_statistics.md#usage-ping
|
||||
This document was moved to [another location](../../instance_statistics/convdev.md).
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 117 KiB |
|
@ -6,7 +6,7 @@ to perform various actions.
|
|||
All statistics are opt-out, you can enable/disable them from the admin panel
|
||||
under **Admin area > Settings > Usage statistics**.
|
||||
|
||||
## Version check
|
||||
## Version check **[CORE ONLY]**
|
||||
|
||||
If enabled, version check will inform you if a new version is available and the
|
||||
importance of it through a status. This is shown on the help page (i.e. `/help`)
|
||||
|
@ -29,7 +29,7 @@ secure.
|
|||
If you disable version check, this information will not be collected. Enable or
|
||||
disable the version check at **Admin area > Settings > Usage statistics**.
|
||||
|
||||
## Usage ping
|
||||
## Usage ping **[CORE ONLY]**
|
||||
|
||||
> [Introduced][ee-557] in GitLab Enterprise Edition 8.10. More statistics
|
||||
[were added][ee-735] in GitLab Enterprise Edition
|
||||
|
@ -67,6 +67,15 @@ production: &base
|
|||
usage_ping_enabled: false
|
||||
```
|
||||
|
||||
## Instance statistics visibility **[CORE ONLY]**
|
||||
|
||||
Once usage ping is enabled, GitLab will gather data from other instances and
|
||||
will be able to show [usage statistics](../../instance_statistics/index.md)
|
||||
of your instance to your users.
|
||||
|
||||
This can be restricted to admins by selecting "Only admins" in the Instance
|
||||
Statistics visibility section under **Admin area > Settings > Usage statistics**.
|
||||
|
||||
[ee-557]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/557
|
||||
[ee-735]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/735
|
||||
[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361
|
||||
|
|
|
@ -1,37 +1,5 @@
|
|||
# Cohorts
|
||||
---
|
||||
redirect_to: '../instance_statistics/user_cohorts.md'
|
||||
---
|
||||
|
||||
> **Notes:**
|
||||
> [Introduced][ce-23361] in GitLab 9.1.
|
||||
|
||||
As a benefit of having the [usage ping active](settings/usage_statistics.md),
|
||||
GitLab lets you analyze the users' activities of your GitLab installation.
|
||||
Under `/admin/cohorts`, when the usage ping is active, GitLab will show the
|
||||
monthly cohorts of new users and their activities over time.
|
||||
|
||||
## Overview
|
||||
|
||||
How do we read the user cohorts table? Let's take an example with the following
|
||||
user cohorts.
|
||||
|
||||
![User cohort example](img/cohorts.png)
|
||||
|
||||
For the cohort of June 2016, 163 users have been added on this server and have
|
||||
been active since this month. One month later, in July 2016, out of
|
||||
these 163 users, 155 users (or 95% of the June cohort) are still active. Two
|
||||
months later, 139 users (or 85%) are still active. 9 months later, we can see
|
||||
that only 6% of this cohort are still active.
|
||||
|
||||
The Inactive users column shows the number of users who have been added during
|
||||
the month, but who have never actually had any activity in the instance.
|
||||
|
||||
How do we measure the activity of users? GitLab considers a user active if:
|
||||
|
||||
* the user signs in
|
||||
* the user has Git activity (whether push or pull).
|
||||
|
||||
## Setup
|
||||
|
||||
1. [Activate the usage ping](settings/usage_statistics.md)
|
||||
2. Go to `/admin/cohorts` to see the user cohorts of the server
|
||||
|
||||
[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361
|
||||
This document was moved to [another location](../instance_statistics/user_cohorts.md).
|
||||
|
|
|
@ -172,3 +172,7 @@ Automate GitLab via [API](../api/README.md).
|
|||
## Git and GitLab
|
||||
|
||||
Learn what is [Git](../topics/git/index.md) and its best practices.
|
||||
|
||||
## Instance statistics
|
||||
|
||||
See [various statistics](instance_statistics/index.md) of your GitLab instance.
|
||||
|
|
26
doc/user/instance_statistics/convdev.md
Normal file
26
doc/user/instance_statistics/convdev.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
# Conversational Development Index
|
||||
|
||||
> [Introduced][ce-30469] in GitLab 9.3.
|
||||
|
||||
Conversational Development Index (ConvDev) gives you an overview of your entire
|
||||
instance's feature usage, from idea to production. It looks at your usage in the
|
||||
past 30 days, averaged over the number of active users in that time period. It also
|
||||
provides a lead score per feature, which is calculated based on GitLab's analysis
|
||||
of top performing instances, based on [usage ping data][ping] that GitLab has
|
||||
collected. Your score is compared to the lead score, expressed as a percentage.
|
||||
The overall index score is an average over all your feature scores.
|
||||
|
||||
![ConvDev index](img/convdev_index.png)
|
||||
|
||||
The page also provides helpful links to articles and GitLab docs, to help you
|
||||
improve your scores.
|
||||
|
||||
Your GitLab instance's usage ping must be activated in order to use this feature.
|
||||
Usage ping data is aggregated on GitLab's servers for analysis. Your usage
|
||||
information is **not sent** to any other GitLab instances.
|
||||
|
||||
If you have just started using GitLab, it may take a few weeks for data to be
|
||||
collected before this feature is available.
|
||||
|
||||
[ce-30469]: https://gitlab.com/gitlab-org/gitlab-ce/issues/30469
|
||||
[ping]: ../admin_area/settings/usage_statistics.md#usage-ping
|
BIN
doc/user/instance_statistics/img/cohorts.png
Normal file
BIN
doc/user/instance_statistics/img/cohorts.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 58 KiB |
BIN
doc/user/instance_statistics/img/convdev_index.png
Normal file
BIN
doc/user/instance_statistics/img/convdev_index.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 310 KiB |
BIN
doc/user/instance_statistics/img/instance_statistics_button.png
Normal file
BIN
doc/user/instance_statistics/img/instance_statistics_button.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.2 KiB |
19
doc/user/instance_statistics/index.md
Normal file
19
doc/user/instance_statistics/index.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Instance statistics
|
||||
|
||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41416)
|
||||
in GitLab 11.2.
|
||||
|
||||
Instance statistics gives users or admins access to instance-wide analytics.
|
||||
They are accessible to all users by default (GitLab admins can restrict its
|
||||
visibility in the [admin area](../admin_area/settings/usage_statistics.md)),
|
||||
and can be accessed via the top bar.
|
||||
|
||||
![Instance Statistics button](img/instance_statistics_button.png)
|
||||
|
||||
For the statistics to show up, [usage ping must be enabled](../admin_area/settings/usage_statistics.md#usage-ping)
|
||||
by an admin in the admin settings area.
|
||||
|
||||
There are two kinds of statistics:
|
||||
|
||||
- [Conversational Development (ConvDev) Index](convdev.md): Provides an overview of your entire instance's feature usage.
|
||||
- [User Cohorts](user_cohorts.md): Display the monthly cohorts of new users and their activities over time.
|
27
doc/user/instance_statistics/user_cohorts.md
Normal file
27
doc/user/instance_statistics/user_cohorts.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Cohorts
|
||||
|
||||
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/23361)
|
||||
in GitLab 9.1.
|
||||
|
||||
As a benefit of having the [usage ping active](../admin_area/settings/usage_statistics.md),
|
||||
GitLab lets you analyze the users' activities over time of your GitLab installation.
|
||||
|
||||
## Overview
|
||||
|
||||
How do we read the user cohorts table? Let's take an example with the following
|
||||
user cohorts.
|
||||
|
||||
![User cohort example](img/cohorts.png)
|
||||
|
||||
For the cohort of Jan 2018, 15 users have been added on this server and have
|
||||
been active since this month. One month later, in Feb 2018, all 15 users are
|
||||
still active. 6 months later (Month 6, July), we can see 10 users from this cohort
|
||||
are active, or 66% of the original cohort of 15 that joined in January.
|
||||
|
||||
The Inactive users column shows the number of users who have been added during
|
||||
the month, but who have never actually had any activity in the instance.
|
||||
|
||||
How do we measure the activity of users? GitLab considers a user active if:
|
||||
|
||||
* the user signs in
|
||||
* the user has Git activity (whether push or pull).
|
Loading…
Reference in a new issue