server/tests/api/server/open-telemetry.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import { expect } from 'chai'
   4 import { expectLogContain, expectLogDoesNotContain, MockHTTP } from '@server/tests/shared'
   5 import { HttpStatusCode, VideoPrivacy, VideoResolution } from '@shared/models'
   6 import { cleanupTests, createSingleServer, makeRawRequest, PeerTubeServer, setAccessTokensToServers } from '@shared/server-commands'
   7
   8 describe('Open Telemetry', function () {
   9   let server: PeerTubeServer
  10
  11   describe('Metrics', function () {
  12     const metricsUrl = 'http://127.0.0.1:9092/metrics'
  13
  14     it('Should not enable open telemetry metrics', async function () {
  15       this.timeout(60000)
  16
  17       server = await createSingleServer(1)
  18
  19       let hasError = false
  20       try {
  21         await makeRawRequest({ url: metricsUrl, expectedStatus: HttpStatusCode.NOT_FOUND_404 })
  22       } catch (err) {
  23         hasError = err.message.includes('ECONNREFUSED')
  24       }
  25
  26       expect(hasError).to.be.true
  27
  28       await server.kill()
  29     })
  30
  31     it('Should enable open telemetry metrics', async function () {
  32       server = await createSingleServer(1, {
  33         open_telemetry: {
  34           metrics: {
  35             enabled: true
  36           }
  37         }
  38       })
  39
  40       const res = await makeRawRequest({ url: metricsUrl, expectedStatus: HttpStatusCode.OK_200 })
  41       expect(res.text).to.contain('peertube_job_queue_total{')
  42     })
  43
  44     it('Should have playback metrics', async function () {
  45       await setAccessTokensToServers([ server ])
  46
  47       const video = await server.videos.quickUpload({ name: 'video' })
  48
  49       await server.metrics.addPlaybackMetric({
  50         metrics: {
  51           playerMode: 'p2p-media-loader',
  52           resolution: VideoResolution.H_1080P,
  53           fps: 30,
  54           resolutionChanges: 1,
  55           errors: 2,
  56           downloadedBytesP2P: 0,
  57           downloadedBytesHTTP: 0,
  58           uploadedBytesP2P: 5,
  59           videoId: video.uuid
  60         }
  61       })
  62
  63       const res = await makeRawRequest({ url: metricsUrl, expectedStatus: HttpStatusCode.OK_200 })
  64       expect(res.text).to.contain('peertube_playback_http_downloaded_bytes_total{')
  65     })
  66
  67     after(async function () {
  68       await server.kill()
  69     })
  70   })
  71
  72   describe('Tracing', function () {
  73     let mockHTTP: MockHTTP
  74     let mockPort: number
  75
  76     before(async function () {
  77       mockHTTP = new MockHTTP()
  78       mockPort = await mockHTTP.initialize()
  79     })
  80
  81     it('Should enable open telemetry tracing', async function () {
  82       server = await createSingleServer(1)
  83
  84       await expectLogDoesNotContain(server, 'Registering Open Telemetry tracing')
  85
  86       await server.kill()
  87     })
  88
  89     it('Should enable open telemetry metrics', async function () {
  90       server = await createSingleServer(1, {
  91         open_telemetry: {
  92           tracing: {
  93             enabled: true,
  94             jaeger_exporter: {
  95               endpoint: 'http://127.0.0.1:' + mockPort
  96             }
  97           }
  98         }
  99       })
 100
 101       await expectLogContain(server, 'Registering Open Telemetry tracing')
 102     })
 103
 104     it('Should upload a video and correctly works', async function () {
 105       await setAccessTokensToServers([ server ])
 106
 107       const { uuid } = await server.videos.quickUpload({ name: 'video', privacy: VideoPrivacy.PUBLIC })
 108
 109       const video = await server.videos.get({ id: uuid })
 110
 111       expect(video.name).to.equal('video')
 112     })
 113
 114     after(async function () {
 115       await mockHTTP.terminate()
 116     })
 117   })
 118
 119   after(async function () {
 120     await cleanupTests([ server ])
 121   })
 122 })