Skip to content

Commit f628b02

Browse files

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

docs/admin/analytics.mdx

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,51 @@
11
# Analytics
22

33
<TierCallout>
4-
Supported on [Enterprise](/pricing/enterprise) plans.
4+
Supported on [Enterprise](/pricing/enterprise) plans.
55
<user>
6-
Available via the Web app.
6+
Available via the Web app.
77
</user>
88
</TierCallout>
99

10-
The analytics section helps Sourcegraph administrators understand user engagement across the various Sourcegraph features, identify power users, and convey value to internal leaders. Introduced in version 3.42, the section includes analytics breakdowns for our most common features such as Batch Changes, Search Notebooks and search, while also providing basic user-level analytics.
10+
The analytics section helps Sourcegraph administrators understand user engagement across the various Sourcegraph features, identify power users, and convey value to internal leaders.
1111

12-
## Data Visualizations
12+
[Sourcegraph's managed Analytics](https://analytics.sourcegraph.com) for Cody and Code Search usage data is available for:
1313

14-
The goal of these pages is to help administrators answer any question they might have about how features are being used within their Sourcegraph instance. So far, we have introduced pages for Search, Batch Changes, Code Intel, Search, and Search Notebooks, as well as a general users page.
14+
- [Sourcegraph Cloud](/cloud) customers
15+
- Self-hosted customers that have fully enabled usage telemetry and are running a supported version of Sourcegraph (5.9+)
16+
- [Sourcegraph workspaces](https://workspaces.sourcegraph.com)
1517

16-
Each page can visualize the past one week, the past one month, or the path three months of data. For graphs that show user data, the graph can toggle between total users or unique users.
18+
<Callout type="info">Read and learn more about Analytics [here](/analytics).</Callout>
1719

18-
These graphs pull directly from the event log table within the Sourcegraph instance they are running. There should not be an increase to the storage on disk of these tables due to these new features. Further, no data beyond published ping data is sent back to Sourcegraph.
20+
## Data Visualizations
1921

20-
## Value Calculators
22+
These pages aim to help administrators answer any questions they might have about how features are being used within their Sourcegraph instance. You can view feature-based stats for Search, Batch Changes, Code Insights, and Cody. There are also tabs to study analytics for Search, Completions, and Chats, as well as a general Users page.
2123

22-
Each page also includes a total time saved value which can be used to measure the value Sourcegraph is bringing to your organization. This metric is derived from the configurable calculators below the total time saved value. Each calculator multiplies event log data (ex: number of precise code intel events such as a go-to-definition) by a configurable number of minutes saved per event to arrive at a time saved by the feature.
24+
Each page can visualize the past week, month, or three months of data.
2325

24-
We designed this to be configurable by you because we want to...
25-
- help admins understand the value that is being seen by their organization today.
26-
- be customizable so admins can explore what changes will best increase developer time saved.
26+
These graphs pull directly from the event log table within their Sourcegraph instance. Due to these new features, the storage on disk of these tables should not increase. Further, no data beyond published ping data is sent back to Sourcegraph.
2727

28-
These calculators exist on the Search, Code Intel, Batch Changes, and Notebooks analytics pages. Each calculator looks different as they include metrics specifically designed for that part of the application. Please note that the calculator configuration does not save and will return to the default if you navigate away from the page.
28+
## Value Calculators
2929

30-
If you have questions about how this works or about how to convey this value to leaders within your organization, please do not hesitate to reach out to your customer engineer.
30+
Each page also includes a total time saved value, which can be used to measure the value Sourcegraph is bringing to your organization. This metric is derived from the configurable calculators below the total time saved value. Each calculator multiplies event log data (e.g., the number of precise code intel events, such as a go-to-definition) by a configurable number of minutes saved per event to arrive at a time saved by the feature.
3131

32-
## FAQ
32+
This is designed to be configurable because we want to:
3333

34-
**Who has access to see these improved analytics? Where can I find it?**
34+
- Help admins understand the value that is being seen by their organization today
35+
- Be customizable so admins can explore what changes will best increase developer time saved
3536

36-
To see these new visualizations, you must be a site admin. You can find these under Site Admin section, under the Analytics section of the left-nav bar.
37+
These calculators are on the individual Search, Completions, and Chats analytics pages. If you have questions about how this works or about how to convey this value to your org's stakeholders, please do not hesitate to contact your customer engineer.
3738

38-
**Do these improved analytics require sending data to Sourcegraph?**
39+
## FAQs
3940

40-
No! The processing happens entirely within a your instance so no data is sent in or out of your instance. Further, these improved analytics leverage data already being captured within the event log table of your instance so there is no additional storage or processing required for this change. Basically, customers should notice no perceivable difference to their infrastructure.
41+
### Who has access to see these improved analytics? Where can I find it?
4142

42-
**How often is the data updated?**
43+
You must be a site admin for your Sourcegraph instance to see the Analytics. You can find these in the **Site Admin** section, under the **Instance Overview** section of the left nav bar.
4344

44-
The data is updated approximately every 24 hours.
45+
### Do these improved analytics require sending data to Sourcegraph?
4546

46-
**How does this work with the existing usage stats page?**
47+
No! The processing happens entirely within your instance, so no data is sent in or out of your instance. Further, these improved analytics leverage data already being captured within your instance's event log table, so there is no additional storage or processing required for this change. Customers should notice no perceivable difference in their infrastructure.
4748

48-
This new analytics experience has been redesigned from the ground up to provide the most value to administrators. In the future, we plan to deprecate the legacy usage stats page and statistics section once this functionality moved from experimental to generally available.
49+
### How often is the data updated?
4950

50-
Note: The new analytics experience is experimental. For billing information, use [usage stats](/admin/usage_statistics).
51+
The data is updated approximately every 24 hours.

0 commit comments

Comments
 (0)