grafana-logger
Version:
A functional logging package for Grafana with structured JSON output
139 lines • 7.33 kB
JavaScript
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
import fp from "fastify-plugin";
import { gl } from "./logger.js";
// Create a wrapper to make our logger compatible with FastifyBaseLogger
function createFastifyCompatibleLogger(logger) {
return {
// Implement required FastifyBaseLogger properties
level: "info",
// Implement all required logging methods
fatal: function (message) { return logger.fatal(message); },
error: function (message) { return logger.error(message); },
warn: function (message) { return logger.warn(message); },
info: function (message) { return logger.info(message); },
debug: function (message) { return logger.debug(message); },
trace: function (message) { return logger.trace(message); },
silent: function () { }, // Fastify expects this to be a function
// Implement child method
child: function (metadata) {
var childLogger = logger.child(metadata);
return createFastifyCompatibleLogger(childLogger);
},
};
}
/**
* Fastify plugin that integrates Grafana Logger as the logging system
*
* This plugin replaces the default Pino logger with our Grafana Logger
* while maintaining compatibility with Fastify's logging interface.
*
* @param fastify - Fastify instance
* @param options - Plugin options including service name and logger configuration
*/
function grafanaLoggerPlugin(fastify, options) {
return __awaiter(this, void 0, void 0, function () {
var serviceName, component, traceId, processId, tags, requestPayload, logger, fastifyLogger;
var _this = this;
return __generator(this, function (_a) {
serviceName = options.serviceName, component = options.component, traceId = options.traceId, processId = options.processId, tags = options.tags, requestPayload = options.requestPayload;
logger = gl(serviceName);
// Apply any initial configuration
if (component) {
logger = logger.component(component);
}
if (traceId) {
logger = logger.traceId(traceId);
}
if (processId) {
logger = logger.processId(processId);
}
if (tags) {
logger = logger.tags(tags);
}
if (requestPayload) {
logger = logger.requestPayload(requestPayload);
}
fastifyLogger = createFastifyCompatibleLogger(logger);
// Replace or decorate Fastify instance with the logger
// If log already exists, we replace it; otherwise we decorate
if (fastify.hasDecorator("log")) {
// Replace the existing logger
fastify.log = fastifyLogger;
}
else {
// Decorate Fastify instance with the logger
fastify.decorate("log", fastifyLogger);
}
// Add hook to provide request-specific logger
fastify.addHook("onRequest", function (request, reply) { return __awaiter(_this, void 0, void 0, function () {
var requestLogger, fastifyRequestLogger;
return __generator(this, function (_a) {
requestLogger = logger.child({
requestId: request.id,
method: request.method,
url: request.url,
userAgent: request.headers["user-agent"],
remoteAddress: request.ip,
});
fastifyRequestLogger = createFastifyCompatibleLogger(requestLogger);
// Decorate the request with the logger
request.log = fastifyRequestLogger;
return [2 /*return*/];
});
}); });
// Optional: Add hook to log request completion
fastify.addHook("onResponse", function (request, reply) { return __awaiter(_this, void 0, void 0, function () {
var duration;
return __generator(this, function (_a) {
duration = reply.getResponseTime();
request.log.info("".concat(request.method, " ").concat(request.url, " - ").concat(reply.statusCode, " - ").concat(duration, "ms"));
return [2 /*return*/];
});
}); });
return [2 /*return*/];
});
});
}
// Export the plugin with fastify-plugin wrapper to avoid scope issues
export default fp(grafanaLoggerPlugin, {
fastify: ">=4.0.0",
name: "grafana-logger",
});
// Also export named function for direct use
export { grafanaLoggerPlugin };
//# sourceMappingURL=fastify-plugin.js.map