diff options
Diffstat (limited to 'doc/operations/product_analytics.md')
| -rw-r--r-- | doc/operations/product_analytics.md | 80 |
1 files changed, 22 insertions, 58 deletions
diff --git a/doc/operations/product_analytics.md b/doc/operations/product_analytics.md index 98ba6a9203c..e21770bc579 100644 --- a/doc/operations/product_analytics.md +++ b/doc/operations/product_analytics.md @@ -1,81 +1,45 @@ --- stage: Analytics -group: Product Intelligence +group: Product Analytics info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Product Analytics **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225167) in GitLab 13.3. -> - It's deployed behind a feature flag, disabled by default. -> - It's disabled on GitLab.com. -> - It's able to be enabled or disabled per-project. -> - It's not recommended for production use. -> - To use it in GitLab self-managed instances, ask a GitLab administrator to enable it. +> [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. -GitLab allows you to go from planning an application to getting feedback. Feedback -is not just observability, but also knowing how people use your product. -Product Analytics uses events sent from your application to know how they are using it. -It's based on [Snowplow](https://github.com/snowplow/snowplow), the best open-source -event tracker. With Product Analytics, you can receive and analyze the Snowplow data -inside GitLab. +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. -## Enable or disable Product Analytics +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. -Product Analytics is under development and not ready for production use. It's -deployed behind a feature flag that's **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) -can enable it for your instance. Product Analytics can be enabled or disabled per-project. +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. -To enable it: +## View Product Analytics -```ruby -# Instance-wide -Feature.enable(:product_analytics) -# or by project -Feature.enable(:product_analytics, Project.find(<project ID>)) -``` +You can view the event data collected about your applications. -To disable it: +Prerequisite: -```ruby -# Instance-wide -Feature.disable(:product_analytics) -# or by project -Feature.disable(:product_analytics, Project.find(<project ID>)) -``` +- You must have at least the Reporter role. -## Access Product Analytics +To access Product Analytics: -After enabling the feature flag for Product Analytics, you can access the -user interface: +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Product Analytics**. -1. Sign in to GitLab as a user with at least the Reporter role. -1. Navigate to **Monitor > Product Analytics**. +The Product Analytics interface contains: -The user interface contains: +- 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. -- An Events page that shows the recent events and a total count. -- A test page that sends a sample event. -- A setup page containing the code to implement in your application. - -## Rate limits for Product Analytics +## Rate limits 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. - -## Data storage for Product Analytics - -Product Analytics stores events are stored in GitLab database. - -WARNING: -This data storage is experimental, and GitLab is likely to remove this data during -future development. - -## Event collection - -Events are collected by [Rails collector](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36443), -allowing GitLab to ship the feature fast. Due to scalability issue, GitLab plans -to switch to a separate application, such as -[snowplow-go-collector](https://gitlab.com/gitlab-org/snowplow-go-collector), for event collection. |