@opentelemetry/instrumentation-runtime-node/build/src/metrics/gcCollector.js

OpenTelemetry instrumentation for Node.js Performance measurement API

"use strict";
/*
 * Copyright The OpenTelemetry Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.GCCollector = void 0;
const perf_hooks = require("node:perf_hooks");
const api_1 = require("@opentelemetry/api");
const baseCollector_1 = require("./baseCollector");
const semconv_1 = require("../semconv");
const DEFAULT_GC_DURATION_BUCKETS = [0.01, 0.1, 1, 10];
const kinds = [];
kinds[perf_hooks.constants.NODE_PERFORMANCE_GC_MAJOR] = 'major';
kinds[perf_hooks.constants.NODE_PERFORMANCE_GC_MINOR] = 'minor';
kinds[perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL] = 'incremental';
kinds[perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB] = 'weakcb';
class GCCollector extends baseCollector_1.BaseCollector {
    _gcDurationByKindHistogram;
    _observer;
    constructor(config = {}) {
        super(config);
        this._observer = new perf_hooks.PerformanceObserver(list => {
            if (!this._config.enabled)
                return;
            const entry = list.getEntries()[0];
            // Node < 16 uses entry.kind
            // Node >= 16 uses entry.detail.kind
            // See: https://nodejs.org/docs/latest-v16.x/api/deprecations.html#deprecations_dep0152_extension_performanceentry_properties
            // eslint-disable-next-line  @typescript-eslint/ban-ts-comment
            // @ts-ignore
            const kind = entry.detail ? kinds[entry.detail.kind] : kinds[entry.kind];
            this._gcDurationByKindHistogram?.record(entry.duration / 1000, {
                [semconv_1.ATTR_V8JS_GC_TYPE]: kind,
            });
        });
    }
    updateMetricInstruments(meter) {
        this._gcDurationByKindHistogram = meter.createHistogram(semconv_1.METRIC_V8JS_GC_DURATION, {
            description: 'Garbage collection duration by kind, one of major, minor, incremental or weakcb.',
            unit: 's',
            valueType: api_1.ValueType.DOUBLE,
            advice: {
                explicitBucketBoundaries: DEFAULT_GC_DURATION_BUCKETS,
            },
        });
    }
    internalEnable() {
        this._observer.observe({ entryTypes: ['gc'] });
    }
    internalDisable() {
        this._observer.disconnect();
    }
}
exports.GCCollector = GCCollector;
//# sourceMappingURL=gcCollector.js.map