Telemetry Gateway infrastructure operations
This document describes operational guidance for Telemetry Gateway infrastructure. This service is operated on the Managed Services Platform (MSP).
If you need assistance with MSP infrastructure, reach out to the Core Services team in #discuss-core-services.
Service overview
PROPERTY | DETAILS |
---|---|
Service ID | telemetry-gateway |
Owners | core-services |
Service kind | Cloud Run service |
Environments | dev, prod |
Docker image | index.docker.io/sourcegraph/telemetry-gateway |
Source code | github.com/sourcegraph/sourcegraph - cmd/telemetry-gateway |
Environments
dev
PROPERTY | DETAILS |
---|---|
Project ID | telemetry-gateway-dev-0050 |
Category | test |
Resources | |
Alerts | GCP monitoring |
Sentry | telemetry-gateway-dev |
Domain | telemetry-gateway.sgdev.org |
MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements.
ACCESS | ENTITLE REQUEST TEMPLATE |
---|---|
GCP project read access | Entitle request for the ‘Engineering Projects’ folder |
GCP project write access | Entitle request for the ‘Engineering Projects’ folder |
For Terraform Cloud access, see dev Terraform Cloud.
dev Cloud Run
The Telemetry Gateway dev service implementation is deployed on Google Cloud Run.
PROPERTY | DETAILS |
---|---|
Console | Cloud Run service |
Service logs | GCP logging |
You can also use sg msp
to quickly open a link to your service logs:
sg msp logs telemetry-gateway dev
dev Terraform Cloud
This service’s configuration is defined in sourcegraph/managed-services/services/telemetry-gateway/service.yaml
, and sg msp generate telemetry-gateway dev
generates the required infrastructure configuration for this environment in Terraform.
Terraform Cloud (TFC) workspaces specific to each service then provisions the required infrastructure from this configuration.
You may want to check your service environment’s TFC workspaces if a Terraform apply fails (reported via GitHub commit status checks in the sourcegraph/managed-services
repository, or in #alerts-msp-tfc).
To access this environment’s Terraform Cloud workspaces, you will need to log in to Terraform Cloud and then request Entitle access to membership in the “Managed Services Platform Operator” TFC team. The “Managed Services Platform Operator” team has access to all MSP TFC workspaces.
The Terraform Cloud workspaces for this service environment are grouped under the msp-telemetry-gateway-dev
tag, or you can use:
sg msp tfc view telemetry-gateway dev
prod
PROPERTY | DETAILS |
---|---|
Project ID | telemetry-gateway-prod-acae |
Category | external |
Resources | |
Alerts | GCP monitoring |
Sentry | telemetry-gateway-prod |
Domain | telemetry-gateway.sourcegraph.com |
MSP infrastructure access needs to be requested using Entitle for time-bound privileges.
ACCESS | ENTITLE REQUEST TEMPLATE |
---|---|
GCP project read access | Entitle request for the ‘Managed Services ’ folder |
GCP project write access | Entitle request for the ‘Managed Services’ folder |
For Terraform Cloud access, see prod Terraform Cloud.
prod Cloud Run
The Telemetry Gateway prod service implementation is deployed on Google Cloud Run.
PROPERTY | DETAILS |
---|---|
Console | Cloud Run service |
Service logs | GCP logging |
You can also use sg msp
to quickly open a link to your service logs:
sg msp logs telemetry-gateway prod
prod Terraform Cloud
This service’s configuration is defined in sourcegraph/managed-services/services/telemetry-gateway/service.yaml
, and sg msp generate telemetry-gateway prod
generates the required infrastructure configuration for this environment in Terraform.
Terraform Cloud (TFC) workspaces specific to each service then provisions the required infrastructure from this configuration.
You may want to check your service environment’s TFC workspaces if a Terraform apply fails (reported via GitHub commit status checks in the sourcegraph/managed-services
repository, or in #alerts-msp-tfc).
To access this environment’s Terraform Cloud workspaces, you will need to log in to Terraform Cloud and then request Entitle access to membership in the “Managed Services Platform Operator” TFC team. The “Managed Services Platform Operator” team has access to all MSP TFC workspaces.
The Terraform Cloud workspaces for this service environment are grouped under the msp-telemetry-gateway-prod
tag, or you can use:
sg msp tfc view telemetry-gateway prod