summaryrefslogtreecommitdiff
path: root/src/mongo/db/auth/ldap_cumulative_operation_stats.h
blob: c24bce49c473b174aefb450c231a1ddd149009db (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
/**
 *    Copyright (C) 2021-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 <cstdint>
#include <memory>

#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/duration.h"
#include "mongo/util/tick_source.h"

namespace mongo {

class LDAPOperationStats;

/**
 * Class used to track statistics associated with LDAP operations for a specfic
 * UserAcquisitionStats object.
 */
class LDAPCumulativeOperationStats {
public:
    LDAPCumulativeOperationStats() = default;
    ~LDAPCumulativeOperationStats() = default;
    LDAPCumulativeOperationStats(const LDAPCumulativeOperationStats&) = delete;
    LDAPCumulativeOperationStats& operator=(const LDAPCumulativeOperationStats&) = delete;

    /**
     * Marshals all statistics into BSON for reporting.
     */
    void report(BSONObjBuilder* builder) const;

    /**
     * Marshals all statistics into a string for reporting.
     */
    void toString(StringBuilder* sb) const;

    /**
     * Indicates whether any data was recorded
     */
    bool hasData() const;

    /**
     * Record stats for an LDAP operation.
     * Parameter "isUnbind" is true when we record disconnection, false otherwise
     */
    void recordOpStats(const LDAPOperationStats& stats, bool isUnbind);

    /**
     * Gets pointer to a global instance or nullptr if not initialized.
     */
    static LDAPCumulativeOperationStats* get();

private:
    /**
     * Struct Stats is used to contain information about the bind, search, and unbind stats
     * of the LDAP Operations.
     */
    struct Stats {
        int64_t numOps{0};
        Microseconds totalTime{Microseconds{0}};
    };

    /**
     * Number of referrals to other LDAP servers
     */
    int64_t _numReferrals{0};

    /**
     * Metrics associated with binding, search/query, and unbinding from an LDAP server.
     */
    Stats _bindStats;
    Stats _searchStats;
    Stats _unbindStats;

    /**
     * Protects access to member variables.
     */
    mutable Mutex _memberAccessMutex =
        MONGO_MAKE_LATCH("LDAPCumulativeOperationStats::_memberAccessMutex");
};
}  // namespace mongo