artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 19:21:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

msp/runtime: use scoped loggers for healthz, expose EnvironmentID in contract (#59724)

Browse Source 
As titled. Also downgrades healthz failures to warn - we have additional alerting for if this fails persistently at an infrastructure level.
This commit is contained in:
Robert Lin 2024-01-22 16:42:27 -08:00 committed by GitHub
parent 96fe493057
commit f3b13f44eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/managedservicesplatform/runtime/contract.go
View File

@ -21,6 +21,10 @@ type Contract struct {
// MSP indicates if we are running in a live Managed Services Platform
// environment. In local development, this should generally be false.
MSP bool
// EnvironmentID is the ID of the MSP environment this service is deployed
// in. In local development, this should be 'unknown' if ENVIRONMENT_ID is
// not set.
EnvironmentID string
// Port is the port the service must listen on.
Port int
// ExternalDNSName is the DNS name the service uses, if one is configured.
@ -50,7 +54,6 @@ type internalContract struct {
diagnosticsSecret *string
opentelemetry opentelemetry.Config
sentryDSN *string
environmentID *string
}
func newContract(logger log.Logger, env *Env, service ServiceMetadata) Contract {
@ -58,6 +61,7 @@ func newContract(logger log.Logger, env *Env, service ServiceMetadata) Contract
return Contract{
MSP: env.GetBool("MSP", "false", "indicates if we are running in a MSP environment"),
EnvironmentID: env.Get("ENVIRONMENT_ID", "unknown", "MSP Service Environment ID"),
Port: env.GetInt("PORT", "", "service port"),
ExternalDNSName: env.GetOptional("EXTERNAL_DNS_NAME", "external DNS name provisioned for the service"),
RedisEndpoint: env.GetOptional("REDIS_ENDPOINT", "full Redis address, including any prerequisite authentication"),
@ -74,8 +78,7 @@ func newContract(logger log.Logger, env *Env, service ServiceMetadata) Contract
env.GetOptional("OTEL_GCP_PROJECT_ID", "GCP project ID for OpenTelemetry export"),
defaultGCPProjectID),
},
sentryDSN: env.GetOptional("SENTRY_DSN", "Sentry error reporting DSN"),
environmentID: env.GetOptional("ENVIRONMENT_ID", "MSP Service Environment ID"),
sentryDSN: env.GetOptional("SENTRY_DSN", "Sentry error reporting DSN"),
},
}
}
@ -111,6 +114,8 @@ type ServiceState interface {
//
// ServiceState is a standardized reporter for the state of the service.
func (c Contract) RegisterDiagnosticsHandlers(r HandlerRegisterer, state ServiceState) {
diagnosticsLogger := c.internal.logger.Scoped("diagnostics")
// Only enable Prometheus metrics endpoint if we are not in a MSP environment,
// i.e. in local dev.
if !c.MSP {
@ -118,7 +123,7 @@ func (c Contract) RegisterDiagnosticsHandlers(r HandlerRegisterer, state Service
// convenience.
r.Handle("/metrics", promhttp.Handler())
// Warn because this should only be enabled in dev
c.internal.logger.Warn("enabled Prometheus metrics endpoint at '/metrics'")
diagnosticsLogger.Warn("enabled Prometheus metrics endpoint at '/metrics'")
}
// Simple auth-less version reporter
@ -130,10 +135,13 @@ func (c Contract) RegisterDiagnosticsHandlers(r HandlerRegisterer, state Service
// Authenticated healthcheck
r.Handle("/-/healthz", c.DiagnosticsAuthMiddleware(
http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
logger := opentelemetry.TracedLogger(r.Context(), c.internal.logger)
logger := opentelemetry.TracedLogger(r.Context(),
diagnosticsLogger.Scoped("healthz"))
if err := state.Healthy(r.Context(), r.URL.Query()); err != nil {
logger.Error("service not healthy", log.Error(err))
logger.Warn("service reported not healthy",
log.String("query", r.URL.Query().Encode()),
log.Error(err))
w.WriteHeader(http.StatusInternalServerError)
_, _ = w.Write([]byte("healthz: " + err.Error()))

3
lib/managedservicesplatform/runtime/service.go
View File

@ -9,7 +9,6 @@ import (
"github.com/sourcegraph/sourcegraph/lib/background"
"github.com/sourcegraph/sourcegraph/lib/managedservicesplatform/runtime/internal/opentelemetry"
"github.com/sourcegraph/sourcegraph/lib/pointers"
)
type ServiceMetadata interface {
@ -79,7 +78,7 @@ func Start[
Sentry: &log.SentrySink{
ClientOptions: sentry.ClientOptions{
Dsn: *contract.internal.sentryDSN,
Environment: pointers.Deref(contract.internal.environmentID, "unspecified"),
Environment: contract.EnvironmentID,
},
},
}