Skip to content
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.

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

Add summary function to init labels #642

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,20 @@ export class Summary<T extends string = string> {
*/
labels(labels: LabelValues<T>): Summary.Internal<T>;

/**
* Initializes to 0 for given label values
* @param values Label values
* @return Configured summary with given labels
*/
initLabels(...values: string[]): Summary.Internal<T>;

/**
* Initializes to 0 for given label values
* @param labels Object with label keys and values
* @return Configured counter with given labels
*/
initLabels(labels: LabelValues<T>): Summary.Internal<T>;

/**
* Remove metrics for the given label values
* @param values Label values
Expand Down
16 changes: 16 additions & 0 deletions lib/summary.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,22 @@ class Summary extends Metric {
return startTimer.call(this, labels)();
}

initLabels(...args) {
const labels = getLabels(this.labelNames, args);
validateLabel(this.labelNames, labels);
const hash = hashObject(labels, this.sortedLabelNames);
let summaryOfLabel = this.hashMap[hash];
if (!summaryOfLabel) {
summaryOfLabel = {
labels,
td: new timeWindowQuantiles(this.maxAgeSeconds, this.ageBuckets),
count: 0,
sum: 0,
};
this.hashMap[hash] = summaryOfLabel;
}
}

labels(...args) {
const labels = getLabels(this.labelNames, args);
validateLabel(this.labelNames, labels);
Expand Down
39 changes: 39 additions & 0 deletions test/summaryTest.js
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,45 @@ describe.each([
expect(value.labels.method).toBe('GET');
});
});

it.only('can init labels to 0', async () => {
instance.initLabels('GET', '/test');

const { values } = await instance.get();
expect(values).toHaveLength(3);
expect(values[0].labels.method).toEqual('GET');
expect(values[0].labels.endpoint).toEqual('/test');
expect(values[0].labels.quantile).toEqual(0.9);
expect(values[0].value).toEqual(0);

expect(values[1].metricName).toEqual('summary_test_sum');
expect(values[1].labels.method).toEqual('GET');
expect(values[1].labels.endpoint).toEqual('/test');
expect(values[1].value).toEqual(0);

expect(values[2].metricName).toEqual('summary_test_count');
expect(values[2].labels.method).toEqual('GET');
expect(values[2].labels.endpoint).toEqual('/test');
expect(values[2].value).toEqual(0);
});

it.only('can init labels passed as an object', async () => {
instance.initLabels({ method: 'GET' });

const { values } = await instance.get();
expect(values).toHaveLength(3);
expect(values[0].labels.method).toEqual('GET');
expect(values[0].labels.quantile).toEqual(0.9);
expect(values[0].value).toEqual(0);

expect(values[1].metricName).toEqual('summary_test_sum');
expect(values[1].labels.method).toEqual('GET');
expect(values[1].value).toEqual(0);

expect(values[2].metricName).toEqual('summary_test_count');
expect(values[2].labels.method).toEqual('GET');
expect(values[2].value).toEqual(0);
});
});

describe('remove', () => {
Expand Down