1 import { Application, Request, Response } from 'express'
2 import { Meter, metrics } from '@opentelemetry/api'
3 import { PrometheusExporter } from '@opentelemetry/exporter-prometheus'
4 import { MeterProvider } from '@opentelemetry/sdk-metrics'
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 BittorrentTrackerObserversBuilder,
11 JobQueueObserversBuilder,
12 LivesObserversBuilder,
13 NodeJSObserversBuilder,
15 StatsObserversBuilder,
16 ViewersObserversBuilder
17 } from './metric-helpers'
19 class OpenTelemetryMetrics {
21 private static instance: OpenTelemetryMetrics
25 private onRequestDuration: (req: Request, res: Response) => void
27 private playbackMetrics: PlaybackMetrics
29 private constructor () {}
31 init (app: Application) {
32 if (CONFIG.OPEN_TELEMETRY.METRICS.ENABLED !== true) return
34 app.use((req, res, next) => {
35 res.once('finish', () => {
36 if (!this.onRequestDuration) return
38 this.onRequestDuration(req as Request, res as Response)
45 registerMetrics (options: { trackerServer: any }) {
46 if (CONFIG.OPEN_TELEMETRY.METRICS.ENABLED !== true) return
48 logger.info('Registering Open Telemetry metrics')
50 const provider = new MeterProvider({
52 ...NodeJSObserversBuilder.getViews()
56 provider.addMetricReader(new PrometheusExporter({
57 host: CONFIG.OPEN_TELEMETRY.METRICS.PROMETHEUS_EXPORTER.HOSTNAME,
58 port: CONFIG.OPEN_TELEMETRY.METRICS.PROMETHEUS_EXPORTER.PORT
61 metrics.setGlobalMeterProvider(provider)
63 this.meter = metrics.getMeter('default')
65 if (CONFIG.OPEN_TELEMETRY.METRICS.HTTP_REQUEST_DURATION.ENABLED === true) {
66 this.buildRequestObserver()
69 this.playbackMetrics = new PlaybackMetrics(this.meter)
70 this.playbackMetrics.buildCounters()
72 const nodeJSObserversBuilder = new NodeJSObserversBuilder(this.meter)
73 nodeJSObserversBuilder.buildObservers()
75 const jobQueueObserversBuilder = new JobQueueObserversBuilder(this.meter)
76 jobQueueObserversBuilder.buildObservers()
78 const statsObserversBuilder = new StatsObserversBuilder(this.meter)
79 statsObserversBuilder.buildObservers()
81 const livesObserversBuilder = new LivesObserversBuilder(this.meter)
82 livesObserversBuilder.buildObservers()
84 const viewersObserversBuilder = new ViewersObserversBuilder(this.meter)
85 viewersObserversBuilder.buildObservers()
87 const bittorrentTrackerObserversBuilder = new BittorrentTrackerObserversBuilder(this.meter, options.trackerServer)
88 bittorrentTrackerObserversBuilder.buildObservers()
91 observePlaybackMetric (video: MVideoImmutable, metrics: PlaybackMetricCreate) {
92 this.playbackMetrics.observe(video, metrics)
95 private buildRequestObserver () {
96 const requestDuration = this.meter.createHistogram('http_request_duration_ms', {
98 description: 'Duration of HTTP requests in ms'
101 this.onRequestDuration = (req: Request, res: Response) => {
102 const duration = Date.now() - res.locals.requestStart
104 requestDuration.record(duration, {
105 path: this.buildRequestPath(req.originalUrl),
107 statusCode: res.statusCode + ''
112 private buildRequestPath (path: string) {
113 return path.split('?')[0]
116 static get Instance () {
117 return this.instance || (this.instance = new this())