Skip to content

goldmansachs/pulse-telemapi-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Telemetry API Datasource Plugin

Pulse Telemetry API Plugin is a datasource plugin for Grafana, to query a custom timeseries-based database.

It is created and maintained by developers at Goldman Sachs to enable the visualization of timeseries metrics specially designed for custom telemetry APIs for firm's monitoring solution. The plugin uses Telemetry API to query timeseries data and PromQL Metadata API to query series's metadata.

Requirements

  • NodsJS and NPM

Build

npm install
npm test
npm run build

Telemetry API

  • Base pattern
http://<base url>/esmtelemetryapi/api/v2/timeseries/domain/<domain>
  • Parameters
Parameter Description Default
asset Specifies the asset Required
metric Specifies what metric you want to retrieve Required
startTime Specify the starting time now-1h
endTime Specify the end time now
tags Map of tags *
aggregator Aggregates results as specified in OpenTSDB documentation avg
downsampleInterval The interval used for down-sampling. Must be used with the downsampleagg parameter 1m
downsampleagg The aggregator used for down-sampling. Must be used with the downsampleInterval parameter avg

Integrate with Grafana

Install the plugin in Grafana and allow unsigned plugin.

Note

The simpleJson_logo.svg file is used as logo which is taken from Simple JSON datasource copyrighted under MIT License.