Skip to main content

PrometheusParameters

@webda/core

Class: PrometheusParameters

Defined in: packages/core/src/services/prometheus.service.ts:13

Parameters for the Prometheus metrics endpoint service

Extends​

Constructors​

Constructor​

new PrometheusParameters(): PrometheusParameters

Returns​

PrometheusParameters

Inherited from​

ServiceParameters.constructor

Properties​

bind?​

optional bind?: string

Defined in: packages/core/src/services/prometheus.service.ts:22

If defined along with portNumber used to bind specific address for dedicated http server

includeNodeMetrics​

includeNodeMetrics: boolean

Defined in: packages/core/src/services/prometheus.service.ts:32

Include NodeJS engine metrics

Default​

true

includeRequestMetrics​

includeRequestMetrics: boolean

Defined in: packages/core/src/services/prometheus.service.ts:39

Include request served by Webda

It should generate common http_* metrics

Default​

true

labels?​

optional labels?: object

Defined in: packages/core/src/services/prometheus.service.ts:47

Labels to add

Index Signature​

[key: string]: string

partitionHistogram?​

optional partitionHistogram?: boolean

Defined in: packages/core/src/services/prometheus.service.ts:43

Do not partition histogram with requests labels

portNumber?​

optional portNumber?: number

Defined in: packages/core/src/services/prometheus.service.ts:17

If defined will launch another http server to serve the scaper

prefix?​

optional prefix?: string

Defined in: packages/core/src/services/prometheus.service.ts:52

Prefix to add to metrics

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

ServiceParameters.type

url?​

optional url?: string

Defined in: packages/core/src/services/prometheus.service.ts:26

Default​

/metrics

Methods​

load()​

load(params?): this

Defined in: packages/core/src/services/prometheus.service.ts:59

Load parameters with defaults for metrics URL, labels, and feature flags

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this for chaining

Overrides​

ServiceParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/services/serviceparameters.ts:35

Update parameters and call watchers if a parameter was changed

Parameters​

params?​

any = {}

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/src/services/serviceparameters.ts:65

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with