Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willsoto/nestjs-prometheus
NestJS module for Prometheus
https://github.com/willsoto/nestjs-prometheus
metrics metrics-gathering nestjs prometheus typescript
Last synced: 2 days ago
JSON representation
NestJS module for Prometheus
- Host: GitHub
- URL: https://github.com/willsoto/nestjs-prometheus
- Owner: willsoto
- License: apache-2.0
- Created: 2019-11-21T22:55:47.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T01:50:54.000Z (8 months ago)
- Last Synced: 2024-05-02T05:31:25.232Z (8 months ago)
- Topics: metrics, metrics-gathering, nestjs, prometheus, typescript
- Language: TypeScript
- Homepage:
- Size: 6.22 MB
- Stars: 437
- Watchers: 4
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# NestJS Prometheus
- [Installation](#installation)
- [Usage](#usage)
- [Changing the metrics http endpoint](#changing-the-metrics-http-endpoint)
- [Disabling default metrics collection](#disabling-default-metrics-collection)
- [Configuring the default metrics](#configuring-the-default-metrics)
- [Injecting individual metrics](#injecting-individual-metrics)
- [Setting default labels](#setting-default-labels)
- [Prefixing custom metrics](#prefixing-custom-metrics)
- [Option 1 (recommended)](#option-1-recommended)
- [Option 2 (not recommended)](#option-2-not-recommended)
- [Available metrics](#available-metrics)
- [Counter](#counter)
- [Gauge](#gauge)
- [Histogram](#histogram)
- [Summary](#summary)
- [Providing a custom controller](#providing-a-custom-controller)
- [Pushgateway](#pushgateway)
## Installation
```bash
yarn add @willsoto/nestjs-prometheus prom-client
```
```bash
npm install @willsoto/nestjs-prometheus prom-client
```
## Usage
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
@Module({
imports: [PrometheusModule.register()],
})
export class AppModule {}
```
By default, this will register a `/metrics` endpoint that will return the [default metrics](https://github.com/siimon/prom-client#default-metrics).
### Changing the metrics http endpoint
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
@Module({
imports: [
PrometheusModule.register({
path: "/mymetrics",
}),
],
})
export class AppModule {}
```
### Disabling default metrics collection
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
@Module({
imports: [
PrometheusModule.register({
defaultMetrics: {
enabled: false,
},
}),
],
})
export class AppModule {}
```
### Configuring the default metrics
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
@Module({
imports: [
PrometheusModule.register({
defaultMetrics: {
// See https://github.com/siimon/prom-client#configuration
config: {},
},
}),
],
})
export class AppModule {}
```
## Injecting individual metrics
```typescript
// module.ts
import { Module } from "@nestjs/common";
import {
PrometheusModule,
makeCounterProvider,
} from "@willsoto/nestjs-prometheus";
import { Service } from "./service";
@Module({
imports: [PrometheusModule.register()],
providers: [
Service,
makeCounterProvider({
name: "metric_name",
help: "metric_help",
}),
],
})
export class AppModule {}
```
```typescript
// service.ts
import { Injectable } from "@nestjs/common";
import { InjectMetric } from "@willsoto/nestjs-prometheus";
import { Counter } from "prom-client";
@Injectable()
export class Service {
constructor(@InjectMetric("metric_name") public counter: Counter) {}
}
```
## Setting default labels
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
@Module({
imports: [
PrometheusModule.register({
defaultLabels: {
app: "My app",
},
}),
],
})
export class AppModule {}
```
See the [docs](https://github.com/siimon/prom-client#default-labels-segmented-by-registry) for more information.
## Prefixing custom metrics
You can add a custom prefix to all custom metrics by providing the `customMetricPrefix` option to the module configuration.
Some caveats:
In order to have the custom metrics registered in different modules from where the `PrometheusModule` was registered, you must do one of a few things:
### Option 1 (recommended)
1. Add the `PrometheusModule` to the `exports` of the registering `Module`. It may be useful to create a `CommonModule` that registers and exports the `PrometheusModule`.
2. Import that module into whatever module you are creating the custom metrics.
### Option 2 (not recommended)
1. Mark the `PrometheusModule` as `global`
## Available metrics
#### [Counter](https://github.com/siimon/prom-client#counter)
```typescript
import { makeCounterProvider } from "@willsoto/nestjs-prometheus";
```
#### [Gauge](https://github.com/siimon/prom-client#gauge)
```typescript
import { makeGaugeProvider } from "@willsoto/nestjs-prometheus";
```
#### [Histogram](https://github.com/siimon/prom-client#histogram)
```typescript
import { makeHistogramProvider } from "@willsoto/nestjs-prometheus";
```
#### [Summary](https://github.com/siimon/prom-client#summary)
```typescript
import { makeSummaryProvider } from "@willsoto/nestjs-prometheus";
```
## Providing a custom controller
If you need to implement any special logic or have access to the controller (e.g., to customize [Swagger](https://docs.nestjs.com/openapi/introduction)),
you can provide your own controller (or subclass) of the default controller.
Here is a basic example which should be enough to extend or customize in any way you might need.
```typescript
// my-custom-controller.ts
import { Controller, Get, Res } from "@nestjs/common";
import { PrometheusController } from "@willsoto/nestjs-prometheus";
import { Response } from "express";
@Controller()
class MyCustomController extends PrometheusController {
@Get()
async index(@Res({ passthrough: true }) response: Response) {
return super.index(response);
}
}
```
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
import { MyCustomController } from "./my-custom-controller";
@Module({
imports: [
PrometheusModule.register({
controller: MyCustomController,
}),
],
})
export class AppModule {}
```
## Pushgateway
In order to enable Pushgateway for injection, provide the configuration under the `pushgateway` key.
```typescript
import { Module } from "@nestjs/common";
import { PrometheusModule } from "@willsoto/nestjs-prometheus";
@Module({
imports: [
PrometheusModule.register({
pushgateway: {
url: "http://127.0.0.1:9091",
},
}),
],
})
export class AppModule {}
```
```typescript
import { Injectable } from "@nestjs/common";
import * as client from "prom-client";
@Injectable()
export class Service {
constructor(private readonly pushgateway: client.Pushgateway) {}
}
```