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

@betsys-nestjs/monitoring

v8.3.0

Published

NestJS prometheus implementations using prom-client library

Downloads

143

Readme

Dependencies

| Package | Version | | --------------------------- | ------- | | on-headers | ^1.0.0 | | prom-client | ^14.0.0 | | @betsys-nestjs/config-utils | ^2.0.0 | | @hapi/joi | ^17.0.0 | | @nestjs/common | ^10.0.0 | | @nestjs/config | ^3.0.0 | | @nestjs/core | ^10.0.0 | | @nestjs/platform-express | ^10.0.0 | | @nestjs/swagger | ^7.0.0 | | express | ^4.0.0 | | reflect-metadata | <1.0.0 | | rxjs | ^7.0.0 |

Usage

Just register the module in your application module. If you are not using cluster, use the SimpleMonitoringModule

import {Module} from '@nestjs/common';
import {SimpleMonitoringModule} from '@betsys/nestjs-monitoring';

@Module({
    imports: [
        SimpleMonitoringModule.forRoot({platformType: express}),
    ],
})
class AppModule {
}

The forRoot module factory function accepts the following parameters:

class SimpleMonitoringModule {
    static forRoot({contextType, registerControllers, hasClusterMetrics}): DynamicModule;
}
  • platformType You can chose between grpc and express that automatically initialize request logging
  • registerController (default = true) allows you to disable metrics controllers completely
  • hasClusterMetrics (default = false) bootstraps the module in cluster mode

If you are using cluster, use the ClusterMonitoringModule

import {Module} from '@nestjs/common';
import {ClusterMonitoringModule} from '@betsys/nestjs-monitoring';

@Module({
    imports: [
        ClusterMonitoringModule.forRoot({ registerController: true}),
    ],
})
class AppModule {
}

You can use cluster only with express platform.

The forRoot module factory function accepts the following parameters:

class ClusterMonitoringModule {
    static forRoot({registerController}): DynamicModule;
}
  • registerController (default = true) allows you to disable metrics controllers completely

Creating your own metrics

To create your own metrics, just create new metrics object and call its methods to add new value to metric. You can use MonitoringConfig to resolve metrics name to add configured prefix.

For example, simple monitoring service:

import {Injectable} from '@nestjs/common';
import {
    MonitoringConfig,
    Counter,
    Gauge,
    InjectMonitoringConfig,
    InjectRegistry,
    MonitoringConfigInterface,
    Registry
} from '@betsys/nestjs-monitoring';

@Injectable()
export class WebsocketMonitoringService {
    private readonly messagesSent: Counter<string>;

    constructor(
        @InjectMonitoringConfig() private readonly config: MonitoringConfigInterface,
        @InjectMonitoringRegistry() private readonly registry: Registry,
    ) {
        this.messagesSent = new Counter({
            name: this.config.getMetricsName('websocket_messages_sent'),
            help: 'count of messages sent over websocket',
            labelNames: ['event'],
            registers: [registry]
        });
    }

    incrementMessagesSent(event: string): void {
        this.messagesSent.inc({event});
    }
}

To see complete list of options and metrics, check prom-client.