Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
improve checker (#572)
Thibault Le Ouay30c6772f4b3c
diff --git a/apps/checker/cmd/main.go b/apps/checker/cmd/main.goindex 2af7baa2e..67ddd10f8 100644--- a/apps/checker/cmd/main.go+++ b/apps/checker/cmd/main.go@@ -90,6 +90,7 @@ func main() {Status: "error",StatusCode: res.StatusCode,Region: flyRegion,+ Message: res.Message,})} else if req.Status == "error" && statusCode.IsSuccessful() {// Q: Why here we check the data before updating the status in this scenario?@@ -147,7 +148,7 @@ func main() {c.String(http.StatusBadRequest, "region is required")return}- apiKey := c.GetHeader("x-openstatus-apikey")+ apiKey := c.GetHeader("x-openstatus-key")if apiKey == "" {c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})diff --git a/apps/checker/ping.go b/apps/checker/ping.goindex 5e7ed1cf8..538544e80 100644--- a/apps/checker/ping.go+++ b/apps/checker/ping.go@@ -4,8 +4,10 @@ import ("bytes""context""crypto/tls"+ "encoding/json""errors""fmt"+ "io""net/http""net/http/httptrace""net/url"@@ -26,6 +28,8 @@ type PingData struct {URL string `json:"url"`Region string `json:"region"`Message string `json:"message,omitempty"`+ Timing string `json:"timing,omitempty"`+ Headers string `json:"headers,omitempty"`}type Timing struct {@@ -40,6 +44,7 @@ type Timing struct {TransferStart int64 `json:"transferStart"`TransferDone int64 `json:"transferDone"`}+type Response struct {Status int `json:"status,omitempty"`Latency int64 `json:"latency"`@@ -63,25 +68,54 @@ func Ping(ctx context.Context, client *http.Client, inputData request.CheckerReqreq.Header.Set("User-Agent", "OpenStatus/1.0")for _, header := range inputData.Headers {- if header.Key != "" && header.Value != "" {+ if header.Key != "" {req.Header.Set(header.Key, header.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()+response, err := client.Do(req)+ timing.TransferDone = time.Now().UTC().UnixMilli()latency := time.Since(start).Milliseconds()+if err != nil {+ timingAsString, err := json.Marshal(timing)+ if err != nil {+ logger.Error().Err(err).Msg("error while parsing timing data")+ }var urlErr *url.Errorif errors.As(err, &urlErr) && urlErr.Timeout() {return PingData{- Latency: latency,- MonitorID: inputData.MonitorID,- Region: region,- WorkspaceID: inputData.WorkspaceID,- Timestamp: time.Now().UTC().UnixMilli(),- URL: inputData.URL,- Message: fmt.Sprintf("Timeout after %d ms", latency),+ Latency: latency,+ MonitorID: inputData.MonitorID,+ Region: region,+ WorkspaceID: inputData.WorkspaceID,+ Timestamp: start.UTC().UnixMilli(),+ CronTimestamp: inputData.CronTimestamp,+ URL: inputData.URL,+ Message: fmt.Sprintf("Timeout after %d ms", latency),+ Timing: string(timingAsString),}, nil}@@ -90,15 +124,47 @@ func Ping(ctx context.Context, client *http.Client, inputData request.CheckerReq}defer response.Body.Close()+ _, err = io.ReadAll(response.Body)+ if err != nil {+ return PingData{+ Latency: latency,+ MonitorID: inputData.MonitorID,+ Region: region,+ WorkspaceID: inputData.WorkspaceID,+ Timestamp: start.UTC().UnixMilli(),+ CronTimestamp: inputData.CronTimestamp,+ URL: inputData.URL,+ Message: fmt.Sprintf("Cannot read response body: %s", err.Error()),+ }, fmt.Errorf("error with monitorURL %s: %w", inputData.URL, err)+ }++ headers := make(map[string]string)+ for key := range response.Header {+ headers[key] = response.Header.Get(key)+ }++ // In TB we need to store them as string+ timingAsString, err := json.Marshal(timing)+ if err != nil {+ return PingData{}, fmt.Errorf("error while parsing timing data %s: %w", inputData.URL, err)+ }++ headersAsString, err := json.Marshal(headers)+ if err != nil {+ return PingData{}, fmt.Errorf("error while parsing headers %s: %w", inputData.URL, err)+ }+return PingData{Latency: latency,StatusCode: response.StatusCode,MonitorID: inputData.MonitorID,Region: region,WorkspaceID: inputData.WorkspaceID,- Timestamp: time.Now().UTC().UnixMilli(),+ Timestamp: start.UTC().UnixMilli(),CronTimestamp: inputData.CronTimestamp,URL: inputData.URL,+ Timing: string(timingAsString),+ Headers: string(headersAsString),}, nil}diff --git a/apps/checker/ping_test.go b/apps/checker/ping_test.goindex 32fa0c1bd..e858cce23 100644--- a/apps/checker/ping_test.go+++ b/apps/checker/ping_test.go@@ -26,7 +26,7 @@ func Test_ping(t *testing.T) {{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: "Test", 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/pkg/tinybird/client.go b/apps/checker/pkg/tinybird/client.goindex e1ee128d1..ec9761200 100644--- a/apps/checker/pkg/tinybird/client.go+++ b/apps/checker/pkg/tinybird/client.go@@ -37,7 +37,7 @@ func (c client) SendEvent(ctx context.Context, event any) error {}q := requestURL.Query()- q.Add("name", "ping_response__v5")+ q.Add("name", "ping_response__v7")requestURL.RawQuery = q.Encode()var payload bytes.Buffer@@ -60,7 +60,7 @@ func (c client) SendEvent(ctx context.Context, event any) error {}defer resp.Body.Close()- if resp.StatusCode != http.StatusOK || resp.StatusCode != http.StatusAccepted {+ if resp.StatusCode != http.StatusAccepted {log.Ctx(ctx).Error().Str("status", resp.Status).Msg("unexpected status code")return fmt.Errorf("unexpected status code: %d", resp.StatusCode)}diff --git a/apps/checker/pkg/tinybird/client_test.go b/apps/checker/pkg/tinybird/client_test.goindex c02b8c238..abf03de42 100644--- a/apps/checker/pkg/tinybird/client_test.go+++ b/apps/checker/pkg/tinybird/client_test.go@@ -64,7 +64,7 @@ func TestSendEvent(t *testing.T) {f: func(req *http.Request) (*http.Response, error) {url = req.URL.String()return &http.Response{- StatusCode: http.StatusOK,+ StatusCode: http.StatusAccepted,}, nil},}@@ -73,6 +73,6 @@ func TestSendEvent(t *testing.T) {err := client.SendEvent(ctx, "event")require.NoError(t, err)- require.Equal(t, "https://api.tinybird.co/v0/events?name=ping_response__v5", url)+ require.Equal(t, "https://api.tinybird.co/v0/events?name=ping_response__v7", url)})}diff --git a/packages/tinybird/src/client.ts b/packages/tinybird/src/client.tsindex 41eda4ccf..dc33ee18d 100644--- a/packages/tinybird/src/client.ts+++ b/packages/tinybird/src/client.ts@@ -18,7 +18,7 @@ import {const tb = new Tinybird({ token: process.env.TINY_BIRD_API_KEY! });export const publishPingResponse = tb.buildIngestEndpoint({- datasource: "ping_response__v5",+ datasource: "ping_response__v6",event: tbIngestPingResponse,});diff --git a/packages/tinybird/src/validation.ts b/packages/tinybird/src/validation.tsindex c8a864fce..c997a9250 100644--- a/packages/tinybird/src/validation.ts+++ b/packages/tinybird/src/validation.ts@@ -15,6 +15,22 @@ export const tbIngestPingResponse = z.object({url: z.string().url(),region: z.string().min(3).max(4), // REMINDER: won't work on fymessage: z.string().nullable().optional(),+ headers: z.record(z.string(), z.string()).nullable().optional(),+ timing: z+ .object({+ dnsStart: z.number().int(),+ dnsDone: z.number().int(),+ connectStart: z.number().int(),+ connectDone: z.number().int(),+ tlsHandshakeStart: z.number().int(),+ tlsHandshakeDone: z.number().int(),+ firstByteStart: z.number().int(),+ firstByteDone: z.number().int(),+ transferStart: z.number().int(),+ transferDone: z.number().int(),+ })+ .nullable()+ .optional(),});/**