Files
tiennm99 186658a121 feat!: enrich Loki ingest with CF client info; move ip from label to metadata
Auto-inject low-cardinality labels (country, region, timezone) and
high-cardinality structured metadata (ip, user_agent, city, lat/long,
url, cf_ray, referer). Caller-supplied labels lose to auto on
collision; caller-supplied metadata wins on collision.

BREAKING CHANGE: `ip` is no longer a stream label. Rewrite
`{ip="..."}` LogQL queries as `{proxy="miti-loki"} | ip="..."`.
2026-05-10 22:53:49 +07:00

260 lines
7.7 KiB
JavaScript

// Cloudflare Worker to forward logs to Grafana Cloud Loki
// Validate label name according to Loki/Prometheus rules
// https://grafana.com/docs/loki/latest/get-started/labels/#label-format
function validateLabelName(name) {
// Check if it matches [a-zA-Z_:][a-zA-Z0-9_:]*
if (!/^[a-zA-Z_:][a-zA-Z0-9_:]*$/.test(name)) {
return false;
}
// Reject labels that start and end with double underscores (reserved for internal use)
if (name.startsWith('_') && name.endsWith('_')) {
return false;
}
return true;
}
// Low-cardinality CF-derived fields → stream labels.
// Caller-supplied params with these names are overwritten by spread in handleRequest.
function collectAutoLabels(request) {
return {
proxy: 'miti-loki',
country: request.cf?.country || 'unknown',
region: request.cf?.region || 'unknown',
timezone: request.cf?.timezone || 'unknown',
};
}
// High-cardinality fields → per-entry structured metadata.
// All values coerced to strings (Loki structured metadata requires string scalars).
function collectAutoMetadata(request) {
const ip = request.headers.get('CF-Connecting-IP') ||
request.headers.get('X-Forwarded-For') ||
request.headers.get('X-Real-IP') ||
'unknown';
return {
ip,
user_agent: request.headers.get('User-Agent') || 'unknown',
city: request.cf?.city || 'unknown',
latitude: String(request.cf?.latitude ?? 'unknown'),
longitude: String(request.cf?.longitude ?? 'unknown'),
url: request.url || 'unknown',
cf_ray: request.headers.get('CF-Ray') || 'unknown',
referer: request.headers.get('Referer') || 'unknown',
};
}
async function handleRequest(request, env) {
const url = new URL(request.url);
// Redirect to GitHub repo for documentation
if (request.method === 'GET') {
return Response.redirect('https://github.com/tiennm99/miti-loki', 302);
}
// Only handle POST requests
if (request.method !== 'POST') {
return new Response('Method not allowed. Please use POST.', {
status: 405,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
// Validate environment variables
if (!env.LOKI_HOST || !env.LOKI_USERNAME || !env.LOKI_PASSWORD) {
return new Response('Server configuration error: Missing Loki credentials', {
status: 500,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
try {
// Read and parse the request body
const body = await request.text();
// Validate that body is not empty
if (!body) {
return new Response('Request body is required', {
status: 400,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
// Parse JSON body
let data;
try {
data = JSON.parse(body);
} catch (parseError) {
return new Response(`Invalid JSON: ${parseError.message}`, {
status: 400,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
// Convert single object to array
const logs = Array.isArray(data) ? data : [data];
// Build auto-injected metadata once per request — same for every entry in a batch.
const autoMeta = collectAutoMetadata(request);
// Validate and build log values array
const values = [];
for (const entry of logs) {
// Validate message field is present
if (!entry.message) {
return new Response('Each log entry must have a "message" field', {
status: 400,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
// Get timestamp (use provided or current time in nanoseconds)
const timestamp = entry.timestamp || (Date.now() * 1000000).toString();
// Validate caller-supplied metadata if present
let callerMeta = {};
if (entry.metadata) {
if (typeof entry.metadata !== 'object' || Array.isArray(entry.metadata)) {
return new Response('Metadata must be an object', {
status: 400,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
for (const [key, value] of Object.entries(entry.metadata)) {
if (typeof value === 'object' && value !== null) {
return new Response(`Metadata field "${key}" contains nested object. Only flat key-value pairs are allowed.`, {
status: 400,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
}
callerMeta = entry.metadata;
}
// Caller metadata wins on key collision with auto-injected metadata.
const entryMetadata = { ...autoMeta, ...callerMeta };
values.push([timestamp.toString(), entry.message, entryMetadata]);
}
// Build stream labels: caller-supplied first, auto-injected last (auto wins).
const stream = {};
for (const [key, value] of url.searchParams.entries()) {
if (!validateLabelName(key)) {
return new Response(`Invalid label name "${key}". Label names must match [a-zA-Z_:][a-zA-Z0-9_:]* and cannot start and end with double underscores.`, {
status: 400,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
stream[key] = value;
}
Object.assign(stream, collectAutoLabels(request));
// Create Loki payload
const lokiPayload = {
streams: [
{
stream: stream,
values: values
}
]
};
// Construct Loki URL
const lokiPort = env.LOKI_PORT || '443';
const protocol = lokiPort === '443' ? 'https' : 'http';
const lokiUrl = `${protocol}://${env.LOKI_HOST}:${lokiPort}/loki/api/v1/push`;
// Create Basic Auth header
const auth = btoa(`${env.LOKI_USERNAME}:${env.LOKI_PASSWORD}`);
// Forward request to Loki
const lokiResponse = await fetch(lokiUrl, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Basic ${auth}`,
},
body: JSON.stringify(lokiPayload),
});
// Get response text
// https://grafana.com/docs/loki/latest/reference/loki-http-api/#ingest-logs
const responseText = await lokiResponse.text();
// Return the response from Loki with CORS headers
return new Response(responseText, {
status: lokiResponse.status,
statusText: lokiResponse.statusText,
headers: {
'Content-Type': lokiResponse.headers.get('Content-Type') || 'text/plain',
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'POST, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type',
},
});
} catch (error) {
return new Response(`Error forwarding to Loki: ${error.message}`, {
status: 500,
headers: {
'Access-Control-Allow-Origin': '*',
}
});
}
}
// Handle OPTIONS requests for CORS
function handleOptions(request) {
const corsHeaders = {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'POST, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type',
'Access-Control-Max-Age': '86400',
};
return new Response(null, {
status: 204,
headers: corsHeaders,
});
}
// Main event listener for the worker
addEventListener('fetch', event => {
const request = event.request;
// Handle CORS preflight requests
if (request.method === 'OPTIONS') {
event.respondWith(handleOptions(request));
} else {
event.respondWith(handleRequest(request, event.env || {}));
}
});
// Export for ES modules (newer Workers format)
export default {
async fetch(request, env) {
if (request.method === 'OPTIONS') {
return handleOptions(request);
}
return handleRequest(request, env);
}
};