nestjs-metrics-reporter

📈 NestJS Metrics Reporter is a powerful, zero-dependency-injection Prometheus metrics solution designed specifically for NestJS applications. This lightweight tool enables developers to effortlessly report metrics from any part of their codebase without the hassle of complex setup or cumbersome dependency management.

Overview

The nestjs-metrics-reporter library is your go-to solution for streamlining metrics reporting in NestJS. It simplifies the process by allowing immediate metrics access through a global static reporter, eliminating the need for dependency injection or extensive configurations.

Quick Example

Incorporate this powerful tool into your application with just a few lines of code:

import { ReporterService } from 'nestjs-metrics-reporter';

ReporterService.counter('api_requests_total', { endpoint: '/users' });

Why Choose NestJS Metrics Reporter?

• 🚀 No Dependency Injection: Enjoy a cleaner codebase without the complexity of dependency injection.
• 🌟 Effortless Integration: Get started tracking metrics immediately with zero setup.
• 🎯 Focus on Simplicity: Achieve powerful metrics capabilities without the overhead of managing dependencies.
• 📤 Pushgateway Support: Easily push metrics to a Pushgateway server for efficient batch job monitoring.

Quick Start

1. Minimal Configuration

Begin with minimal setup by importing the ReporterModule in your application's AppModule:

import { Module } from "@nestjs/common";
import { ReporterModule } from 'nestjs-metrics-reporter';

@Module({
    imports: [
        ReporterModule.forRoot({
            defaultMetricsEnabled: true,
            defaultLabels: {
                app: 'my-app',
                environment: 'production',
            },
            // Add optional configurations here
        }),
    ],
})
export class AppModule {
}

2. Reporting Metrics Anywhere

Once initialized, you can report metrics from any location throughout your application:

import { Injectable } from '@nestjs/common';
import { ReporterService } from 'nestjs-metrics-reporter';

@Injectable()
export class UserService {
    async createUser() {
        ReporterService.counter('users_created_total', {
            source: 'api',
            user_type: 'standard'
        });
        
        ReporterService.gauge('active_users', 42, {
            region: 'us-east-1'
        });
        
        await ReporterService.pushMetrics('user_service_job');
    }
}

API Reference

Utilize the global static service for reporting metrics with ease:

Contributing

We welcome contributions! Check our Contributing Guide for more details on getting involved.