npmpackage.info

Gathering detailed insights and metrics for fastify-metrics

Other packages similar to fastify-metrics

@immobiliarelabs/fastify-metrics

6.0.1

A minimalistic and opinionated Fastify plugin that collects metrics and dispatches them to statsd

@fastify/busboy

3.0.0

A streaming parser for HTML form data for node.js

fastify

5.1.0

Fast and low overhead web framework, for Node.js

@fastify/aws-lambda

5.0.0

Inspired by aws-serverless-express to work with Fastify with inject functionality.

Gathering detailed insights and metrics for fastify-metrics

fastify-metrics

Prometheus metrics exporter for Fastify

12.1.0

101

MIT

TypeScript

19.65 kB

10,200,704 5.4

Installations

npm install fastify-metrics

Score

55.6

Supply Chain

97.8

Quality

80.4

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

2

Total

73

Closed

12

Merged

59

Issues

Open

10

Total

33

Closed

23

Releases

v12.1.0

Published on 20 Sept 2024

v12.0.0

Published on 19 Sept 2024

v11.0.0

Published on 08 Mar 2024

v10.6.0

Published on 14 Jan 2024

v10.5.0

Published on 19 Dec 2023

v10.4.1

Published on 28 Nov 2023

View all 49 releases

Developer

SkeLLLa

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

22.9.0

NPM Version

10.8.3 Statistics

101 Stars

296 Commits

33 Forks

4 Watching

1 Branches

23 Contributors

Updated on 17 Nov 2024

Bundle Size

72.39 kB

Minified

19.65 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (87.96%)

JavaScript (12.04%)

Total Downloads

Cumulative downloads

Total Downloads

10,200,704

Last day

4.8%

14,885

Compared to previous day

Last week

13.2%

84,755

Compared to previous week

Last month

-1.6%

349,282

Compared to previous month

Last year

285%

6,982,367

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

fastify-metrics

Prometheus metrics exporter for Fastify.

This plugin uses prom-client under the hood.

This plugin also adds two http metrics for your routes:

Requests duration histogram
Requests duration summary

Fastify support

v3.x.x - supports fastify-1.x
v4.x.x - supports fastify-2.x prom-client-11.x
v5.x.x - supports fastify-2.x prom-client-12.x
v6.x.x - supports fastify-3.x
v9.x.x - supports fastify-4.x prom-client-14.x

Notable changes

v10.x.x

Replace route context.config with routeConfig due to deprecation in fastify v4 and removal in fastify v5. If you had disableMetrics option in you route config, update fastify to latest version.
Prefer request.routeOptions.method over deprecated request.routerMethod.

v9.x.x

Fastify v4 support.
Complete config rewrite, default behaviour changed.
Support disabling metrics in route config.
Now collects metrics only for registered routes by default.
Unknown routes metrics collection disabled by default.
Removed metrics from request. Now it uses WeakMap and not exposed.
Add balcklisting possibility for request methods.
Registry overrides moved to metric configuration.
Support overriding all Summary and Histogram options for default route metrics.

v6.x.x

Fastify v3 support.
Drop node.js 8 support.
enableDefaultMetrics - now enables only default prom-client metrics. Set to true by default.
enableRouteMetrics - additional flag that enables route metrics. Set to true by default.

Installation

1npm i fastify-metrics --save
2pnpm i fastify-metrics --save

_{Back to top}

Features and requirements

Collects default server metrics (see prom-client);
Collects route response timings
Adds metrics to fastify instance for your custom metrics.

Requires fastify >=4.0.0.
Node.js >=18.0.0.

_{Back to top}

Usage

Add it to your project like regular fastify plugin. Use register method and pass options to it.

1const fastify = require('fastify');
2const app = fastify();
3
4const metricsPlugin = require('fastify-metrics');
5await app.register(metricsPlugin, { endpoint: '/metrics' });

It also exports client to fastify instance fastify.metrics.client which you may use it in your routes.

You may create your metrics when app starts and store it in fastify.metrics object and reuse them in multiple routes.

Registry clear

After calling registry.clear() all metrics are removed from registry. In order to add them again to the registry, call fastify.mterics.initMetricsInRegistry.

_{Back to top}

Plugin options

See for details docs

Property	Type	Default Value
defaultMetrics?	IDefaultMetricsConfig	`{ enabled: true }`
endpoint?	string \| null \| `Fastify.RouteOptions`	`'/metrics'`
name?	string	`'metrics'`
routeMetrics?	IRouteMetricsConfig	`{ enabled: true }`
promClient?	`prom-client` instance \| null	`null`

Route metrics

Property	Type	Default Value
enabled?	boolean \| { histogram: boolean, summary: boolean }	`true`
enableSummaries?	boolean	`true`
groupStatusCodes?	boolean	`false`
invalidRouteGroup?	string	`'__unknown__'`
methodBlacklist?	readonly string[]	`['HEAD','OPTIONS','TRACE','CONNECT',]`
overrides?	IRouteMetricsOverrides
registeredRoutesOnly?	boolean	`true`
customLabels?	Record<string, string \| ((request: FastifyRequest, reply: FastifyReply) => string)>	`undefined`
routeBlacklist?	readonly (string \| RegExp)[]	`[]`

Route metrics enabled

The enabled configuration option can be either a boolean which enables/disables generation of both histograms and summaries, or it can be set to an object that allows you to pick individually whether you want histograms or summaries to be generated, for example:

{
  ...
  routeMetrics: {
    enabled: {
      histogram: true,
      summary: false
    }
  }
}

would result in the library only generating histograms.

Route metrics overrides

You may override default metrics settings. You may provide overrides for two metrics tracking http request durations: histogram and summary.

1const fastify = require('fastify');
2const app = fastify();
3const metricsPlugin = require('fastify-metrics');
4
5await app.register(metricsPlugin, {
6  endpoint: '/metrics',
7  routeMetrics: {
8    overrides: {
9      histogram: {
10        name: 'my_custom_http_request_duration_seconds',
11        buckets: [0.1, 0.5, 1, 3, 5],
12      },
13      summary: {
14        help: 'custom request duration in seconds summary help',
15        labelNames: ['status_code', 'method', 'route'],
16        percentiles: [0.5, 0.75, 0.9, 0.95, 0.99],
17      },
18    },
19  },
20});

Labels

Property	Type	Default value
getRouteLabel?	(request: FastifyRequest) => string	`undefined`
method?	string	`'method'`
route?	string	`'route'`
status?	string	`'status_code'`

Request durations summary

Property	Type	Default value
name?	string	`'http_request_summary_seconds'`
help?	string	`'request duration in seconds summary'`
percentiles?	number[]	`[0.5, 0.9, 0.95, 0.99]`

Request durations histogram

Property	Type	Default value
name?	string	`'http_request_duration_seconds'`
help?	string	`'request duration in seconds'`
buckets?	number[]	`[0.05, 0.1, 0.5, 1, 3, 5, 10]`

_{Back to top}

HTTP routes metrics in Prometheus

The following table shows what metrics will be available in Prometheus (subject to the enabled configuration option). Note suffixes like _bucket, _sum, _count are added automatically.

metric	labels	description
`http_request_duration_seconds_count`	`method`, `route`, `status_code`	Requests total count
`http_request_duration_seconds_bucket`	`method`, `route`, `status_code`	Requests durations by bucket
`http_request_summary_seconds`	`method`, `route`, `status_code`	Requests duration percentiles
`http_request_summary_seconds_count`	`method`, `route`, `status_code`	Requests total count

_{Back to top}

API Docs

See docs.

_{Back to top}

Changelog

See changelog.

_{Back to top}

License

Licensed under MIT.

_{Back to top}

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/verify.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/verify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/verify.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/verify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/verify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/SkeLLLa/fastify-metrics/verify.yml/master?enable=pin
Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 7 third-party GitHubAction dependencies pinned

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.4

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to fastify-metrics

Other packages similar to fastify-metrics

fastify-metrics

Installations

Score

Pull Requests

2

73

12

59

Issues

10

33

23

Releases

Developer

Developer Guide

CommonJS

Yes

22.9.0

10.8.3

Statistics

Bundle Size

72.39 kB

19.65 kB

Languages

Total Downloads

10,200,704

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

fastify-metrics

ToC

Fastify support

Notable changes

v10.x.x

v9.x.x

v6.x.x

Installation

Features and requirements

Usage

Registry clear

Plugin options

Route metrics

Route metrics enabled

Route metrics overrides

Labels

Request durations summary

Request durations histogram

HTTP routes metrics in Prometheus

API Docs

Changelog

See also

License

10

10

10

10

10

7

2

0

0

0

0

0

5.4

/10