Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VertxPrometheusOptions

Options for Prometheus metrics backend.

Hierarchy

  • VertxPrometheusOptions

Index

Constructors

constructor

Methods

getEmbeddedServerEndpoint

  • getEmbeddedServerEndpoint(): string
  • Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.

    Returns string

getEmbeddedServerOptions

  • getEmbeddedServerOptions(): HttpServerOptions
  • HTTP server options for the embedded server

    Returns HttpServerOptions

isEnabled

  • isEnabled(): boolean
  • Set true to enable Prometheus reporting

    Returns boolean

isPublishQuantiles

  • isPublishQuantiles(): boolean
  • Set true to publish histogram stats, necessary to compute quantiles. Note that it generates many new timeseries for stats, which is why it is deactivated by default.

    Returns boolean

isStartEmbeddedServer

  • isStartEmbeddedServer(): boolean
  • When true, an embedded server will init to expose metrics with Prometheus format.

    Returns boolean

setEmbeddedServerEndpoint

  • Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.

    Parameters

    • embeddedServerEndpoint: string

    Returns VertxPrometheusOptions

setEmbeddedServerOptions

  • HTTP server options for the embedded server

    Parameters

    • embeddedServerOptions: HttpServerOptions

    Returns VertxPrometheusOptions

setEnabled

  • Set true to enable Prometheus reporting

    Parameters

    • enabled: boolean

    Returns VertxPrometheusOptions

setPublishQuantiles

  • Set true to publish histogram stats, necessary to compute quantiles. Note that it generates many new timeseries for stats, which is why it is deactivated by default.

    Parameters

    • publishQuantiles: boolean

    Returns VertxPrometheusOptions

setStartEmbeddedServer

  • When true, an embedded server will init to expose metrics with Prometheus format.

    Parameters

    • startEmbeddedServer: boolean

    Returns VertxPrometheusOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc