Skip to content
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
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
6 changes: 0 additions & 6 deletions docs/admin/auth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -533,9 +533,3 @@ Usernames from authentication providers are normalized before being used in Sour
For example, a user whose external username (according the authentication provider) is `[email protected]` would have the Sourcegraph username `alice-smith`.

If multiple accounts normalize into the same username, separate accounts are still created, but Sourcegraph will add a randomized suffix to the username to ensure uniqueness.

## Remind users to connect external accounts

When authorization is activated, users must link their external code host accounts with their Sourcegraph accounts to access private repositories.
To ensure users are aware of any unlinked accounts, enable the external-accounts-modal feature flag.
This prompts users to connect any missing external accounts upon visiting Sourcegraph.
6 changes: 0 additions & 6 deletions docs/admin/deploy/docker-compose/aws.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# Install Sourcegraph on Amazon Web Services (AWS)

> ⚠️ We recommend new users use our [AWS AMI](/admin/deploy/machine-images/aws-oneclick) or [script-install](/admin/deploy/single-node/script) instructions, which are easier and offer more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Engineering team [email protected] if they wish to migrate to these deployment models.



This guide will take you through how to deploy Sourcegraph with [Docker Compose](https://docs.docker.com/compose/) to a single EC2 instance on Amazon Web Services (AWS).

Deploy a Sourcegraph instance with an [AWS AMI](/admin/deploy/machine-images/aws-ami) or [AWS One-Click](/admin/deploy/machine-images/aws-oneclick). (Recommended)


## Configure

Expand Down
2 changes: 0 additions & 2 deletions docs/admin/deploy/docker-compose/azure.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install Sourcegraph on Azure

> ⚠️ We recommend new users use our [machine image](/admin/deploy/machine-images/) or [script-install](/admin/deploy/single-node/script) instructions, which are easier and offer more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Engineering team [email protected] if they wish to migrate to these deployment models.

This guide will take you through how to set up a Sourcegraph instance on an Azure virtual machine with [Docker Compose](https://docs.docker.com/compose/).


Expand Down
2 changes: 0 additions & 2 deletions docs/admin/deploy/docker-compose/digitalocean.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install Sourcegraph on DigitalOcean

> ⚠️ We recommend new users use our [machine image](/admin/deploy/machine-images/) or [script-install](/admin/deploy/single-node/script) instructions, which are easier and offer more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Engineering team [email protected] if they wish to migrate to these deployment models.

---

This guide will take you through how to deploy a Sourcegraph instance to a single DigitalOcean Droplet with [Docker Compose](https://docs.docker.com/compose/).
Expand Down
2 changes: 0 additions & 2 deletions docs/admin/deploy/docker-compose/google_cloud.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install Sourcegraph on Google Cloud

> ⚠️ We recommend new users use our [GCE machine image](/admin/deploy/machine-images/gce) or [script-install](/admin/deploy/single-node/script) instructions, which are easier and offer more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Engineering team [email protected] if they wish to migrate to these deployment models.

This guide will take you through how to deploy Sourcegraph with [Docker Compose](https://docs.docker.com/compose/) to a single node running on Google Cloud.

## Configure
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Single-node, self hosted solution for enterprises looking for a simpler, non-Kub

Best for enterprises looking for a self-hosted solution on the Cloud provider of their choice.

Customized machine images allow you to spin up a preconfigured Sourcegraph instance with just a few clicks, all in less than 10 minutes. Currently available in the following hosts:
Machine images provide a preconfigured Sourcegraph instance that can be deployed in minutes with minimal effort. While they offer simplicity, they are designed as a standardized solution and do not support customization. Currently available on the following hosts:

<QuickLinks>
<QuickLink title="Amazon Machine Image (AMI)" icon='lightbulb' href="/admin/deploy/machine-images/aws-ami" />
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/deploy/machine-images/aws-oneclick.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page describes how to launch a verified and pre-configured Sourcegraph instance in just ~10 minutes using our one-click CloudFormation template and standard AMIs.

Prefer manually installing on AWS yourself? See our [AMI](/admin/deploy/machine-images/aws-ami) installation options or our [script-install](/admin/deploy/single-node/script) installation options.
Prefer manually installing on AWS yourself? See our [AMI](/admin/deploy/machine-images/aws-ami) installation options.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ When running an [external PostgreSQL instance](/admin/external_services/postgres
- [Heroku](https://devcenter.heroku.com/articles/upgrading-heroku-postgres-databases)
- [EnterpriseDB](https://www.enterprisedb.com/docs/en/9.6/pg/upgrading.html)
- [Citus](http://docs.citusdata.com/en/v8.1/admin_guide/upgrading_citus.html)
- [Aiven PostgreSQL](https://help.aiven.io/postgresql/operations/how-to-perform-a-postgresql-in-place-major-version-upgrade)
- [Aiven PostgreSQL](https://aiven.io/docs/platform/concepts/maintenance-window#related-pages)
- [Your own PostgreSQL](https://www.postgresql.org/docs/16/pgupgrade.html)
4. Turn Sourcegraph back on connecting to the now-upgraded database.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ A billable active Code Search or Code Intelligence Platform user is one who is s

A user who has accessed a Sourcegraph product is counted as active once they complete an action that represents usage reflected above.

User counts can be found in the **Site admin** section of the Sourcegraph web application, and Cody-specific usage metrics can be found in the [Cody Analytics service](../cody/clients/enable-cody-enterprise#analytics).
User counts and more usage metrics can be found in [Sourcegraph Analytics](../analytics).
18 changes: 18 additions & 0 deletions docs/analytics/cloud.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Sourcegraph Cloud Analytics

The following instructions are for all Sourcegraph Cloud and self-hosted customers who have upgraded to a sufficient version of Sourcegraph (5.9+) and fully enabled telemetry usage. Customers that self-host can also view our [self-hosted analytics enablement](/self-hosted).

![Sourcegraph-cloud-analytics](https://storage.googleapis.com/sourcegraph-assets/cloud-analytics.png)

## Enablement instructions

To enable Sourcegraph Analytics:

- Create an account on [Sourcegraph Accounts](https://accounts.sourcegraph.com/), or find the email address associated with your existing account.
- Contact your Sourcegraph Technical Advisor or point of contact (or email us at [email protected] if you don't know your contact), provide them with the email address you used to register above and ask for access to Sourcegraph Analytics.
- They will validate your account and link it to your Sourcegraph Enterprise instance's usage metrics.
- Sign in to [Sourcegraph Analytics](https://cody-analytics.sourcegraph.com).

## Data export

Sourcegraph Cloud Analytics also includes a CSV export option with key metrics like the number of searches, chats, autocomplete suggestions, completion acceptance rate (CAR %), and more. The data is split by user, day, client/editor, and programming language, perfect for automating retrieval and analyzing data in ways that make the most sense to your organization.
101 changes: 101 additions & 0 deletions docs/analytics/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Sourcegraph Analytics

Enterprise customers can use Sourcegraph Analytics to get a clear view of usage, engagement, performance, and impact.

## Sourcegraph Cloud Analytics

[Sourcegraph Cloud](/cloud) customers can use our managed [cloud analytics service](https://cody-analytics.sourcegraph.com) for Cody and Code Search usage data.
Self-hosted customers can also use this service, but they must

Upgrade to a supported version of Sourcegraph (5.9+)
Have fully enabled usage telemetry.
- [Enablement instructions](/analytics/cloud#enablement)

![Sourcegraph-cloud-analytics](https://storage.googleapis.com/sourcegraph-assets/cloud-analytics.png)

## Self-Hosted Analytics

Self-hosted customers will soon be able to use our self-hosted and locally deployed analytics service, built on Grafana, to see Sourcegraph usage data.

This product is in development now. If you would like to learn more, please contact your Sourcegraph representative.

## Metrics

We provide a set of metrics that can be used to monitor Sourcegraph usage, engagement, performance, and impact within your enterprise.

Learn more about how we think about [the ROI of Sourcegraph in our blog](https://sourcegraph.com/blog/measuring-the-impact-of-ai-coding-tools).

### User metrics available

| Metric | Description |
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| Total active users | Total number of unique users who have used any Sourcegraph product during the selected time |
| Average daily users | The average number of unique users who use Sourcegraph per day during the selected time |
| Average days of activity per user | The average number of days each user actively uses Sourcegraph during the selected time |
| Daily active users | Number of unique users who used Sourcegraph by day |
| Weekly active users | Number of unique users who used Sourcegraph by week |
| Daily users by product | Count of daily users across different Sourcegraph products (Cody, Code Search, Code Insights, etc.) |
| Product usage distribution (by percentage of users) | Percentage breakdown of users across different Sourcegraph product groupings during the selected time |
| Detailed user activity (top 20 users) | List of the 20 most active users during the selected time and their usage patterns |
| Frequency of usage | Count of users who used Sourcegraph _n_ times over the past 30 days |

Cody-only user metrics

Many of the metrics above are also available for Cody only. However, some user definitions are slightly different:

| User category | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authenticated users | All users signed in to Cody in an editor or interacted with Cody on the web during the selected period. [Read more](/admin/pricing#authenticated-users). |
| Active users | All users who sign in to Cody in an editor or interact with Cody on the web during the period selected. [Read more](/admin/pricing#billable-active-users). |

### Code Search & navigation metrics

| Metric | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| Total in-product searchers | Number of unique users who performed searches using the Sourcegraph search interface during the selected time |
| Total result clicks | Count of times users clicked on search results to view files or other resources during the selected time |
| Total file views | Number of times users viewed individual files through Sourcegraph during the selected time |
| Daily in-product search activity | Count of search operations performed each day through the Sourcegraph interface |
| Daily search users (in-product and API) | Number of unique users performing searches each day, including both UI and API usage |
| All searches (in-product and API) by type | Breakdown of searches by category (e.g., literal, regex), including both UI and API usage |
| Total code navigation actions | Count of all code navigation operations performed (e.g., go-to-definition, find references) during the selected time period |
| Precise code navigation % | Percentage of code navigation actions that used precise intelligence rather than search-based results during the selected time |
| Daily code navigation activity | Count of code navigation operations performed each day |
| Daily code navigation users | Number of unique users utilizing code navigation features each day |
| Precise vs. search-based code navigation actions by language | Comparison of precise vs. search-based navigation success rates broken down by programming language |

### Autocompletion metrics

| Metric | Description |
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Total accepted completions | Count of completions accepted by users during the selected time |
| Hours saved | The number of hours saved by Cody users, assuming 2 minutes saved per completion |
| Completions by day | The number of completions suggested by day and by editor. |
| Completion acceptance rate (CAR) | The percent of completions presented to a user for at least 750ms accepted by day, the editor, day, and month. |
| Weighted completion acceptance rate (wCAR) | Similar to CAR, but weighted by the number of characters presented in the completion, and only counting those fully retained by the user for X minutes after accepting the completion, by the editor, day, and month. |
| Average completion latency (ms) | The average milliseconds of latency before a user is presented with a completion suggestion by an editor. |
| Acceptance rate by language | CAR and total completion suggestions broken down by editor during the selected time |

### Chat and prompt metrics

| Metric | Description |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| Total chat events | Total number of chat interactions with Cody during the selected time |
| Minutes saved per chat | Average time saved per chat interaction with Cody during the selected time |
| Hours saved by chats | Total hours saved through Cody chat interactions during the selected time , assuming 5 minutes saved per chat |
| Cody chats by day | Daily count of chat interactions |
| Cody chat users | Daily count of chat users |
| Prompts created, edited, and deleted by day | Daily count of prompt management activities, including creation, modification, and removal |
| Users creating, editing, and deleting prompts by day | Number of unique users performing prompt management activities each day |

### Command metrics (deprecated)

_As of Sourcegraph version 5.10, commands are being deprecated in favor of our new feature, chat prompts. As a result, if your Sourcegraph instance is running version 5.10 or later, you may see decreased command usage. In the coming weeks, these command metrics will be deprecated and replaced with new prompt metrics on the Chats tab._

| Metric | Description |
| ----------------------- | ----------------------------------------------------------------------------------------------------------- |
| Total command events | Total number of command executions during the selected time |
| Hours saved by commands | Total hours saved through command executions during the selected time, assuming 5 minutes saved per command |
| Cody commands by day | Daily count of command executions |
| Cody command users | Daily count of command users |
| Most used commands | Ranking of most frequently used Cody commands during the selected time |
19 changes: 19 additions & 0 deletions docs/analytics/self-hosted.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Sourcegraph Self-Hosted Analytics

<Callout type="note">This feature is not yet available. Coming soon.</Callout>

Sourcegraph Self-Hosted Analytics is coming soon! Self-hosted customers can view usage metrics in a locally deployed analytics service built on Grafana.

This product is in development now. If you would like to learn more, please contact your Sourcegraph representative.

## Set-up instructions

Coming soon.

## Updates

Coming soon.

## Custom metrics

Coming soon.
Loading
Loading