rsshub/lib/utils/otel/metric.ts

Make RSS Great Again!

import { resourceFromAttributes } from '@opentelemetry/resources';
import { PrometheusExporter, PrometheusSerializer } from '@opentelemetry/exporter-prometheus';
import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
import { MeterProvider } from '@opentelemetry/sdk-metrics';
import type { Attributes } from '@opentelemetry/api';
import { config } from '@/config';

interface IMetricAttributes extends Attributes {
    method: string;
    path: string;
    status: number;
}

interface IHistogramAttributes extends IMetricAttributes {
    unit: string;
}

const METRIC_PREFIX = 'rsshub';

const exporter = new PrometheusExporter({});

const provider = new MeterProvider({
    resource: resourceFromAttributes({
        [ATTR_SERVICE_NAME]: 'rsshub',
    }),
    readers: [exporter],
});

const serializer = new PrometheusSerializer();

const meter = provider.getMeter('rsshub');

const requestTotal = meter.createCounter<IMetricAttributes>(`${METRIC_PREFIX}_request_total`);
const requestErrorTotal = meter.createCounter<IMetricAttributes>(`${METRIC_PREFIX}_request_error_total`);
const requestDurationSecondsBucket = meter.createHistogram<IHistogramAttributes>(`${METRIC_PREFIX}_request_duration_seconds_bucket`, {
    advice: {
        explicitBucketBoundaries: config.otel.seconds_bucket?.split(',').map(Number),
    },
});
const request_duration_milliseconds_bucket = meter.createHistogram<IHistogramAttributes>(`${METRIC_PREFIX}_request_duration_milliseconds_bucket`, {
    advice: {
        explicitBucketBoundaries: config.otel.milliseconds_bucket?.split(',').map(Number),
    },
});

export const requestMetric = {
    success: (value: number, attributes: IMetricAttributes) => {
        requestTotal.add(1, attributes);
        request_duration_milliseconds_bucket.record(value, { unit: 'millisecond', ...attributes });
        requestDurationSecondsBucket.record(value / 1000, { unit: 'second', ...attributes });
    },
    error: (attributes: IMetricAttributes) => {
        requestErrorTotal.add(1, attributes);
    },
};

export const getContext = () =>
    new Promise<string>((resolve, reject) => {
        exporter
            .collect()
            .then((value) => {
                resolve(serializer.serialize(value.resourceMetrics));
            })
            .finally(() => {
                reject('');
            });
    });