Types: `Terafoundation Prom Metrics`
terafoundation.PromMetrics
Table of contents
Properties
- addCounter
- addGauge
- addHistogram
- addSummary
- dec
- deleteMetric
- getDefaultLabels
- hasMetric
- inc
- init
- observe
- set
- shutdown
- verifyAPI
Properties
addCounter
• addCounter: (name
: string
, help
: string
, labelNames
: string
[], collectFn?
: CollectFunction
<Counter
<string
>>) => Promise
<void
>
Type declaration
▸ (name
, help
, labelNames
, collectFn?
): Promise
<void
>
Parameters
Name | Type |
---|---|
name | string |
help | string |
labelNames | string [] |
collectFn? | CollectFunction <Counter <string >> |
Returns
Promise
<void
>
Defined in
addGauge
• addGauge: (name
: string
, help
: string
, labelNames
: string
[], collectFn?
: CollectFunction
<Gauge
<string
>>) => Promise
<void
>
Type declaration
▸ (name
, help
, labelNames
, collectFn?
): Promise
<void
>
Parameters
Name | Type |
---|---|
name | string |
help | string |
labelNames | string [] |
collectFn? | CollectFunction <Gauge <string >> |
Returns
Promise
<void
>
Defined in
addHistogram
• addHistogram: (name
: string
, help
: string
, labelNames
: string
[], collectFn?
: CollectFunction
<Histogram
<string
>>, buckets?
: number
[]) => Promise
<void
>
Type declaration
▸ (name
, help
, labelNames
, collectFn?
, buckets?
): Promise
<void
>
Parameters
Name | Type |
---|---|
name | string |
help | string |
labelNames | string [] |
collectFn? | CollectFunction <Histogram <string >> |
buckets? | number [] |
Returns
Promise
<void
>
Defined in
addSummary
• addSummary: (name
: string
, help
: string
, labelNames
: string
[], collectFn?
: CollectFunction
<Summary
<string
>>, maxAgeSeconds?
: number
, ageBuckets?
: number
, percentiles?
: number
[]) => Promise
<void
>
Type declaration
▸ (name
, help
, labelNames
, collectFn?
, maxAgeSeconds?
, ageBuckets?
, percentiles?
): Promise
<void
>
Parameters
Name | Type |
---|---|
name | string |
help | string |
labelNames | string [] |
collectFn? | CollectFunction <Summary <string >> |
maxAgeSeconds? | number |
ageBuckets? | number |
percentiles? | number [] |
Returns
Promise
<void
>
Defined in
dec
• dec: (name
: string
, labelValues
: Record
<string
, string
>, value
: number
) => void
Type declaration
▸ (name
, labelValues
, value
): void
Parameters
Name | Type |
---|---|
name | string |
labelValues | Record <string , string > |
value | number |
Returns
void
Defined in
deleteMetric
• deleteMetric: (name
: string
) => Promise
<boolean
>
Type declaration
▸ (name
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
name | string |
Returns
Promise
<boolean
>
Defined in
getDefaultLabels
• getDefaultLabels: () => Record
<string
, string
>
Type declaration
▸ (): Record
<string
, string
>
Returns
Record
<string
, string
>
Defined in
hasMetric
• hasMetric: (name
: string
) => boolean
Type declaration
▸ (name
): boolean
Parameters
Name | Type |
---|---|
name | string |
Returns
boolean
Defined in
inc
• inc: (name
: string
, labelValues
: Record
<string
, string
>, value
: number
) => void
Type declaration
▸ (name
, labelValues
, value
): void
Parameters
Name | Type |
---|---|
name | string |
labelValues | Record <string , string > |
value | number |
Returns
void
Defined in
init
• init: (config
: PromMetricsInitConfig
) => Promise
<boolean
>
Type declaration
▸ (config
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
config | PromMetricsInitConfig |
Returns
Promise
<boolean
>
Defined in
observe
• observe: (name
: string
, labelValues
: Record
<string
, string
>, value
: number
) => void
Type declaration
▸ (name
, labelValues
, value
): void
Parameters
Name | Type |
---|---|
name | string |
labelValues | Record <string , string > |
value | number |
Returns
void
Defined in
set
• set: (name
: string
, labels
: Record
<string
, string
>, value
: number
) => void
Type declaration
▸ (name
, labels
, value
): void
Parameters
Name | Type |
---|---|
name | string |
labels | Record <string , string > |
value | number |
Returns
void
Defined in
shutdown
• shutdown: () => Promise
<void
>
Type declaration
▸ (): Promise
<void
>
Returns
Promise
<void
>
Defined in
verifyAPI
• verifyAPI: () => boolean
Type declaration
▸ (): boolean
Returns
boolean