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

driftwood-redis-logger

v1.0.1

Published

A driftwood logger that persists to redis

Downloads

3

Readme

driftwood-redis-logger

A driftwood logger that persists logs to redis and provides a CLI utility for searching/streaming said logs.

Installation

Logger

Augment your root drifwood logger with the redis logger, giving it an instance of redis and some options:

const createLogger = require('driftwood')
const createRedisLogger = require('driftwood-redis-logger')
const Redis = require('ioredis')

// Create an instance of ioredis
const redis = Redis()

// Create the redis logger as an additional logger to pass to driftwood
const additionalLoggers = [createRedisLogger(redis)]

// Create driftwood, passing in the additional loggers
module.exports = createLogger('my-app', additionalLoggers)

CLI

Create a file called bin/log in your app that pulls in the logger CLI:

#!/usr/bin/env node

// Function that returns a redis instance based on the environment given
function getRedis (environment) {
  return new Redis()
}

require('driftwood-redis-logger/cli')(getRedis)

After making it executable (chmod +x ./bin/log) you can then invoke it: ./bin/log --help. For ease of use, you could add it to your npm run scripts or to a Makefile.

API

createRedisLogger(redis, {options})

Creates the logger. redis should be an instance of ioredis. options is optional, and can contain the following keys:

  • key: key to use for the list that will contain the logs, defaults to driftwood-logs
  • channel: channel to publish logs on, defaults to driftwood-logs
  • limit: number of logs to keep, defaults to 100000
  • publish: whether to publish logs, defaults to true. If disabled you cannot use the stream functionality in the CLI.

require('driftwood-redis-logger/cli')(getRedis(environment), options)

Runs the CLI utility. getRedis() should be a function that receives the current environment and returns an instance of ioredis for that environment. options is optional and can contain the following keys:

  • key: key for the list that will contain the logs, defaults to driftwood-logs
  • channel: channel to listen for logs on, defaults to driftwood-logs