Skip to content

LogTape should not buffer console logs in benchmarks#55

Draft
enisdenjo wants to merge 6 commits into
dahlia:mainfrom
enisdenjo:blockingconsole
Draft

LogTape should not buffer console logs in benchmarks#55
enisdenjo wants to merge 6 commits into
dahlia:mainfrom
enisdenjo:blockingconsole

Conversation

@enisdenjo

@enisdenjo enisdenjo commented Jun 19, 2025

Copy link
Copy Markdown

Making the benchmark more1 fair since other loggers don't buffer but write synchrnously.

Also I didn't update the results since we're running on different machines. How would you like me to proceed?

Footnotes

  1. "more" because some other loggers like pino and bunyan write to stdout which is faster than console.logs

@enisdenjo enisdenjo marked this pull request as draft June 19, 2025 13:45

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @enisdenjo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the fairness and accuracy of the LogTape logger's benchmarks. It achieves this by adjusting the LogTape console sink configuration within the benchmark suite to enforce synchronous logging, thereby aligning its performance measurement with other loggers that do not buffer their output.

Highlights

  • Benchmark Fairness: Modified the LogTape console sink configuration in benchmarks/console.ts to disable non-blocking behavior, ensuring that console logs are written synchronously during benchmarks. This change aims to make the LogTape benchmark more comparable to other loggers that write synchronously.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request modifies the LogTape benchmark configuration by setting nonBlocking: false for the console sink. The goal is to ensure LogTape writes console logs synchronously during benchmarks, making the performance comparison fairer against other logging libraries that operate synchronously by default. The change is specific, well-justified by the PR description, and appears correct for achieving a more equitable benchmark environment.

@dahlia

dahlia commented Jun 20, 2025

Copy link
Copy Markdown
Owner

I think using nonBlocking: true is not that unfair, because other logging libraries also buffer (by themselves or through stream interfaces). 😅

@enisdenjo

enisdenjo commented Jun 20, 2025

Copy link
Copy Markdown
Author

All that logger.info does in non-blocking LogTape's console sink is adds a log to an interval macrotask, which is of the lowest prio in the event loop; so actually none of the logs ever get written during the benchmark. Not even when the buffer is full, because the buffer flush on log will just queue another macrotask.

LogTape is essentially benchmarking the arr.push method. 😅


I think the goal here should be to benchmark log writing to stdout/console, that's only fair because only then you're benchmarking the whole lifecycle of a logger.

I've added checks ensuring that all iterations of the benchmark have been flushed out (only LogTape was failing that check with nonBlocking: true, all others were passing as is - meaning others aren't doing async writes). The results on my machine are:

summary
  pino
   1.88x faster than winston
   2.12x faster than LogTape
   2.24x faster than Hive Logger
   2.29x faster than bunyan    
   2.86x faster than log4js
   3.13x faster than Signale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants