1 import { Application, Request, Response } from 'express'
2 import { Meter, metrics } from '@opentelemetry/api-metrics'
3 import { PrometheusExporter } from '@opentelemetry/exporter-prometheus'
4 import { MeterProvider } from '@opentelemetry/sdk-metrics-base'
5 import { logger } from '@server/helpers/logger'
6 import { CONFIG } from '@server/initializers/config'
7 import { MVideoImmutable } from '@server/types/models'
8 import { PlaybackMetricCreate } from '@shared/models'
10 JobQueueObserversBuilder,
11 LivesObserversBuilder,
12 NodeJSObserversBuilder,
14 StatsObserversBuilder,
15 ViewersObserversBuilder
16 } from './metric-helpers'
18 class OpenTelemetryMetrics {
20 private static instance: OpenTelemetryMetrics
24 private onRequestDuration: (req: Request, res: Response) => void
26 private playbackMetrics: PlaybackMetrics
28 private constructor () {}
30 init (app: Application) {
31 if (CONFIG.OPEN_TELEMETRY.METRICS.ENABLED !== true) return
33 app.use((req, res, next) => {
34 res.once('finish', () => {
35 if (!this.onRequestDuration) return
37 this.onRequestDuration(req as Request, res as Response)
45 if (CONFIG.OPEN_TELEMETRY.METRICS.ENABLED !== true) return
47 logger.info('Registering Open Telemetry metrics')
49 const provider = new MeterProvider({
51 ...NodeJSObserversBuilder.getViews()
55 provider.addMetricReader(new PrometheusExporter({ port: CONFIG.OPEN_TELEMETRY.METRICS.PROMETHEUS_EXPORTER.PORT }))
57 metrics.setGlobalMeterProvider(provider)
59 this.meter = metrics.getMeter('default')
61 this.buildRequestObserver()
63 this.playbackMetrics = new PlaybackMetrics(this.meter)
64 this.playbackMetrics.buildCounters()
66 const nodeJSObserversBuilder = new NodeJSObserversBuilder(this.meter)
67 nodeJSObserversBuilder.buildObservers()
69 const jobQueueObserversBuilder = new JobQueueObserversBuilder(this.meter)
70 jobQueueObserversBuilder.buildObservers()
72 const statsObserversBuilder = new StatsObserversBuilder(this.meter)
73 statsObserversBuilder.buildObservers()
75 const livesObserversBuilder = new LivesObserversBuilder(this.meter)
76 livesObserversBuilder.buildObservers()
78 const viewersObserversBuilder = new ViewersObserversBuilder(this.meter)
79 viewersObserversBuilder.buildObservers()
82 observePlaybackMetric (video: MVideoImmutable, metrics: PlaybackMetricCreate) {
83 this.playbackMetrics.observe(video, metrics)
86 private buildRequestObserver () {
87 const requestDuration = this.meter.createHistogram('http_request_duration_ms', {
89 description: 'Duration of HTTP requests in ms'
92 this.onRequestDuration = (req: Request, res: Response) => {
93 const duration = Date.now() - res.locals.requestStart
95 requestDuration.record(duration, {
96 path: this.buildRequestPath(req.originalUrl),
98 statusCode: res.statusCode + ''
103 private buildRequestPath (path: string) {
104 return path.split('?')[0]
107 static get Instance () {
108 return this.instance || (this.instance = new this())