Skip to content

Update admin analytics docs #1246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2025
+25 −24
Merged

Update admin analytics docs #1246

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions docs/admin/analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,51 @@
# Analytics

<TierCallout>
Supported on [Enterprise](/pricing/enterprise) plans.
Supported on [Enterprise](/pricing/enterprise) plans.
<user>
Available via the Web app.
Available via the Web app.
</user>
</TierCallout>

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.
The analytics section helps Sourcegraph administrators understand user engagement across the various Sourcegraph features, identify power users, and convey value to internal leaders.

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

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.
- [Sourcegraph Cloud](/cloud) customers
- Self-hosted customers that have fully enabled usage telemetry and are running a supported version of Sourcegraph (5.9+)
- [Sourcegraph workspaces](https://workspaces.sourcegraph.com)

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.
<Callout type="info">Read and learn more about Analytics [here](/analytics).</Callout>

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.
## Data Visualizations

## Value Calculators
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.

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.
Each page can visualize the past week, month, or three months of data.

We designed this to be configurable by you because we want to...
- help admins understand the value that is being seen by their organization today.
- be customizable so admins can explore what changes will best increase developer time saved.
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.

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.
## Value Calculators

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.
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.

## FAQ
This is designed to be configurable because we want to:

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

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.
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.

**Do these improved analytics require sending data to Sourcegraph?**
## FAQs

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.
### Who has access to see these improved analytics? Where can I find it?

**How often is the data updated?**
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.

The data is updated approximately every 24 hours.
### Do these improved analytics require sending data to Sourcegraph?

**How does this work with the existing usage stats page?**
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.

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.
### How often is the data updated?

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