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

perf: significantly improve the memory usage of histogram #610

Open
wants to merge 6 commits 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
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"es6": true
},
"parserOptions": {
"ecmaVersion": 2019
"ecmaVersion": 2020
},
"rules": {
"no-underscore-dangle": "off",
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ project adheres to [Semantic Versioning](http://semver.org/).

### Changed

- Improve the memory usage of histograms by delaying allocation of bucket counters in `bucketValues` until their value is > 0
(Use a prototype of the initial counters)
- Improve the memory usage of histograms by allocating empty `enableExemplars` instead of pre-filling with `null`
- Minor performance improvements:
- Uvoid unneeded hash table updates
- Avoid hash table lookup for examplars
- Improve the memory usage of histograms when the `enableExemplars` option is disabled

### Added
Expand Down
56 changes: 24 additions & 32 deletions lib/histogram.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Histogram extends Metric {
this.type = 'histogram';
this.defaultLabels = {};
this.defaultExemplarLabelSet = {};
this.enableExemplars = false;
this.enableExemplars = config.enableExemplars;

for (const label of this.labelNames) {
if (label === 'le') {
Expand All @@ -38,27 +38,18 @@ class Histogram extends Metric {
return acc;
}, {});

if (config.enableExemplars) {
this.enableExemplars = true;
this.bucketExemplars = this.upperBounds.reduce((acc, upperBound) => {
acc[upperBound] = null;
return acc;
}, {});
Object.freeze(this.bucketExemplars);
this.observe = this.observeWithExemplar;
} else {
this.observe = this.observeWithoutExemplar;
}
this.observe = this.enableExemplars
? this.observeWithExemplar
: this.observeWithoutExemplar;

Object.freeze(this.bucketValues);
Object.freeze(this.upperBounds);

if (this.labelNames.length === 0) {
this.hashMap = {
[hashObject({})]: createBaseValues(
{},
this.bucketValues,
this.bucketExemplars,
this.enableExemplars,
),
};
}
Expand All @@ -79,14 +70,15 @@ class Histogram extends Metric {
value,
exemplarLabels = this.defaultExemplarLabelSet,
} = {}) {
observe.call(this, labels === 0 ? 0 : labels || {})(value);
this.updateExemplar(labels, value, exemplarLabels);
const valueFromMap = observe.call(
this,
labels === 0 ? 0 : labels || {},
)(value);
this.updateExemplar(valueFromMap, value, exemplarLabels);
}

updateExemplar(labels, value, exemplarLabels) {
const hash = hashObject(labels, this.sortedLabelNames);
updateExemplar({ bucketExemplars }, value, exemplarLabels) {
const bound = findBound(this.upperBounds, value);
const { bucketExemplars } = this.hashMap[hash];
let exemplar = bucketExemplars[bound];
if (!isObject(exemplar)) {
exemplar = new Exemplar();
Expand Down Expand Up @@ -137,7 +129,7 @@ class Histogram extends Metric {
this.hashMap[hash] = createBaseValues(
labels,
this.bucketValues,
this.bucketExemplars,
this.enableExemplars,
);
}

Expand Down Expand Up @@ -244,32 +236,33 @@ function observe(labels) {
valueFromMap = createBaseValues(
labelValuePair.labels,
this.bucketValues,
this.bucketExemplars,
this.enableExemplars,
);
this.hashMap[hash] = valueFromMap;
}

const b = findBound(this.upperBounds, labelValuePair.value);

valueFromMap.sum += labelValuePair.value;
valueFromMap.count += 1;

if (Object.prototype.hasOwnProperty.call(valueFromMap.bucketValues, b)) {
if (typeof valueFromMap.bucketValues[b] === 'number') {
valueFromMap.bucketValues[b] += 1;
}

this.hashMap[hash] = valueFromMap;
return valueFromMap;
};
}

function createBaseValues(labels, bucketValues, bucketExemplars) {
function createBaseValues(labels, bucketValues, enableExemplars) {
const result = {
labels,
bucketValues: { ...bucketValues },
bucketValues: Object.create(bucketValues),
sum: 0,
count: 0,
};
if (bucketExemplars) {
result.bucketExemplars = { ...bucketExemplars };
if (enableExemplars) {
result.bucketExemplars = {};
}
return result;
}
Expand All @@ -290,16 +283,15 @@ function extractBucketValuesForExport(histogram) {
const name = `${histogram.name}_bucket`;
return bucketData => {
let acc = 0;
const { labels, bucketValues, bucketExemplars } = bucketData;
const buckets = histogram.upperBounds.map(upperBound => {
acc += bucketData.bucketValues[upperBound];
acc += bucketValues[upperBound];
return setValuePair(
{ le: upperBound },
acc,
name,
bucketData.bucketExemplars
? bucketData.bucketExemplars[upperBound]
: null,
bucketData.labels,
bucketExemplars?.[upperBound] ?? null,
labels,
);
});
return { buckets, data: bucketData };
Expand Down
Loading