Skip to content

Open-source status page, incident response and uptime monitoring

otel api (#1291)

Thibault Le Ouayb405ae9c90ec
diff --git a/apps/server/src/routes/v1/monitors/get.test.ts b/apps/server/src/routes/v1/monitors/get.test.ts
index 24d13a661..11fb719e9 100644
--- a/apps/server/src/routes/v1/monitors/get.test.ts
+++ b/apps/server/src/routes/v1/monitors/get.test.ts
@@ -9,6 +9,7 @@ test("return the monitor", async () => {
"x-openstatus-key": "1",
},
});
+
const result = MonitorSchema.safeParse(await res.json());
expect(res.status).toBe(200);
diff --git a/apps/server/src/routes/v1/monitors/get.ts b/apps/server/src/routes/v1/monitors/get.ts
index 2f3bfc03e..d88f4cf43 100644
--- a/apps/server/src/routes/v1/monitors/get.ts
+++ b/apps/server/src/routes/v1/monitors/get.ts
@@ -52,7 +52,15 @@ export function registerGetMonitor(api: typeof monitorsApi) {
});
}
- const data = MonitorSchema.parse(_monitor);
+ const data = MonitorSchema.parse({
+ ..._monitor,
+ openTelemetry: _monitor.otelEndpoint
+ ? {
+ headers: _monitor.otelHeaders ?? undefined,
+ endpoint: _monitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
diff --git a/apps/server/src/routes/v1/monitors/get_all.ts b/apps/server/src/routes/v1/monitors/get_all.ts
index e253aa280..e9af393ab 100644
--- a/apps/server/src/routes/v1/monitors/get_all.ts
+++ b/apps/server/src/routes/v1/monitors/get_all.ts
@@ -38,7 +38,17 @@ export function registerGetAllMonitors(app: typeof monitorsApi) {
)
.all();
- const data = z.array(MonitorSchema).parse(_monitors);
+ const data = z.array(MonitorSchema).parse(
+ _monitors.map((monitor) => ({
+ ...monitor,
+ openTelemetry: monitor.otelEndpoint
+ ? {
+ endpoint: monitor.otelEndpoint ?? undefined,
+ headers: monitor.otelHeaders ?? undefined,
+ }
+ : undefined,
+ })),
+ );
return c.json(data, 200);
});
diff --git a/apps/server/src/routes/v1/monitors/post.ts b/apps/server/src/routes/v1/monitors/post.ts
index c70f5844b..b8b643bbf 100644
--- a/apps/server/src/routes/v1/monitors/post.ts
+++ b/apps/server/src/routes/v1/monitors/post.ts
@@ -104,7 +104,15 @@ export function registerPostMonitor(api: typeof monitorsApi) {
.returning()
.get();
- const data = MonitorSchema.parse(_newMonitor);
+ const data = MonitorSchema.parse({
+ ..._newMonitor,
+ openTelemetry: _newMonitor.otelEndpoint
+ ? {
+ headers: _newMonitor.otelHeaders ?? undefined,
+ endpoint: _newMonitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
diff --git a/apps/server/src/routes/v1/monitors/post_http.ts b/apps/server/src/routes/v1/monitors/post_http.ts
index 5325b0c0b..06f910a64 100644
--- a/apps/server/src/routes/v1/monitors/post_http.ts
+++ b/apps/server/src/routes/v1/monitors/post_http.ts
@@ -79,14 +79,14 @@ export function registerPostMonitorHTTP(api: typeof monitorsApi) {
}
}
- const { request, regions, assertions, otelHeaders, ...rest } = input;
+ const { request, regions, assertions, openTelemetry, ...rest } = input;
const headers = input.request.headers
? Object.entries(input.request.headers)
: undefined;
- const otelHeadersEntries = otelHeaders
- ? Object.entries(otelHeaders).map(([key, value]) => ({
+ const otelHeadersEntries = openTelemetry?.headers
+ ? Object.entries(openTelemetry.headers).map(([key, value]) => ({
key: key,
value: value,
}))
@@ -110,6 +110,7 @@ export function registerPostMonitorHTTP(api: typeof monitorsApi) {
headers: headersEntries ? JSON.stringify(headersEntries) : undefined,
assertions: assert.length > 0 ? serialize(assert) : undefined,
timeout: input.timeout || 45000,
+ otelEndpoint: openTelemetry?.endpoint,
otelHeaders: otelHeadersEntries
? JSON.stringify(otelHeadersEntries)
: undefined,
@@ -117,7 +118,15 @@ export function registerPostMonitorHTTP(api: typeof monitorsApi) {
.returning()
.get();
- const data = MonitorSchema.parse(_newMonitor);
+ const data = MonitorSchema.parse({
+ ..._newMonitor,
+ openTelemetry: _newMonitor.otelEndpoint
+ ? {
+ headers: _newMonitor.otelHeaders ?? undefined,
+ endpoint: _newMonitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
diff --git a/apps/server/src/routes/v1/monitors/post_tcp.test.ts b/apps/server/src/routes/v1/monitors/post_tcp.test.ts
index 66173e446..101d3a3e7 100644
--- a/apps/server/src/routes/v1/monitors/post_tcp.test.ts
+++ b/apps/server/src/routes/v1/monitors/post_tcp.test.ts
@@ -23,9 +23,13 @@ test("create a valid monitor", async () => {
public: true,
}),
});
-
- const result = MonitorSchema.safeParse(await res.json());
-
+ const r = await res.json();
+ console.log(r);
+ const result = MonitorSchema.safeParse(r);
+ if (result.error) {
+ console.error(result.error);
+ throw new Error("Invalid monitor payload");
+ }
expect(res.status).toBe(200);
expect(result.success).toBe(true);
});
diff --git a/apps/server/src/routes/v1/monitors/post_tcp.ts b/apps/server/src/routes/v1/monitors/post_tcp.ts
index 5c8741c90..33bcfbad0 100644
--- a/apps/server/src/routes/v1/monitors/post_tcp.ts
+++ b/apps/server/src/routes/v1/monitors/post_tcp.ts
@@ -76,9 +76,9 @@ export function registerPostMonitorTCP(api: typeof monitorsApi) {
}
}
- const { request, regions, otelHeaders, ...rest } = input;
- const otelHeadersEntries = otelHeaders
- ? Object.entries(otelHeaders).map(([key, value]) => ({
+ const { request, regions, openTelemetry, ...rest } = input;
+ const otelHeadersEntries = openTelemetry?.headers
+ ? Object.entries(openTelemetry.headers).map(([key, value]) => ({
key: key,
value: value,
}))
@@ -99,11 +99,20 @@ export function registerPostMonitorTCP(api: typeof monitorsApi) {
otelHeaders: otelHeadersEntries
? JSON.stringify(otelHeadersEntries)
: undefined,
+ otelEndpoint: openTelemetry?.endpoint,
})
.returning()
.get();
- const data = MonitorSchema.parse(_newMonitor);
+ const data = MonitorSchema.parse({
+ ..._newMonitor,
+ openTelemetry: _newMonitor.otelEndpoint
+ ? {
+ headers: _newMonitor.otelHeaders ?? undefined,
+ endpoint: _newMonitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
diff --git a/apps/server/src/routes/v1/monitors/put.ts b/apps/server/src/routes/v1/monitors/put.ts
index 958367e31..d44a28ccd 100644
--- a/apps/server/src/routes/v1/monitors/put.ts
+++ b/apps/server/src/routes/v1/monitors/put.ts
@@ -111,7 +111,15 @@ export function registerPutMonitor(api: typeof monitorsApi) {
.returning()
.get();
- const data = MonitorSchema.parse(_newMonitor);
+ const data = MonitorSchema.parse({
+ ..._newMonitor,
+ openTelemetry: _newMonitor.otelEndpoint
+ ? {
+ headers: _newMonitor.otelHeaders ?? undefined,
+ endpoint: _newMonitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
}
diff --git a/apps/server/src/routes/v1/monitors/put_http.ts b/apps/server/src/routes/v1/monitors/put_http.ts
index f0607182c..c941442e1 100644
--- a/apps/server/src/routes/v1/monitors/put_http.ts
+++ b/apps/server/src/routes/v1/monitors/put_http.ts
@@ -92,14 +92,14 @@ export function registerPutHTTPMonitor(api: typeof monitorsApi) {
});
}
- const { request, regions, assertions, otelHeaders, ...rest } = input;
+ const { request, regions, assertions, openTelemetry, ...rest } = input;
const headers = input.request.headers
? Object.entries(input.request.headers)
: undefined;
- const otelHeadersEntries = otelHeaders
- ? Object.entries(otelHeaders).map(([key, value]) => ({
+ const otelHeadersEntries = openTelemetry?.headers
+ ? Object.entries(openTelemetry.headers).map(([key, value]) => ({
key: key,
value: value,
}))
@@ -122,6 +122,7 @@ export function registerPutHTTPMonitor(api: typeof monitorsApi) {
otelHeaders: otelHeadersEntries
? JSON.stringify(otelHeadersEntries)
: undefined,
+ otelEndpoint: openTelemetry?.endpoint,
assertions: assert ? serialize(assert) : "",
timeout: input.timeout || 45000,
updatedAt: new Date(),
@@ -130,7 +131,15 @@ export function registerPutHTTPMonitor(api: typeof monitorsApi) {
.returning()
.get();
- const data = MonitorSchema.parse(_newMonitor);
+ const data = MonitorSchema.parse({
+ ..._newMonitor,
+ openTelemetry: _newMonitor.otelEndpoint
+ ? {
+ headers: _newMonitor.otelHeaders ?? undefined,
+ endpoint: _newMonitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
}
diff --git a/apps/server/src/routes/v1/monitors/put_tcp.ts b/apps/server/src/routes/v1/monitors/put_tcp.ts
index c608dbc5b..ae9ef6bb1 100644
--- a/apps/server/src/routes/v1/monitors/put_tcp.ts
+++ b/apps/server/src/routes/v1/monitors/put_tcp.ts
@@ -90,10 +90,10 @@ export function registerPutTCPMonitor(api: typeof monitorsApi) {
});
}
- const { request, regions, otelHeaders, ...rest } = input;
+ const { request, regions, openTelemetry, ...rest } = input;
- const otelHeadersEntries = otelHeaders
- ? Object.entries(otelHeaders).map(([key, value]) => ({
+ const otelHeadersEntries = openTelemetry?.headers
+ ? Object.entries(openTelemetry.headers).map(([key, value]) => ({
key: key,
value: value,
}))
@@ -109,6 +109,7 @@ export function registerPutTCPMonitor(api: typeof monitorsApi) {
otelHeaders: otelHeadersEntries
? JSON.stringify(otelHeadersEntries)
: undefined,
+ otelEndpoint: openTelemetry?.endpoint,
timeout: input.timeout || 45000,
updatedAt: new Date(),
})
@@ -116,7 +117,15 @@ export function registerPutTCPMonitor(api: typeof monitorsApi) {
.returning()
.get();
- const data = MonitorSchema.parse(_newMonitor);
+ const data = MonitorSchema.parse({
+ ..._newMonitor,
+ openTelemetry: _newMonitor.otelEndpoint
+ ? {
+ headers: _newMonitor.otelHeaders ?? undefined,
+ endpoint: _newMonitor.otelEndpoint ?? undefined,
+ }
+ : undefined,
+ });
return c.json(data, 200);
});
}
diff --git a/apps/server/src/routes/v1/monitors/schema.ts b/apps/server/src/routes/v1/monitors/schema.ts
index d221992e9..13f9c6611 100644
--- a/apps/server/src/routes/v1/monitors/schema.ts
+++ b/apps/server/src/routes/v1/monitors/schema.ts
@@ -206,6 +206,24 @@ export const MonitorSchema = z
jobType: z.enum(monitorJobTypes).optional().default("http").openapi({
description: "The type of the monitor",
}),
+ openTelemetry: z
+ .object({
+ endpoint: z
+ .string()
+ .url()
+ .optional()
+ .default("http://localhost:4317")
+ .openapi({
+ description: "The endpoint of the OpenTelemetry collector",
+ }),
+ headers: z.record(z.string()).optional().default({}).openapi({
+ description: "The headers to send to the OpenTelemetry collector",
+ }),
+ })
+ .optional()
+ .openapi({
+ description: "The OpenTelemetry configuration",
+ }),
})
.openapi("Monitor");
@@ -325,21 +343,25 @@ const baseRequest = z.object({
regions: z.array(z.enum(flyRegions)).openapi({
description: "Regions to run the request in",
}),
- otelEndpoint: z
- .string()
- .url()
- .optional()
- .openapi({
- description: "OTEL endpoint to send metrics to",
- examples: ["https://otel.example.com"],
- }),
- otelHeaders: z
- .record(z.string(), z.string())
- .optional()
- .openapi({
- description: "Headers to send with the OTEL request",
- examples: [{ "Content-Type": "application/json" }],
- }),
+ openTelemetry: z
+ .object({
+ endpoint: z
+ .string()
+ .url()
+ .optional()
+ .openapi({
+ description: "OTEL endpoint to send metrics to",
+ examples: ["https://otel.example.com"],
+ }),
+ headers: z
+ .record(z.string(), z.string())
+ .optional()
+ .openapi({
+ description: "Headers to send with the OTEL request",
+ examples: [{ "Content-Type": "application/json" }],
+ }),
+ })
+ .nullish(),
});
const httpRequestSchema = z.object({