vulcain-corejs
Version:
Vulcain micro-service framework
71 lines (70 loc) • 1.65 kB
TypeScript
export declare class MetricsConstant {
static duration: string;
static total: string;
static failure: string;
static allRequestsFailure: string;
static allRequestsTotal: string;
static allRequestsDuration: string;
}
/**
* Metrics adapter interface
*
* @export
* @interface IMetrics
*/
export interface IMetrics {
/**
* Add custom tags
* Replace existing tags
*
* @param {...Array<string>} tags array of string like <tag-name>=<tag-value>
*
* @memberOf Metrics
*/
setTags(...tags: Array<string>): any;
/**
* Increment a gauge
*
* @param {string} metric metric name
* @param {number} [delta] default 1
*
* @memberOf IMetrics
*/
increment(metric: string, delta?: number): any;
/**
* Decrement a gauge
*
* @param {string} metric metric name
* @param {number} [delta] default -1
* *
* @memberOf IMetrics
*/
decrement(metric: string, delta?: number): any;
/**
* Add value to a counter
*
* @param {string} metric metric name
* @param {number} [delta] value to add
*
* @memberOf IMetrics
*/
counter(metric: string, delta: number): any;
/**
*
*
* @param {string} metric metric name
* @param {number} [delta] value to add
*
* @memberOf IMetrics
*/
gauge(metric: string, value: number): any;
/**
* Set a duration
*
* @param {string} metric metric name
* @param {number} [delta] duration in ms
*
* @memberOf IMetrics
*/
timing(metric: string, duration: number): any;
}