summaryrefslogtreecommitdiff
path: root/src/mongo/db/stats/api_version_metrics.h
blob: 6d2b7eb6ce409d8bf97228ffab71616a9a0d7344 (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
/**
 *    Copyright (C) 2020-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 "mongo/db/api_parameters.h"
#include "mongo/db/service_context.h"
#include "mongo/platform/mutex.h"
#include "mongo/rpc/metadata/client_metadata.h"
#include "mongo/util/time_support.h"

#include <ctime>

namespace mongo {

/**
 * A service context decoration that stores metrics related to the API version used by applications.
 */
class APIVersionMetrics {
public:
    // To ensure that the BSONObject doesn't exceed the size limit, the 'appName' field has a limit
    // of 128 bytes, which results in an output of approximately 128KB for app names.
    static constexpr int KMaxNumOfOutputAppNames = 1000;

    // To prevent unbounded memory usage, we limit the size of the saved app name to approximately
    // 384KB, as it is stored for 24 hours.
    static constexpr int KMaxNumOfSavedAppNames = KMaxNumOfOutputAppNames * 3;

    using APIVersionMetricsMap =
        stdx::unordered_map<std::string, stdx::unordered_map<std::string, Date_t>>;

    static APIVersionMetrics& get(ServiceContext* svc);

    APIVersionMetrics() = default;

    // Update the timestamp for the API version used by the application.
    void update(const std::string& appName, const APIParameters& apiParams);

    void appendAPIVersionMetricsInfo(BSONObjBuilder* b);

    APIVersionMetricsMap getAPIVersionMetrics_forTest();

    void appendAPIVersionMetricsInfo_forTest(BSONObjBuilder* b);

    class APIVersionMetricsSSM;

private:
    void _removeStaleTimestamps(WithLock lk, Date_t now);

    void _appendAPIVersionData(BSONObjBuilder* b);

    mutable Mutex _mutex = MONGO_MAKE_LATCH("APIVersionMetrics::_mutex");

    // Map of maps for API version metrics. For every application, for each API version, we store
    // the most recent timestamp that a command was invoked with that API version.
    APIVersionMetricsMap _apiVersionMetrics;
};

}  // namespace mongo