Class MetricsService

AeroGear Metrics SDK Provides internal api for metrics that are sent to metrics server.

Hierarchy

MetricsService

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MetricsService(options: object): MetricsService

- Defined in metrics/MetricsService.ts:24
Parameters
- options: object
  - Optional builder?: MetricsBuilder
  - configuration: any
  - Optional publisher?: MetricsPublisher
Returns MetricsService

Properties

Protected builder

builder: MetricsBuilder

Protected Optional configuration

configuration: ServiceConfiguration

Protected Optional publisher

publisher: MetricsPublisher

Static CLIENT_ID_KEY

CLIENT_ID_KEY: "aerogear_metrics_client_key" = "aerogear_metrics_client_key"

Static DEFAULT_METRICS_TYPE

DEFAULT_METRICS_TYPE: "init" = "init"

Static TYPE

TYPE: "metrics" = "metrics"

Accessors

metricsBuilder

get metricsBuilder(): MetricsBuilder
set metricsBuilder(builder: MetricsBuilder): void

- Defined in metrics/MetricsService.ts:60
Returns MetricsBuilder
- Defined in metrics/MetricsService.ts:64
Parameters
- builder: MetricsBuilder
Returns void

metricsPublisher

get metricsPublisher(): MetricsPublisher | undefined
set metricsPublisher(publisher: MetricsPublisher | undefined): void

- Defined in metrics/MetricsService.ts:56
Returns MetricsPublisher | undefined
- Defined in metrics/MetricsService.ts:52
Parameters
- publisher: MetricsPublisher | undefined
Returns void

Methods

publish

publish(type: string, metrics: Metrics[]): Promise<any>

- Defined in metrics/MetricsService.ts:74
Publish metrics using predefined publisher

Parameters
- type: string
  
  type of the metrics to be published
- metrics: Metrics[]
  
  metrics instances that should be published
Returns Promise<any>

sendAppAndDeviceMetrics

sendAppAndDeviceMetrics(): Promise<any>

- Defined in metrics/MetricsService.ts:104
Collect metrics for all active metrics collectors Send data using metrics publisher

Returns Promise<any>

Generated using TypeDoc