Skip to content

fix: Add missing properties to metrics types from abstract class Metric #647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kouak wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −4
Open

fix: Add missing properties to metrics types from abstract class Metric #647

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,38 @@ export type Metric<T extends string = NoLabelNameType> =
| Summary<T>
| Histogram<T>;

declare abstract class AbstractMetric {
/**
* The name of the metric.
*/
readonly name: string;

/**
* The help text of the metric.
*/
readonly help: string;

/**
* List of registers attached to the metric.
*/
readonly registers: readonly Registry[];

/**
* List of label names attached to the metric.
*/
readonly labelNames: readonly string[];

/**
* The aggregation method used for aggregating this metric in a Node.js cluster.
*/
readonly aggregator: Aggregator;

/**
* If provided, the collect function of the metric, which is invoked on each scrape.
*/
readonly collect?: CollectFunction<this>;
}

/**
* Aggregation methods, used for aggregating metrics in a Node.js cluster.
*/
Expand Down Expand Up @@ -255,7 +287,9 @@ export interface ObserveDataWithExemplar<T extends string> {
/**
* A counter is a cumulative metric that represents a single numerical value that only ever goes up
*/
export class Counter<T extends string = NoLabelNameType> {
export class Counter<
T extends string = NoLabelNameType,
> extends AbstractMetric {
/**
* @param configuration Configuration when creating a Counter metric. Name and Help is required.
*/
Expand Down Expand Up @@ -335,7 +369,7 @@ export interface GaugeConfiguration<T extends string>
/**
* A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
*/
export class Gauge<T extends string = NoLabelNameType> {
export class Gauge<T extends string = NoLabelNameType> extends AbstractMetric {
/**
* @param configuration Configuration when creating a Gauge metric. Name and Help is mandatory
*/
Expand Down Expand Up @@ -476,7 +510,9 @@ export interface HistogramConfiguration<T extends string>
/**
* A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets
*/
export class Histogram<T extends string = NoLabelNameType> {
export class Histogram<
T extends string = NoLabelNameType,
> extends AbstractMetric {
/**
* @param configuration Configuration when creating the Histogram. Name and Help is mandatory
*/
Expand Down Expand Up @@ -602,7 +638,9 @@ export interface SummaryConfiguration<T extends string>
/**
* A summary samples observations
*/
export class Summary<T extends string = NoLabelNameType> {
export class Summary<
T extends string = NoLabelNameType,
> extends AbstractMetric {
/**
* @param configuration Configuration when creating Summary metric. Name and Help is mandatory
*/
Expand Down