Skip to content
代码片段 群组 项目
提交 2cf7e5d8 编辑于 作者: Jon Glassman's avatar Jon Glassman
浏览文件

Merge branch '405370-update-productanalytics-docs' into 'master'

Update Product Analytics docs for first external user phase

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120264



Merged-by: default avatarJon Glassman <jglassman@gitlab.com>
Reviewed-by: default avatarDennis Tang <750946-dennis@users.noreply.gitlab.com>
Reviewed-by: default avatarLorena Ciutacu <lciutacu@gitlab.com>
Co-authored-by: default avatarDennis Tang <dtang@gitlab.com>
Co-authored-by: default avatarLorena Ciutacu <lciutacu@gitlab.com>
No related branches found
No related tags found
无相关合并请求
...@@ -23,9 +23,9 @@ For more information, see the [group direction page](https://about.gitlab.com/di ...@@ -23,9 +23,9 @@ For more information, see the [group direction page](https://about.gitlab.com/di
Product analytics uses several tools: Product analytics uses several tools:
- [**Jitsu**](https://jitsu.com/docs) - A web and app event collection platform that provides a consistent API to collect user data and pass it through to ClickHouse. - [**Snowplow**](https://docs.snowplow.io/docs) - A developer-first engine for collecting behavioral data, and passing it through to ClickHouse.
- [**ClickHouse**](https://clickhouse.com/docs) - A database suited to store, query, and retrieve analytical data. - [**ClickHouse**](https://clickhouse.com/docs) - A database suited to store, query, and retrieve analytical data.
- [**Cube.js**](https://cube.dev/docs/) - An analytical graphing library that provides an API to run queries against the data stored in Clickhouse. - [**Cube**](https://cube.dev/docs/) - An analytical graphing library that provides an API to run queries against the data stored in Clickhouse.
The following diagram illustrates the product analytics flow: The following diagram illustrates the product analytics flow:
...@@ -34,19 +34,21 @@ The following diagram illustrates the product analytics flow: ...@@ -34,19 +34,21 @@ The following diagram illustrates the product analytics flow:
title: Product Analytics flow title: Product Analytics flow
--- ---
flowchart TB flowchart TB
subgraph Adding data subgraph Event collection
A([SDK]) --Send user data--> B[Analytics Proxy] A([SDK]) --Send user data--> B[Snowplow Collector]
B --Transform data and pass it through--> C[Snowplow] B --Pass data through--> C[Snowplow Enricher]
C --Pass the data to the associated database--> D([Clickhouse])
end end
subgraph Showing dashboards subgraph Data warehouse
E([Dashboards]) --Generated from the YAML definition--> F[Dashboard] C --Transform and enrich data--> D([Clickhouse])
end
subgraph Data visualization with dashboards
E([Dashboards]) --Generated from the YAML definition--> F[Panels/Visualizations]
F --Request data--> G[Product Analytics API] F --Request data--> G[Product Analytics API]
G --Run Cube queries with pre-aggregations--> H[Cube.js] G --Run Cube queries with pre-aggregations--> H[Cube]
H --Get data from database--> D H --Get data from database--> D
D --Return results--> H D --Return results--> H
H --> G H --Transform data to be rendered--> G
G --Transform data to be rendered--> F G --Return data--> F
end end
``` ```
...@@ -73,20 +75,6 @@ Prerequisite: ...@@ -73,20 +75,6 @@ Prerequisite:
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings > General**.
1. Expand the **Analytics** tab and find the **Product analytics** section. 1. Expand the **Analytics** tab and find the **Product analytics** section.
1. Select **Enable product analytics** and enter the configuration values. 1. Select **Enable product analytics** and enter the configuration values.
The following table shows the required configuration parameters and example values:
| Name | Value |
|--------------------------------|------------------------------------------------------------|
| Configurator connection string | `https://test:test@configurator.gitlab.com` |
| Jitsu host | `https://jitsu.gitlab.com` |
| Jitsu project ID | `g0maofw84gx5sjxgse2k` |
| Jitsu administrator email | `jitsu.admin@gitlab.com` |
| Jitsu administrator password | `<your_password>` |
| Collector host | `https://collector.gitlab.com` |
| ClickHouse URL | `https://<username>:<password>@clickhouse.gitlab.com:8123` |
| Cube API URL | `https://cube.gitlab.com` |
| Cube API key | `25718201b3e9...ae6bbdc62dbb` |
1. Select **Save changes**. 1. Select **Save changes**.
## Product analytics dashboards ## Product analytics dashboards
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册