NestJS Metrics Reporter
[](https://badge.fury.io/js/nestjs-metrics-reporter)
[](https://opensource.org/licenses/Apache-2.0)
📊 A **zero-dependency-injection** alternative to Prometheus metrics solutions for NestJS.
Effortlessly report metrics from anywhere in your codebase without complex setup or dependency injection.
[Overview](#overview) •
[Quick Start](#quick-start) •
[API Reference](#api-reference) •
[Testing](#testing) •
[Contributing](#contributing) •
[License](#license)
## Installation
```bash
npm install nestjs-metrics-reporter
```
---
## Overview
`nestjs-metrics-reporter` is a lightweight, **zero-setup** solution for reporting metrics in your NestJS application.
It eliminates the need for dependency injection or extensive configuration. Instantly report metrics from anywhere in
your application using a global static reporter.
```typescript
import { ReporterService } from 'nestjs-metrics-reporter';
ReporterService.counter( 'api_requests_total', { endpoint: '/users' } );
```
```mermaid
graph TD
subgraph Application["Application"]
UserModule[User Module]
ProductModule[Product Module]
UserModule --> ReporterService
ProductModule --> ReporterService
ReporterService --> MetricsService
MetricsService --> Registry["Prometheus Registry (Singleton)"]
MetricsController[/metrics endpoint/] --> Registry
end
Prometheus[Prometheus Scraper] --> MetricsController
MetricsService["Metrics Service (Counters, Gauges, etc.)"]
ReporterService["Reporter Service (Global Wrapper)"]
```
---
## Why Choose `nestjs-metrics-reporter`?
🚀 **No Dependency Injection**
No need for cumbersome dependency injection, making your code much more cleaner.
🌟 **Effortless Integration**
Start tracking metrics immediately with zero setup.
🎯 **Focus on Simplicity**
Powerful metrics without the complexity of managing dependencies or boilerplate code.
📤 **Pushgateway Support**
Easily push metrics to a Pushgateway server for batch job metrics.
---
## Quick Start
### 1. Import and Configure the Module
Minimal setup required! Just import the `ReporterModule` in your `AppModule`.
```typescript
import { Module } from "@nestjs/common";
import { ReporterModule } from 'nestjs-metrics-reporter';
@Module( {
imports: [
ReporterModule.forRoot( {
// Default metrics are disabled by default, set to true to enable.
defaultMetricsEnabled: true,
defaultLabels: {
app: 'my-app',
environment: 'production',
},
// Optional: Configure interceptors for custom metrics
interceptors: [ SomeInterceptor ],
// Optional: Configure Pushgateway for batch job metrics
pushgatewayUrl: 'http://pushgateway:9091',
pushgatewayOptions: {
timeout: 5000,
headers: {
'Custom-Header': 'value'
},
auth: {
username: 'user',
password: 'pass'
}
}
} ),
],
} )
export class AppModule {
}
```
### 2. Report Metrics Anywhere
Once initialized, you can start reporting metrics instantly from anywhere in your application.
```typescript
import { Injectable } from '@nestjs/common';
import { ReporterService } from 'nestjs-metrics-reporter';
@Injectable()
export class UserService {
async createUser() {
// Increment user creation counter
ReporterService.counter( 'users_created_total', {
source: 'api',
user_type: 'standard'
} );
// Increment counter with custom value
ReporterService.counter( 'batch_users_created_total', {
source: 'batch',
user_type: 'standard'
}, 5 );
// Update active user gauge
ReporterService.gauge( 'active_users', 42, {
region: 'us-east-1'
} );
// Push metrics to Pushgateway
await ReporterService.pushMetrics( 'user_service_job' );
}
}
```
---
## API Reference
The global static service for reporting metrics:
| Method | Description | Parameters |
|-----------------|-----------------------------|-------------------------------------------------------------|
| `counter()` | Increment a counter metric | `key: string, labels?: Record