Skip to content

Commit

Permalink
chore(release): 10.6.0 [skip ci]
Browse files Browse the repository at this point in the history
## [10.6.0](v10.5.0...v10.6.0) (2024-01-14)

### 🚀 Features

* add way to inject custom prom-client instance ([#100](#100)) ([aa873d8](aa873d8))
  • Loading branch information
semantic-release-bot committed Jan 14, 2024
1 parent aa873d8 commit 87b403c
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 7 deletions.
7 changes: 7 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [10.6.0](https://github.com/SkeLLLa/fastify-metrics/compare/v10.5.0...v10.6.0) (2024-01-14)


### 🚀 Features

* add way to inject custom prom-client instance ([#100](https://github.com/SkeLLLa/fastify-metrics/issues/100)) ([aa873d8](https://github.com/SkeLLLa/fastify-metrics/commit/aa873d888eb5222cf66d3484231a516fb45b7603))

## [10.5.0](https://github.com/SkeLLLa/fastify-metrics/compare/v10.4.1...v10.5.0) (2023-12-19)


Expand Down
12 changes: 6 additions & 6 deletions docs/api/fastify-metrics.imetricspluginoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ export interface IMetricsPluginOptions

| Property | Modifiers | Type | Description |
| ------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| [clearRegisterOnInit](./fastify-metrics.imetricspluginoptions.clearregisteroninit.md) | | boolean | Clears the prom-client global registry before adding metrics. Defaults to <code>false</code>. |
| [defaultMetrics](./fastify-metrics.imetricspluginoptions.defaultmetrics.md) | | [IDefaultMetricsConfig](./fastify-metrics.idefaultmetricsconfig.md) | Default prom-client metrics config. Collects Prometheus recommended and Node.js specific metrics like event loop lag.|
| [endpoint](./fastify-metrics.imetricspluginoptions.endpoint.md) | | string \| null \| RouteOptions | Endpoint to expose metrics in Prometheus format. <code>null</code> - disables metrics exposure. |
| [name](./fastify-metrics.imetricspluginoptions.name.md) | | string | Plugin name that will be registered in Fastify instance. |
| [routeMetrics](./fastify-metrics.imetricspluginoptions.routemetrics.md) | | [IRouteMetricsConfig](./fastify-metrics.iroutemetricsconfig.md) | Per route metrics config. Collects response time metric on requests. |
| [promClient](./fastify-metrics.imetricspluginoptions.promclient.md) | | `Client` \| null | Optional. Allows overriding the internally used Prometheus client instance. Defaults to `null`. |
| [clearRegisterOnInit](./fastify-metrics.imetricspluginoptions.clearregisteroninit.md) | | boolean | Clears the prom-client global registry before adding metrics. Default to <code>false</code> |
| [defaultMetrics](./fastify-metrics.imetricspluginoptions.defaultmetrics.md) | | [IDefaultMetricsConfig](./fastify-metrics.idefaultmetricsconfig.md) | Default prom-client metrics config. Collect prometheus recommended and node.js specific metrics like event loop lag. |
| [endpoint](./fastify-metrics.imetricspluginoptions.endpoint.md) | | string \| null \| RouteOptions | Endpoint to expose metrics in prometheus format. <code>null</code> - disables metrics exposure |
| [name](./fastify-metrics.imetricspluginoptions.name.md) | | string | Plugin name that will be registered in fastify instance. |
| [promClient](./fastify-metrics.imetricspluginoptions.promclient.md) | | typeof client \| null | PromClient instance to override default internal promClient |
| [routeMetrics](./fastify-metrics.imetricspluginoptions.routemetrics.md) | | [IRouteMetricsConfig](./fastify-metrics.iroutemetricsconfig.md) | Per route metrics config. Collect response time metric on requests |
13 changes: 13 additions & 0 deletions docs/api/fastify-metrics.imetricspluginoptions.promclient.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [fastify-metrics](./fastify-metrics.md) &gt; [IMetricsPluginOptions](./fastify-metrics.imetricspluginoptions.md) &gt; [promClient](./fastify-metrics.imetricspluginoptions.promclient.md)

## IMetricsPluginOptions.promClient property

PromClient instance to override default internal promClient

<b>Signature:</b>

```typescript
promClient: typeof client | null;
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://json.schemastore.org/package.json",
"name": "fastify-metrics",
"version": "10.5.0",
"version": "10.6.0",
"description": "Prometheus metrics exporter for Fastify",
"keywords": [
"fastify-plugin",
Expand Down

0 comments on commit 87b403c

Please sign in to comment.