Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Commit

Permalink
core-services: point to generated MSP docs (#8766)
Browse files Browse the repository at this point in the history
The Pings version is a bit more robust, so I'm keeping that for the time
being - in most cases, we now point to the generated docs instead.
  • Loading branch information
bobheadxi authored Mar 25, 2024
1 parent ea8058f commit 5d3ddd2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 76 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,12 @@ For local development, please refer to its [README](https://github.com/sourcegra

> [!NOTE]
> To get access to most resources, you’ll need to [request infrastructure access](#infrastructure-access).
Here is a list of useful quick links:

- [Terraform Cloud workspaces](https://app.terraform.io/app/sourcegraph/workspaces?project=prj-7gzvzKCGcKupiA4s)
- [Cloud Run service (metrics overview)](https://console.cloud.google.com/run/detail/us-central1/pings/metrics?project=pings-prod-2f4f73edf1db)
- [Service logs](https://cloudlogging.app.goo.gl/JMmBSAbEceh6onpj8)
- [GCP alerts](https://console.cloud.google.com/monitoring/alerting?project=pings-prod-2f4f73edf1db)
- [GCP errors](https://console.cloud.google.com/errors?project=pings-prod-2f4f73edf1db)
- [GCP Cloud Profiler](https://console.cloud.google.com/profiler/pings?project=pings-prod-2f4f73edf1db)
>
> Refer to [Pings infrastructure (go/msp-ops/pings)](../../../managed-services/pings.md) for our new MSP-generated guidance.
### Infrastructure access

The following Entitle requests are needed to get access to Pings service infrastructure:

- [GCP Project - MSP Service Editor](https://app.entitle.io/request?targetType=resource&duration=43200&justification=TODO&integrationId=134476cb-0bd6-4c6d-a89f-e1550988bdd7&resourceId=d94da8c3-76eb-451a-9cbb-973ac3bc44b1&roleId=8b60a711-976c-4e56-9f8b-cb2c989faca4&grantMethodId=8b60a711-976c-4e56-9f8b-cb2c989faca4)
Refer to [Pings infrastructure (go/msp-ops/pings)](../../../managed-services/pings.md) for Entitle requests that are needed to get access to Pings service infrastructure:

### Deployment

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Telemetry Gateway

The Telemetry Gateway service is the service that ingests [telemetry v2 events](https://docs.sourcegraph.com/dev/background-information/telemetry) from all Sourcegraph instances, and is available at `telemetry-gateway.sourcegraph.com`.
The Telemetry Gateway service is the service that ingests [telemetry v2 events](https://sourcegraph.com/doc/dev/background-information/telemetry) from all Sourcegraph instances, and is available at `telemetry-gateway.sourcegraph.com`.

- As of 5.2.0, [certain flags can be configured](https://docs.sourcegraph.com/dev/background-information/telemetry#enabling-telemetry-export) to export events that have been instrumented with the new APIs to Telemetry Gateway.
- For Sourcegraph instances that prior to 5.2.0, no events are exported.
A [custom mechanism did exist for exporting events specifically from Cloud instances](https://docs.sourcegraph.com/dev/background-information/data-usage-pipeline) based on individual service agreements with customers - the new telemetry events will supersede this mechanism.

> NOTE: There is now a generated operations reference for the MSP-based Telemetry Gateway service in [Telemetry Gateway infrastructure](../../../managed-services/telemetry-gateway.md), generated by `sg msp operations` - as the generated docs improve, some content from this page will be migrated away.
For discussion around telemetry V2 adoption, please reach out to #wg-v2-telemetry.
For discussion around the Telemetry Gateway service, please reach out to #discuss-core-services.

## Service images

Expand All @@ -19,65 +20,4 @@ For local development, please refer to its [How to set up Telemetry Gateway loca

## Operations

> [!NOTE]
> To get access to most resources, you’ll need to [request infrastructure access](#infrastructure-access).
Here is a list of useful quick links:

- Prod instance: `telemetry-gateway.sourcegraph.com` - currently only accepts real Sourcegraph licenses.
- [Terraform Cloud workspaces](https://app.terraform.io/app/sourcegraph/workspaces?project=prj-9XNnACvkeM1VWteC)
- [Cloud Run service (metrics overview)](https://console.cloud.google.com/run/detail/us-central1/telemetry-gateway/metrics?project=telemetry-gateway-prod-acae)
- [Service logs](https://cloudlogging.app.goo.gl/kficDmGcZdMJHPQL9)
- [GCP alerts](https://console.cloud.google.com/monitoring/alerting?project=telemetry-gateway-prod-acae)
- [GCP errors](https://console.cloud.google.com/errors?project=telemetry-gateway-prod-acae)
- Dev instance: `telemetry-gateway.sgdev.org` - currently only accepts `dev-private` licenses.
- [Terraform Cloud workspaces](https://app.terraform.io/app/sourcegraph/workspaces?project=prj-nxL7Ti7x8xp6oZTU)
- [Cloud Run service (metrics overview)](https://console.cloud.google.com/run/detail/us-central1/telemetry-gateway/metrics?project=telemetry-gateway-dev-0050)
- [Service logs](https://cloudlogging.app.goo.gl/4oVGWGz1FQKVt5vm9)
- [GCP alerts](https://console.cloud.google.com/monitoring/alerting?project=telemetry-gateway-dev-0050)
- [GCP errors](https://console.cloud.google.com/errors?project=telemetry-gateway-dev-0050)

### Infrastructure access

The following Entitle requests are needed to get access to Telemetry Gateway service infrastructure:

- [GCP Project - MSP Service Editor](https://app.entitle.io/request?targetType=resource&duration=43200&justification=TODO&integrationId=134476cb-0bd6-4c6d-a89f-e1550988bdd7&resourceId=271c1799-6172-4099-8fe1-b186ac05aa06&roleId=b1bc8eac-3893-4847-a4a0-16dadb068bf2&grantMethodId=b1bc8eac-3893-4847-a4a0-16dadb068bf2)

All engineers should have access to the dev project by default.

### Deployment

The Telemetry Gateway service infrastructure is defined in [`sourcegraph/managed-services/services/telemetry-gateway`](https://github.com/sourcegraph/managed-services/tree/main/services/telemetry-gateway) utilizing [Managed Services Platform](./platform.md).

#### Modify deployment manifest

> [!WARNING]
> Due to the early-stage shape of Managed Services Platforms, we have yet to roll out standardized playbook. Please reach out to #team-core-services for modifying the deployment manifest. Instructions in this section are generally assumed with an upfront setup.
To modify the deployment manifest:

1. Update `service.yaml` file
1. Anywhere in the repository, run `sg msp generate telemetry-gateway prod`
1. Stage changes and make a pull request
1. The Terraform Cloud rolls out changes

#### Use a different image tag

To specify a Docker image tag other than the default, update the `service.yaml`:

```diff
- id: prod
...
deploy:
type: manual
+ manual:
+ tag: 218287_2023-05-10_5.0-5bd03cd18e71
```

### Observability

> [!NOTE] More stuff coming soon on this front
#### Metrics

The deployment's [Cloud Run metrics overview page](https://console.cloud.google.com/run/detail/us-central1/telemetry-gateway/metrics?project=telemetry-gateway-prod-acae) provides basic observability into the service provided out-of-the-box by Cloud Run, such as instance count and resource utilization.
Refer to [Telemetry Gateway infrastructure (go/msp-ops/telemetry-gateway)](../../../managed-services/telemetry-gateway.md).

0 comments on commit 5d3ddd2

Please sign in to comment.