Skip to main content

PrometheusParameters

@webda/core • Readme | API


Class: PrometheusParameters

Interface to specify the Service parameters

Extends​

Constructors​

new PrometheusParameters(params)​

new PrometheusParameters(params): PrometheusParameters

Parameters​

• params: any

Returns​

PrometheusParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/prometheus.ts:51

Properties​

bind?​

bind?: string

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

Source​

packages/core/src/services/prometheus.ts:19


includeNodeMetrics​

includeNodeMetrics: boolean

Include NodeJS engine metrics

Default​

true

Source​

packages/core/src/services/prometheus.ts:29


includeRequestMetrics​

includeRequestMetrics: boolean

Include request served by Webda

It should generate common http_* metrics

Default​

true

Source​

packages/core/src/services/prometheus.ts:36


labels?​

labels?: Object

Labels to add

Index signature​

[key: string]: string

Source​

packages/core/src/services/prometheus.ts:44


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260


partitionHistogram?​

partitionHistogram?: boolean

Do not partition histogram with requests labels

Source​

packages/core/src/services/prometheus.ts:40


portNumber?​

portNumber?: number

If defined will launch another http server to serve the scaper

Source​

packages/core/src/services/prometheus.ts:14


prefix?​

prefix?: string

Prefix to add to metrics

Source​

packages/core/src/services/prometheus.ts:49


type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251


url?​

url?: string

Default​

/metrics

Overrides​

ServiceParameters.url

Source​

packages/core/src/services/prometheus.ts:23