Skip to content

API-57 request logs to stdout as JSON for CloudWatch #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sedv8808 merged 1 commit into from
Jul 16, 2026
Merged

API-57 request logs to stdout as JSON for CloudWatch #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 20 additions & 24 deletions app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ const cookieParser = require('cookie-parser');
const cors = require('cors');
const express = require('express');
const morgan = require('morgan');
const rfs = require('rotating-file-stream'); // version 2.x
const path = require('path');
Comment on lines 8 to 9
// const helmet = require('helmet');
const YAML = require('yamljs');
Expand Down Expand Up @@ -70,32 +69,29 @@ app.use(optionalAuth);

app.locals.db = dbtest();

// test trigger watch restart - 09/12/20
// create a write stream (in append mode)

const pad = (num) => (num > 9 ? '' : '0') + num;
const generator = (time, index) => {
if (!time) return 'access.log';

const month = time.getFullYear() + '' + pad(time.getMonth() + 1);
const day = pad(time.getDate());
const hour = pad(time.getHours());
const minute = pad(time.getMinutes());

return `${month}/${month}${day}-${hour}${minute}-${index}-access.log`;
};
// setup the logger
app.enable('trust proxy');

const accessLogStream = rfs.createStream(generator, {
interval: '1d', // rotate daily
// path: path.join(__dirname, 'logs'),
compress: true,
// Log requests to stdout (captured by CloudWatch on App Runner): JSON in prod
// for Logs Insights, readable format in dev. Skip the health check to avoid noise.
const skipHealthChecks = (req) =>
req.url === '/healthcheck' || req.url.startsWith('/healthcheck/');
Comment on lines +77 to +78

const jsonAccessFormat = (tokens, req, res) => JSON.stringify({
type: 'access', // discriminator for queries: filter type = "access"
time: tokens.date(req, res, 'iso'),
ip: tokens['remote-addr'](req, res),
method: tokens.method(req, res),
path: tokens.url(req, res),
status: Number(tokens.status(req, res)),
bytes: Number(tokens.res(req, res, 'content-length')) || 0,
ms: Number(tokens['response-time'](req, res)),
ua: tokens['user-agent'](req, res),
});

// setup the logger
app.enable('trust proxy');
app.use(morgan(':date[iso]\t:remote-addr\t:method\t:url\t:status\t:res[content-length]\t:response-time[0]\t:user-agent', {
stream: accessLogStream,
}));
app.use(env === 'production'
? morgan(jsonAccessFormat, { stream: process.stdout, skip: skipHealthChecks })
: morgan('dev'));

const options = {
// swaggerUrl: `http://localhost:${apiPort}/api-docs`,
Expand Down