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

simples3logger

v0.1.0

Published

A simple, naive application logging utility that can integrate / write to a file in an AWS S3 bucket

Downloads

1

Readme

S3Logger

A simple, naive application logging utility that can integrate / write to a file in an AWS S3 bucket. This wasn't meant to replace a full-blown Winston, Bunyon, etc logger, but a quick drop-in for people who want to dump their log files to a file in an Amazon S3 bucket somewhere.

Installation

npm install s3logger --save

Usage

NOTE: This package uses async / await natively. Be sure that your version of NodeJS supports this without transpiling.

Basic

const {S3Logger, levels} = require('s3logger');

const logger = new S3Logger({
    /* Init options here */
});

logger.info('Hi, I am a message that will get written to both the console AND S3!');

logger.log(levels.DEBUG, 'I am using the explicit log function and specifying a log-level');

Options

{
    logFile = 'app.log',
    noConsole = false,
    secretAccessKey,
    accessKeyId,
    region = 'us-west-1',
    bucket,
    level,
}
  • logFile - String - Name of the log file that will be written to S3. Defaults to app.log.
  • noConsole - Boolean - Whether or not the logger should ignore writing out to the console. Defaults to false.
  • secretAccessKey - String - AWS IAM SecretAccessKey. It is highly recommend you create a dedicated IAM role to allow your cloud instances to read / write to S3. If you are developing locally, however, use secretAccessKey, combined with accessKeyId (below) to allow for testing integration with S3
  • accessKeyId - String - AWS IAM Access Key ID. Used in conjunction with the secretAccessKey. Please see note (above) for recommendations.
  • region - String - AWS region to use when reading / writing files. Defaults to us-west-1. Can be overwritten on the instance of S3Logger that you have initialized with new. See example below:
const logger = new require('s3logger).S3Logger({
    /* Options */
});
logger.region = 'us-east-1';
  • bucket - String - AWS S3 bucket where log file will be read / written. Can be overwritten on the instance of S3Logger that you have initialized with new. See example below:
const logger = new require('s3logger).S3Logger({
    /* Options */
});
logger.bucket = 'MyCoolBucket';
  • level - Number - Which type of severity will get logged. Supports a subset of standard npm logging variables (see below):
ERROR = 0
WARN = 1
INFO = 2
DEBUG = 3