summaryrefslogtreecommitdiff
path: root/src/mongo/db/commands/server_status_metric.h
blob: 01c695ff046903bdae84d48d8d1c63dd05ea124e (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
/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include <string>

#include "mongo/db/jsobj.h"

namespace mongo {

class ServerStatusMetric {
public:
    /**
     * @param name is a dotted path of a counter name
     *             if name starts with . its treated as a path from the serverStatus root
     *             otherwise it will live under the "counters" namespace
     *             so foo.bar would be serverStatus().counters.foo.bar
     */
    ServerStatusMetric(const std::string& name);
    virtual ~ServerStatusMetric() {}

    std::string getMetricName() const {
        return _name;
    }

    virtual void appendAtLeaf(BSONObjBuilder& b) const = 0;

protected:
    static std::string _parseLeafName(const std::string& name);

    const std::string _name;
    const std::string _leafName;
};

/**
 * usage
 *
 * declared once
 *    Counter counter;
 *    ServerStatusMetricField myAwesomeCounterDisplay( "path.to.counter", &counter );
 *
 * call
 *    counter.hit();
 *
 * will show up in db.serverStatus().metrics.path.to.counter
 */
template <typename T>
class ServerStatusMetricField : public ServerStatusMetric {
public:
    ServerStatusMetricField(const std::string& name, const T* t)
        : ServerStatusMetric(name), _t(t) {}

    const T* get() {
        return _t;
    }

    virtual void appendAtLeaf(BSONObjBuilder& b) const {
        b.append(_leafName, *_t);
    }

private:
    const T* _t;
};
}