npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@krauters/logger

v0.6.0

Published

TypeScript wrapper for Winston, optimized for structured Lambda logs and CloudWatch.

Downloads

950

Readme

Code Size Commits per Month Contributors Forks GitHub Stars Install Size GitHub Issues Last Commit License npm version Open PRs Repo Size Version visitors

@krauters/logger

A TypeScript logging utility optimized for structured logging in AWS Lambda environments. It provides a customizable, structured logger with flexible output options, including support for local development-friendly colorized output.


Features

  • Structured JSON Logging: Ideal for Lambda and other cloud environments.
  • Colorized Output: Configurable colorized output for easy local debugging.
  • Metric Publishing: Integrates with CloudWatch for metric tracking.
  • Customizable Formats: Switch between JSON and human-readable formats.
  • Singleton Pattern: Ensures consistent configuration across the application.
  • Environment-Based Configurations: Configure log formats, levels, and transports using environment variables.

Installation

Install the package via npm:

npm install @krauters/logger

or with Yarn:

yarn add @krauters/logger

Usage

Basic example for initializing and using the logger:

import { Logger, LogLevel } from '@krauters/logger'

// Initialize the logger with options
const logger = Logger.getInstance({
	configOptions: { LOG_LEVEL: LogLevel.Debug },
})

// Log messages at various levels
logger.info('Info level log')
logger.debug('Debug level log with metadata', { key: 'value' })
logger.error('An error occurred', { errorDetails: 'Error details here' })

// Publish metrics to CloudWatch
await logger.publishMetric({
	metricName: 'RequestCount',
	unit: 'Count',
	value: 1,
})

Configuration

The logger supports multiple configuration options to control logging format, levels, and transports. Some commonly used environment variables include:

  • LOG_LEVEL: Set the log level (debug, info, warn, error).
  • LOG_FORMAT: Choose between structured for json logging and friendly for colorized console output. (default: friendly)
  • REQUEST_ID: Optionally set a request ID for tracing log entries.
  • SIMPLE_LOGS: Optionally make log entries simpler (omit codename, version, use shorter requestId–useful for local development).

DotEnv

This package supports .env configuration.

Husky Integration

Husky helps manage Git hooks easily, automating tasks like running tests or linting before a commit. This ensures your code is in good shape before it’s pushed.

Pre-commit hooks in this project run scripts before a commit is finalized to catch issues or enforce standards. With Husky, setting up these hooks across your team becomes easy, keeping your codebase clean and consistent.

Our Custom Pre-Commit Hook

This project uses a custom pre-commit hook to run npm run bundle. This ensures that our bundled assets are always up-to-date before any commit (particularly valuable for TypeScript-based GitHub Actions). Husky automates this to prevent commits without a fresh bundle, keeping everything streamlined.

Using Logger as Pre-Commit Hooks

# ./husky/pre-commit
#!/bin/sh

MAIN_DIR=./node_modules/@krauters/logger/scripts/pre-commit
. $MAIN_DIR/index.sh

Contributing

This project aims to continually evolve and improve its core features, making it more efficient and easier to use. Development happens openly here on GitHub, and we’re thankful to the community for contributing bug fixes, enhancements, and fresh ideas. Whether you're fixing a small bug or suggesting a major improvement, your input is invaluable.

License

This project is licensed under the ISC License. Please see the LICENSE file for more details.

🥂 Thanks, Contributors!

Thanks for your time and contributions.

🔗 Related Packages in the Family

Check out the rest of our @krauters collection on npm/@krauters for more TypeScript utilities.