Skip to content

mgcrea/fastify-request-logger

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
January 25, 2021 10:36
src
September 15, 2023 15:32
September 7, 2023 18:49
September 7, 2023 18:49
January 10, 2023 12:01
January 12, 2023 16:12
September 14, 2023 15:34
September 14, 2023 15:34

FastifyRequestLogger

npm version npm total downloads npm monthly downloads npm license
build status dependencies status

Features

Compact request logger plugin for fastify.

Preview

Preview

Usage

npm install @mgcrea/fastify-request-logger @mgcrea/pino-pretty-compact --save
# or
pnpm add @mgcrea/fastify-request-logger @mgcrea/pino-pretty-compact

You probably want to disable fastify own request logging using the disableRequestLogging option.

import createFastify, { FastifyInstance, FastifyServerOptions } from "fastify";
import fastifyRequestLogger from "@mgcrea/fastify-request-logger";
import prettifier from "@mgcrea/pino-pretty-compact";

export const buildFastify = (options: FastifyServerOptions = {}): FastifyInstance => {
  const fastify = createFastify({
    logger: {
      level: "debug",
      transport: {
        target: "@mgcrea/pino-pretty-compact",
        options: { translateTime: "HH:MM:ss Z", ignore: "pid,hostname" },
      },
    },
    disableRequestLogging: true,
    ...options,
  });

  fastify.register(fastifyRequestLogger);

  return fastify;
};

Options

type FastifyRequestLoggerOptions = {
  logBody?: boolean;
  logBindings?: Record<string, unknown>;
  ignoredPaths?: Array<string | RegExp>;
  ignoredBindings?: Record<string, unknown>;
  ignore?: (request: FastifyRequest) => boolean;
};

Authors

License

The MIT License

Copyright (c) 2020 Olivier Louvignes <olivier@mgcrea.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.