debian-mirror-gitlab/doc/operations/product_analytics.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

46 lines
2 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
2022-08-13 15:12:31 +05:30
stage: Analytics
2022-10-11 01:57:18 +05:30
group: Product Analytics
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-03-11 19:13:27 +05:30
# Product Analytics **(FREE)**
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225167) in GitLab 13.3 [with a flag](../administration/feature_flags.md) named `product_analytics`. Disabled by default.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `product_analytics`. On GitLab.com, this feature is not available. The feature is not ready for production use.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
GitLab enables you to go from planning an application to getting feedback. You can use
Product Analytics to receive and analyze events sent from your application. This analysis
provides observability information and feedback on how people use your product.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
Events are collected by a [Rails collector](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36443) and
then processed with [Snowplow](https://github.com/snowplow/snowplow). Events are stored in a GitLab database.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
## View Product Analytics
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
You can view the event data collected about your applications.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
Prerequisite:
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
- You must have at least the Reporter role.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
To access Product Analytics:
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
1. On the left sidebar, select **Monitor > Product Analytics**.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
The Product Analytics interface contains:
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
- An Events tab that shows the recent events and a total count.
- A Graph tab that shows graphs based on events of the last 30 days.
- A Test tab that sends a sample event payload.
- A Setup page containing the code to implement in your application.
2020-10-24 23:57:45 +05:30
2022-10-11 01:57:18 +05:30
## Rate limits
2020-10-24 23:57:45 +05:30
While Product Analytics is under development, it's rate-limited to
**100 events per minute** per project. This limit prevents the events table in the
database from growing too quickly.