Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricsOptions

Vert.x metrics base configuration, this class can be extended by provider implementations to configure those specific implementations.

Hierarchy

  • MetricsOptions

Index

Constructors

Methods

Constructors

constructor

  • Returns MetricsOptions

  • Parameters

    Returns MetricsOptions

Methods

getFactory

  • getFactory(): any

  • Programmatically set the metrics factory to be used when metrics are enabled.

    Only valid if MetricsOptions = true.

    Normally Vert.x will look on the classpath for a metrics factory implementation, but if you want to set one programmatically you can use this method.

    Returns any

isEnabled

  • isEnabled(): boolean

  • Set whether metrics will be enabled on the Vert.x instance.

    Returns boolean

setEnabled

  • Set whether metrics will be enabled on the Vert.x instance.

    Parameters

    • enabled: boolean

    Returns MetricsOptions

setFactory

  • Programmatically set the metrics factory to be used when metrics are enabled.

    Only valid if MetricsOptions = true.

    Normally Vert.x will look on the classpath for a metrics factory implementation, but if you want to set one programmatically you can use this method.

    Parameters

    • factory: any

    Returns MetricsOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc