aboutsummaryrefslogtreecommitdiff
path: root/lib/metrics-server.ts
blob: 2e12a7e3cb183a494a5471097ccf0d2648952b39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
// Copyright (c) 2022, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import express from 'express';
import PromClient from 'prom-client';

/**
 * Will launch the Prometheus metrics server
 *
 * @param serverPort - The listening port to bind into this metrics server.
 * @param hostname - The TCP host to attach the listener.
 * @returns void
 */
export function setupMetricsServer(serverPort: number, hostname: string | undefined): void {
    PromClient.collectDefaultMetrics();
    const metricsServer = express();

    metricsServer.get('/metrics', (req, res) => {
        PromClient.register
            .metrics()
            .then(metrics => {
                res.header('Content-Type', PromClient.register.contentType).send(metrics);
            })
            .catch(err => res.status(500).send(err));
    });

    // silly express typing, passing undefined is fine but
    if (hostname) {
        metricsServer.listen(serverPort, hostname);
    } else {
        metricsServer.listen(serverPort);
    }
}