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

pings: make it work with Cloud Run and sg msp (#56603)

Browse Source
This commit is contained in:
Joe Chen 2023-09-14 15:26:21 -04:00 committed by GitHub
parent c3c9985013
commit fa07cc2be7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/pings/shared/config.go
View File

@ -7,7 +7,8 @@ import (
type Config struct {
env.BaseConfig
Address string
Port int
DiagnosticsSecret string
PubSub struct {
ProjectID string
@ -16,7 +17,10 @@ type Config struct {
}
func (c *Config) Load() {
c.Address = c.Get("PINGS_ADDR", ":10086", "Address to serve Ping service on.")
c.Port = c.GetInt("PORT", "10086", "Port to serve Pings service on, generally injected by Cloud Run.")
c.DiagnosticsSecret = c.Get("DIAGNOSTICS_SECRET", "", "Secret for accessing diagnostics - "+
"should be used as 'Authorization: Bearer $secret' header when accessing diagnostics endpoints.")
c.PubSub.ProjectID = c.Get("PINGS_PUBSUB_PROJECT_ID", "", "The project ID for the Pub/Sub.")
c.PubSub.TopicID = c.Get("PINGS_PUBSUB_TOPIC_ID", "", "The topic ID for the Pub/Sub.")
}

24
cmd/pings/shared/main.go
View File

@ -3,7 +3,9 @@ package shared
import (
"context"
"encoding/json"
"fmt"
"net/http"
"strings"
"time"
"github.com/gorilla/mux"
@ -26,8 +28,10 @@ func Main(ctx context.Context, obctx *observation.Context, ready service.ReadyFu
if err != nil {
return errors.Errorf("create server handler: %v", err)
}
addr := fmt.Sprintf(":%d", config.Port)
server := httpserver.NewFromAddr(
config.Address,
addr,
&http.Server{
ReadTimeout: 75 * time.Second,
WriteTimeout: 10 * time.Minute,
@ -37,7 +41,7 @@ func Main(ctx context.Context, obctx *observation.Context, ready service.ReadyFu
// Mark health server as ready and go!
ready()
obctx.Logger.Info("service ready", log.String("address", config.Address))
obctx.Logger.Info("service ready", log.String("address", addr))
// Block until done
goroutine.MonitorBackgroundRoutines(ctx, server)
@ -56,7 +60,19 @@ func newServerHandler(logger log.Logger, config *Config) (http.Handler, error) {
if err != nil {
return nil, errors.Errorf("create Pub/Sub client: %v", err)
}
r.Path("/-/healthz").Methods(http.MethodGet).HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
r.Path("/-/healthz").Methods(http.MethodGet).HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
secret := strings.TrimPrefix(strings.ToLower(r.Header.Get("Authorization")), "bearer ")
if secret != config.DiagnosticsSecret {
w.WriteHeader(http.StatusUnauthorized)
return
}
if r.URL.Query().Get("full-suite") == "" {
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte("OK"))
return
}
// NOTE: Only mark as failed and respond with a non-200 status code if a critical
// component fails, otherwise the service would be marked as unhealthy and stop
// serving requests (in Cloud Run).
@ -65,6 +81,7 @@ func newServerHandler(logger log.Logger, config *Config) (http.Handler, error) {
if err := pubsubClient.Ping(context.Background()); err != nil {
failed = true
status["pubsubClient"] = err.Error()
logger.Error("failed to ping Pub/Sub client", log.Error(err))
} else {
status["pubsubClient"] = "OK"
}
@ -72,6 +89,7 @@ func newServerHandler(logger log.Logger, config *Config) (http.Handler, error) {
if hubspotutil.HasAPIKey() {
if err := hubspotutil.Client().Ping(30 * time.Second); err != nil {
status["hubspotClient"] = err.Error()
logger.Error("failed to ping HubSpot client", log.Error(err))
} else {
status["hubspotClient"] = "OK"
}

1
sg.config.yaml
View File

@ -324,6 +324,7 @@ commands:
checkBinary: .bin/pings
env:
SRC_LOG_LEVEL: info
DIAGNOSTICS_SECRET: 'lifeisgood'
PINGS_PUBSUB_PROJECT_ID: ''
PINGS_PUBSUB_TOPIC_ID: ''
HUBSPOT_ACCESS_TOKEN: ''