Skip to content

Open-source status page, incident response and uptime monitoring

🔥 single endpoint checker (#576)

Thibault Le Ouay4844739e0d02
diff --git a/apps/checker/cmd/main.go b/apps/checker/cmd/main.go
index a38d02a33..2af7baa2e 100644
--- a/apps/checker/cmd/main.go
+++ b/apps/checker/cmd/main.go
@@ -16,6 +16,7 @@ import (
"github.com/openstatushq/openstatus/apps/checker/request"
"github.com/rs/zerolog/log"
+ unkey "github.com/WilfredAlmeida/unkey-go/features"
backoff "github.com/cenkalti/backoff/v4"
)
@@ -60,6 +61,14 @@ func main() {
return
}
+ // if the request has been routed to a wrong region, we forward it to the correct one.
+ region := c.GetHeader("fly-prefer-region")
+ if region != "" && region != flyRegion {
+ c.Header("fly-replay", fmt.Sprintf("region=%s", region))
+ c.String(http.StatusAccepted, "Forwarding request to %s", region)
+ return
+ }
+
var req request.CheckerRequest
if err := c.ShouldBindJSON(&req); err != nil {
log.Ctx(ctx).Error().Err(err).Msg("failed to decode checker request")
@@ -127,11 +136,55 @@ func main() {
c.JSON(http.StatusOK, gin.H{"message": "ok"})
})
- router.GET("/ping", func(c *gin.Context) {
+ router.GET("/health", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "pong", "fly_region": flyRegion})
return
})
+ router.POST("/ping/:region", func(c *gin.Context) {
+ region := c.Param("region")
+ if region == "" {
+ c.String(http.StatusBadRequest, "region is required")
+ return
+ }
+ apiKey := c.GetHeader("x-openstatus-apikey")
+ if apiKey == "" {
+ c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
+
+ return
+ }
+
+ response, err := unkey.KeyVerify(apiKey)
+ if err != nil {
+ c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
+ return
+ }
+
+ if !response.Valid {
+ fmt.Println("Key is valid")
+ }
+
+ if region != flyRegion {
+ c.Header("fly-replay", fmt.Sprintf("region=%s", region))
+ c.String(http.StatusAccepted, "Forwarding request to %s", region)
+ return
+ }
+
+ var req request.PingRequest
+ if err := c.ShouldBindJSON(&req); err != nil {
+ log.Ctx(ctx).Error().Err(err).Msg("failed to decode checker request")
+ c.JSON(http.StatusBadRequest, gin.H{"error": "invalid request"})
+ return
+ }
+
+ res, err := checker.SinglePing(c.Request.Context(), httpClient, req)
+ if err != nil {
+ c.JSON(http.StatusBadRequest, gin.H{"error": "invalid request"})
+ return
+ }
+ c.JSON(http.StatusOK, res)
+ return
+ })
httpServer := &http.Server{
Addr: fmt.Sprintf("0.0.0.0:%s", env("PORT", "8080")),
Handler: router,
diff --git a/apps/checker/go.mod b/apps/checker/go.mod
index dede75a7f..d37671206 100644
--- a/apps/checker/go.mod
+++ b/apps/checker/go.mod
@@ -10,6 +10,7 @@ require (
)
require (
+ github.com/WilfredAlmeida/unkey-go v0.2.0 // indirect
github.com/bytedance/sonic v1.9.1 // indirect
github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
@@ -19,6 +20,7 @@ require (
github.com/go-playground/universal-translator v0.18.1 // indirect
github.com/go-playground/validator/v10 v10.14.0 // indirect
github.com/goccy/go-json v0.10.2 // indirect
+ github.com/joho/godotenv v1.5.1 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/klauspost/cpuid/v2 v2.2.4 // indirect
github.com/leodido/go-urn v1.2.4 // indirect
diff --git a/apps/checker/go.sum b/apps/checker/go.sum
index a28caf689..41d867951 100644
--- a/apps/checker/go.sum
+++ b/apps/checker/go.sum
@@ -1,3 +1,5 @@
+github.com/WilfredAlmeida/unkey-go v0.2.0 h1:WnPDbfrwgiI2uZQmFhSATY5Q1FU8NCGtQ+h1VjJWfoI=
+github.com/WilfredAlmeida/unkey-go v0.2.0/go.mod h1:KZZ52al64FQUnWx0Zf2fIFmZvznwUiHqIg0nak/BGMw=
github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM=
github.com/bytedance/sonic v1.9.1 h1:6iJ6NqdoxCDr6mbY8h18oSO+cShGSMRGCEo7F2h0x8s=
github.com/bytedance/sonic v1.9.1/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U=
@@ -31,6 +33,8 @@ github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaS
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
diff --git a/apps/checker/ping.go b/apps/checker/ping.go
index 9581d90af..5e7ed1cf8 100644
--- a/apps/checker/ping.go
+++ b/apps/checker/ping.go
@@ -3,9 +3,11 @@ package checker
import (
"bytes"
"context"
+ "crypto/tls"
"errors"
"fmt"
"net/http"
+ "net/http/httptrace"
"net/url"
"os"
"time"
@@ -26,6 +28,29 @@ type PingData struct {
Message string `json:"message,omitempty"`
}
+type Timing struct {
+ DnsStart int64 `json:"dnsStart"`
+ DnsDone int64 `json:"dnsDone"`
+ ConnectStart int64 `json:"connectStart"`
+ ConnectDone int64 `json:"connectDone"`
+ TlsHandshakeStart int64 `json:"tlsHandshakeStart"`
+ TlsHandshakeDone int64 `json:"tlsHandshakeDone"`
+ FirstByteStart int64 `json:"firstByteStart"`
+ FirstByteDone int64 `json:"firstByteDone"`
+ TransferStart int64 `json:"transferStart"`
+ TransferDone int64 `json:"transferDone"`
+}
+type Response struct {
+ Status int `json:"status,omitempty"`
+ Latency int64 `json:"latency"`
+ Body string `json:"body,omitempty"`
+ Headers map[string]string `json:"headers,omitempty"`
+ Time int64 `json:"time"`
+ Timing Timing `json:"timing"`
+ Error string `json:"error,omitempty"`
+ Tags []string `json:"tags,omitempty"`
+}
+
func Ping(ctx context.Context, client *http.Client, inputData request.CheckerRequest) (PingData, error) {
logger := log.Ctx(ctx).With().Str("monitor", inputData.URL).Logger()
@@ -76,3 +101,71 @@ func Ping(ctx context.Context, client *http.Client, inputData request.CheckerReq
URL: inputData.URL,
}, nil
}
+
+func SinglePing(ctx context.Context, client *http.Client, inputData request.PingRequest) (Response, error) {
+ logger := log.Ctx(ctx).With().Str("monitor", inputData.URL).Logger()
+
+ req, err := http.NewRequestWithContext(ctx, inputData.Method, inputData.URL, bytes.NewReader([]byte(inputData.Body)))
+ if err != nil {
+ logger.Error().Err(err).Msg("error while creating req")
+ return Response{}, fmt.Errorf("unable to create req: %w", err)
+ }
+
+ req.Header.Set("User-Agent", "OpenStatus/1.0")
+ for key, value := range inputData.Headers {
+ req.Header.Set(key, value)
+ }
+ timing := Timing{}
+
+ trace := &httptrace.ClientTrace{
+ DNSStart: func(_ httptrace.DNSStartInfo) { timing.DnsStart = time.Now().UTC().UnixMilli() },
+ DNSDone: func(_ httptrace.DNSDoneInfo) { timing.DnsDone = time.Now().UTC().UnixMilli() },
+ ConnectStart: func(_, _ string) { timing.ConnectStart = time.Now().UTC().UnixMilli() },
+ ConnectDone: func(_, _ string, _ error) { timing.ConnectDone = time.Now().UTC().UnixMilli() },
+ TLSHandshakeStart: func() { timing.TlsHandshakeStart = time.Now().UTC().UnixMilli() },
+ TLSHandshakeDone: func(_ tls.ConnectionState, _ error) { timing.TlsHandshakeDone = time.Now().UTC().UnixMilli() },
+ GotConn: func(_ httptrace.GotConnInfo) {
+ timing.FirstByteStart = time.Now().UTC().UnixMilli()
+ },
+ GotFirstResponseByte: func() {
+ timing.FirstByteDone = time.Now().UTC().UnixMilli()
+ timing.TransferStart = time.Now().UTC().UnixMilli()
+ },
+ }
+
+ req = req.WithContext(httptrace.WithClientTrace(req.Context(), trace))
+
+ start := time.Now()
+ res, err := client.Do(req)
+ timing.TransferDone = time.Now().UTC().UnixMilli()
+ latency := time.Since(start).Milliseconds()
+
+ if err != nil {
+ var urlErr *url.Error
+ if errors.As(err, &urlErr) && urlErr.Timeout() {
+ return Response{
+ Latency: latency,
+ Timing: timing,
+ Time: start.UTC().UnixMilli(),
+ Error: fmt.Sprintf("Timeout after %d ms", latency),
+ }, nil
+ }
+
+ logger.Error().Err(err).Msg("error while pinging")
+ return Response{}, fmt.Errorf("error with monitorURL %s: %w", inputData.URL, err)
+ }
+ defer res.Body.Close()
+
+ headers := make(map[string]string)
+ for key := range res.Header {
+ headers[key] = res.Header.Get(key)
+ }
+
+ return Response{
+ Time: start.UTC().UnixMilli(),
+ Status: res.StatusCode,
+ Headers: headers,
+ Timing: timing,
+ Latency: latency,
+ }, nil
+}
diff --git a/apps/checker/ping_test.go b/apps/checker/ping_test.go
index b55082c1c..32fa0c1bd 100644
--- a/apps/checker/ping_test.go
+++ b/apps/checker/ping_test.go
@@ -19,14 +19,14 @@ func Test_ping(t *testing.T) {
want PingData
wantErr bool
}{
- {name: "200", args: args{client: &http.Client{}, inputData: request.CheckerRequest{URL: "https://openstat.us", CronTimestamp: 1,Headers:[]struct {
+ {name: "200", args: args{client: &http.Client{}, inputData: request.CheckerRequest{URL: "https://openstat.us", CronTimestamp: 1, Headers: []struct {
Key string `json:"key"`
Value string `json:"value"`
- } {{Key:"", Value:""}}}}, want: PingData{URL: "https://openstat.us", StatusCode: 200}, wantErr: false},
- {name: "200", args: args{client: &http.Client{}, inputData: request.CheckerRequest{URL: "https://openstat.us", CronTimestamp: 1,Headers:[]struct {
+ }{{Key: "", Value: ""}}}}, want: PingData{URL: "https://openstat.us", StatusCode: 200}, wantErr: false},
+ {name: "200", args: args{client: &http.Client{}, inputData: request.CheckerRequest{URL: "https://openstat.us", CronTimestamp: 1, Headers: []struct {
Key string `json:"key"`
Value string `json:"value"`
- } {{Key:"", Value:""}}}}, want: PingData{URL: "https://openstat.us", StatusCode: 200}, wantErr: false},
+ }{{Key: "", Value: ""}}}}, want: PingData{URL: "https://openstat.us", StatusCode: 200}, wantErr: false},
{name: "500", args: args{client: &http.Client{}, inputData: request.CheckerRequest{URL: "https://openstat.us/500", CronTimestamp: 1}}, want: PingData{URL: "https://openstat.us/500", StatusCode: 500}, wantErr: false},
{name: "500", args: args{client: &http.Client{}, inputData: request.CheckerRequest{URL: "https://somethingthatwillfail.ed", CronTimestamp: 1}}, want: PingData{URL: "https://openstat.us/500", StatusCode: 0}, wantErr: true},
diff --git a/apps/checker/request/request.go b/apps/checker/request/request.go
index bb768bc57..a9152c9a7 100644
--- a/apps/checker/request/request.go
+++ b/apps/checker/request/request.go
@@ -11,5 +11,12 @@ type CheckerRequest struct {
Key string `json:"key"`
Value string `json:"value"`
} `json:"headers,omitempty"`
- Status string `json:"status"`
+ Status string `json:"status"`
+}
+
+type PingRequest struct {
+ URL string `json:"url"`
+ Method string `json:"method"`
+ Body string `json:"body"`
+ Headers map[string]string `json:"headers"`
}