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

@aptoma/grimm-pusher

v1.0.1

Published

Module for pushing events to Grimm

Downloads

23

Readme

Grimm Pusher

Node module for pushing events to Grimm.

Usage

Install with npm:

$ npm install --save @aptoma/grimm-pusher

Include it in your code:

const grimmPusher = require('@aptoma/grimm-pusher');

const options = {
	host: 'https://grimm.example.com',
	apiKey: 'secret',
	// Batch events within this number of milliseconds
	throttleMs: 1000,
	// Send regardless of throttling once this many events are queued
	maxBatchSize: 100
};

// Create instance
const grimmService = grimmPusher.createService(options);
// Or as singleton
const grimmServiceSingleton = grimmPusher.singleton();
grimmServiceSingleton.configure(options);

// Fired when events are successfully processed
grimmService.on('success', console.info);
// Fired when an error occurs
grimmService.on('error', console.error);

// Add events for sending later
grimmService.add({
    name: 'SomeMetric',
    time: Date.now(), // Optional, will be set automatically if left out
    fields: {
        msec: 12
    },
    tags: {
        service: 'my-service'
    }
});

// Process any unsent events, should be called just before script terminates, to ensure there are no pending events
grimmService.process();

Batching

For better performance, it's recommended to batch events. The default is to send each event immediately, but you are strongly encouraged to enable batching.

You can safely send several hundred events in a batch. If event volume is moderate, sending every second is a good baseline.

Logging and events

GrimmPusher is an EventEmitter. The following events may fire:

  • success: When process() succeeds, either due to no pending events, or successful delivery of all events
  • error: When process() fails, either due to missing config or bad response from the backend