Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
blob: 7330ea9bfd3dc0c49d42b1a0514b3c5bcf67a802 (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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/**
 * Prometheus Factory functions
 *
 *  Copyright (C) 2010-2019 R-T Specialty, LLC.
 *
 *  This file is part of liza.
 *
 *  liza is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Prometheus Metrics
 */
import { Pushgateway, Histogram, Counter, Gauge } from 'prom-client';


export declare type PrometheusConfig = {
    /** The hostname to connect to */
    hostname: string;

    /** The port to connect to */
    port: number;

    /** The environment ( dev, test, demo, live ) */
    env: string;

    /** The rate (in milliseconds) at which metrics are pushed */
    push_interval_ms: number;

    /** The starting point for process time buckets */
    buckets_start: number;

    /** The width of process time buckets */
    buckets_width: number;

    /** The number of process time buckets */
    buckets_count: number;
}


/**
 * Create a prometheus configuration from the environment
 *
 * @param env - the environment variables
 *
 * @return the prometheus configuration
 */
export function createPrometheusConfig(
    env: NodeJS.ProcessEnv
): PrometheusConfig
{
    return <PrometheusConfig>{
        hostname:         env.PROM_HOST,
        port:             +( env.PROM_PORT || 0 ),
        env:              process.env.NODE_ENV,
        push_interval_ms: +( process.env.PROM_PUSH_INTERVAL_MS || 5000 ),
        buckets_start:    +( process.env.PROM_BUCKETS_START || 0 ),
        buckets_width:    +( process.env.PROM_BUCKETS_WIDTH || 10 ),
        buckets_count:    +( process.env.PROM_BUCKETS_COUNT || 10 ),
    };
}


export class PrometheusFactory
{
    /**
     * Create a PushGateway
     *
     * @param client   - prometheus client
     * @param hostname - push gateway url
     * @param port     - push gateway port
     *
     * @return the gateway
     */
    createGateway(
        client:   any,
        hostname: string,
        port:     number,
    ): Pushgateway
    {
        const url = 'http://' + hostname + ':' + port;

        return new client.Pushgateway( url );
    }


    /**
     * Create a histogram metric
     *
     * @param client       - prometheus client
     * @param name         - metric name
     * @param help         - a description of the metric
     * @param bucket_start - where to start the range of buckets
     * @param bucket_width - the size of each bucket
     * @param bucket_count - the total number of buckets
     *
     * @return the metric
     */
    createHistogram(
        client:       any,
        name:         string,
        help:         string,
        bucket_start: number,
        bucket_width: number,
        bucket_count: number,
    ): Histogram
    {
        return new client.Histogram( {
            name:    name,
            help:    help,
            buckets: client.linearBuckets(
                bucket_start,
                bucket_width,
                bucket_count
            ),
        } );
    }


    /**
     * Create a counter metric
     *
     * @param client       - prometheus client
     * @param name         - metric name
     * @param help         - a description of the metric
     *
     * @return the metric
     */
    createCounter(
        client: any,
        name:   string,
        help:   string,
    ): Counter
    {
        return new client.Counter( {
            name:    name,
            help:    help,
        } );
    }


    /**
     * Create a gauge metric
     *
     * @param client       - prometheus client
     * @param name         - metric name
     * @param help         - a description of the metric
     *
     * @return the metric
     */
    createGauge(
        client: any,
        name:   string,
        help:   string,
    ): Gauge
    {
        return new client.Gauge( {
            name:    name,
            help:    help,
        } );
    }
}