Request Logger ๐Ÿชต

ci coverage style: very good analysis License: MIT

A middleware for shelf and dart_frog that helps write logs.

Features โœจ

  • ๐ŸŽฏ๐Ÿธ Works out of the box with Dart Frog and Shelf ๐Ÿ—„๏ธ.
  • โ˜๏ธ Built-in support for console-based logs & Google Cloud Logging.
  • ๐Ÿ’‰ Automatically injects the logger into your request handlers.
  • ๐Ÿ› Automatically logs uncaught errors.
  • ๐Ÿ“‹ Includes a ton of debugging information, including stacktraces.
  • ๐Ÿงช 100% code coverage verified with Very Good Workflows.

Quickstart ๐Ÿš€

Using Dart Frog ๐ŸŽฏ๐Ÿธ

This is a simplified example. For a full example visit /examples/dart_frog

Setup ๐Ÿ—๏ธ

Add the RequestLogger middlware in your top level _middlware.dart file.

import 'package:dart_frog/dart_frog.dart';
import 'package:request_logger/request_logger.dart';
import 'package:request_logger/log_formatters.dart';

Handler middleware(Handler handler) {
  return handler.use(
    fromShelfMiddleware(
      RequestLogger.middleware(logFormatter: formatSimpleLog()),
    ),
  );
}

Write Logs ๐Ÿ“

Read the RequestLogger from the RequestContext.

import 'package:dart_frog/dart_frog.dart';
import 'package:request_logger/request_logger.dart';

Response onRequest(RequestContext context) {
  final logger = context.read<RequestLogger>();
  logger.debug('Hello Logs');
  return Response();
}

Using Shelf ๐Ÿ—„๏ธ

This is a simplified example. For a full example visit /examples/shelf

Setup ๐Ÿ—๏ธ

Add the RequestLogger middlware in your Pipeline.

import 'package:request_logger/request_logger.dart';
import 'package:request_logger/log_formatters.dart';
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';

void main() {
  final handler = Pipeline()
      .addMiddleware(RequestLogger.middleware(logFormatter: formatSimpleLog()))
      .addHandler(_router);
  await serve(handler, ip, port);
}

Write Logs ๐Ÿ“

Read the RequestLogger by extracting it from the Request.

import 'package:request_logger/request_logger.dart';
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';

Response _handler(Request request) {
  final logger = RequestLogger.extractLogger(request);
  logger.debug('Hello Logs');

  return Response.ok('Hello, World!\n');
}

Using Different Log Formats

Request logger supports log formats by providing a different LogFormatter when adding your middleware. You can either provide your own or use one of the built-in formatters.

Built-in Formatters

All of the built in log formats live under package:request_logger/log_formatters.dart.

The built-in loggers currently are:

  • formatSimpleLog(): Formats a log with no particular specification – great for local development.
  • formatCloudLoggingLog(): Formats a log for Google Cloud Logging

Make You Own Formatter

You can make your own formatter for your own specification! Just make sure it returns a String.

Example:

LogFormatter formatMyCustomLog() => ({
      required Severity severity,
      required String message,
      required Request request,
      Map<String, dynamic>? payload,
      Map<String, dynamic>? labels,
      bool? isError,
      Chain? chain,
      Frame? stackFrame,
    }) {
      return 'My custom log: $message';
    };

GitHub

View Github