Skip to content

Commit

Permalink
chore(release): 6.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
SkeLLLa committed Jul 11, 2020
1 parent 2cbd68f commit fbbf047
Show file tree
Hide file tree
Showing 11 changed files with 26 additions and 24 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [6.0.0](https://github.com/SkeLLLa/fastify-metrics/compare/v6.0.0-rc.4...v6.0.0) (2020-07-11)

## [6.0.0-rc.4](https://github.com/SkeLLLa/fastify-metrics/compare/v6.0.0-rc.3...v6.0.0-rc.4) (2020-06-06)


Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,25 @@

**app**: *[FastifyInstance](interfaces/_fastify_.fastifyinstance.md)‹Server‹›, IncomingMessage‹›, ServerResponse‹›, FastifyLoggerOptions‹Server‹›, IncomingMessage‹›, ServerResponse‹›››* = fastify()

*Defined in [__tests__/metrics.spec.ts:4](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/__tests__/metrics.spec.ts#L4)*
*Defined in [__tests__/metrics.spec.ts:4](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/__tests__/metrics.spec.ts#L4)*

___

### fastifyPlugin

**fastifyPlugin**: *FastifyPlugin‹[PluginOptions](interfaces/pluginoptions.md)*

*Defined in [__tests__/exports.spec.ts:1](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/__tests__/exports.spec.ts#L1)*
*Defined in [__tests__/exports.spec.ts:1](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/__tests__/exports.spec.ts#L1)*

*Defined in [__tests__/metrics.spec.ts:1](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/__tests__/metrics.spec.ts#L1)*
*Defined in [__tests__/metrics.spec.ts:1](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/__tests__/metrics.spec.ts#L1)*

## Functions

### `Const` fastifyMetricsPlugin

**fastifyMetricsPlugin**(`fastify`: [FastifyInstance](interfaces/_fastify_.fastifyinstance.md), `__namedParameters`: object): *Promise‹void›*

*Defined in [index.ts:44](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/index.ts#L44)*

Fastify metrics plugin

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/_fastify_.fastifyinstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@

**metrics**: *[FastifyMetrics](fastifymetrics.md)*

*Defined in [index.ts:16](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/index.ts#L16)*
*Defined in [index.ts:16](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/index.ts#L16)*

Metrics interface
2 changes: 1 addition & 1 deletion docs/interfaces/_fastify_.fastifyrequestinterface.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

**metrics**? : *undefined | object*

*Defined in [index.ts:25](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/index.ts#L25)*
*Defined in [index.ts:25](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/index.ts#L25)*
2 changes: 1 addition & 1 deletion docs/interfaces/_fastify_.fastifyschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@

**hide**? : *undefined | false | true*

*Defined in [index.ts:22](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/index.ts#L22)*
*Defined in [index.ts:22](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/index.ts#L22)*

Hides metric route from swagger/openapi documentation
4 changes: 2 additions & 2 deletions docs/interfaces/fastifymetrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Additional objects to store your metrics, registries, etc.

**client**: *typeof promClient*

*Defined in [plugin.ts:27](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L27)*
*Defined in [plugin.ts:27](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L27)*

Prom-client

Expand All @@ -38,7 +38,7 @@ Prom-client

**clearRegister**(): *void*

*Defined in [plugin.ts:31](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L31)*
*Defined in [plugin.ts:31](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L31)*

Expose register clear function if register was provided

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/metricconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

**histogram**: *HistogramConfiguration‹string›*

*Defined in [plugin.ts:16](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L16)*
*Defined in [plugin.ts:16](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L16)*

Histogram config

Expand All @@ -29,6 +29,6 @@ ___

**summary**: *SummaryConfiguration‹string›*

*Defined in [plugin.ts:20](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L20)*
*Defined in [plugin.ts:20](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L20)*

Summary config
4 changes: 2 additions & 2 deletions docs/interfaces/metricscontextconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@

**statsId**? : *undefined | string*

*Defined in [plugin.ts:9](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L9)*
*Defined in [plugin.ts:9](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L9)*

___

### `Optional` url

**url**? : *undefined | string*

*Defined in [plugin.ts:8](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L8)*
*Defined in [plugin.ts:8](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L8)*
18 changes: 9 additions & 9 deletions docs/interfaces/pluginoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

**blacklist**? : *RegExp | Array‹string› | string*

*Defined in [plugin.ts:62](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L62)*
*Defined in [plugin.ts:62](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L62)*

Routes blacklist that will be excluded from metrics collection

Expand All @@ -36,7 +36,7 @@ ___

**enableDefaultMetrics**? : *undefined | false | true*

*Defined in [plugin.ts:43](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L43)*
*Defined in [plugin.ts:43](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L43)*

Enable default prom-client metrics

Expand All @@ -48,7 +48,7 @@ ___

**enableRouteMetrics**? : *undefined | false | true*

*Defined in [plugin.ts:48](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L48)*
*Defined in [plugin.ts:48](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L48)*

Enable fastify route metrics

Expand All @@ -60,7 +60,7 @@ ___

**endpoint**? : *undefined | string*

*Defined in [plugin.ts:74](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L74)*
*Defined in [plugin.ts:74](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L74)*

Metrics endpoint for Prometheus

Expand All @@ -70,7 +70,7 @@ ___

**groupStatusCodes**? : *undefined | false | true*

*Defined in [plugin.ts:53](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L53)*
*Defined in [plugin.ts:53](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L53)*

Groups status code labels by first digit 200 -> 2XX

Expand All @@ -82,7 +82,7 @@ ___

**metrics**? : *Partial‹[MetricConfig](metricconfig.md)*

*Defined in [plugin.ts:78](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L78)*
*Defined in [plugin.ts:78](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L78)*

HTTP metrics overrides

Expand All @@ -92,7 +92,7 @@ ___

**pluginName**? : *undefined | string*

*Defined in [plugin.ts:58](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L58)*
*Defined in [plugin.ts:58](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L58)*

Plugin name that will be registered in fastify

Expand All @@ -104,7 +104,7 @@ ___

**prefix**? : *undefined | string*

*Defined in [plugin.ts:70](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L70)*
*Defined in [plugin.ts:70](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L70)*

Metrics prefix

Expand All @@ -114,6 +114,6 @@ ___

**register**? : *promClient.Registry*

*Defined in [plugin.ts:66](https://github.com/SkeLLLa/fastify-metrics/blob/6f6803a/src/plugin.ts#L66)*
*Defined in [plugin.ts:66](https://github.com/SkeLLLa/fastify-metrics/blob/2cbd68f/src/plugin.ts#L66)*

Prom client registry for default metrics and route metrics
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fastify-metrics",
"version": "6.0.0-rc.4",
"version": "6.0.0",
"description": "Prometheus metrics exporter for Fastify",
"keywords": [
"fastify-plugin",
Expand Down

0 comments on commit fbbf047

Please sign in to comment.