summaryrefslogtreecommitdiff
path: root/src/mongo/util/log_with_sampling_test.cpp
blob: f0dc97be046822d187fe72e31d0cf5e3a5f2798e (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
/**
 *    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.
 */

#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kDefault

#include "mongo/platform/basic.h"

#include "mongo/db/service_context_test_fixture.h"
#include "mongo/util/log_global_settings.h"
#include "mongo/util/log_with_sampling.h"

namespace mongo {
namespace {


TEST(LogWithSamplingTest, ShouldLogCorrectlyWhenSampleRateIsSet) {
    const auto serviceContext = ServiceContext::make();
    const auto client = serviceContext->makeClient("log_with_sampling_test");
    const auto opCtx = client->makeOperationContext();

    const auto slowOpThresholdMS = Milliseconds(10);

    const auto originalSampleRate = serverGlobalParams.sampleRate;
    // Set sample rate to always profile a slow operation.
    serverGlobalParams.sampleRate = 1;

    // Reset sample rate to the original value after the test exits.
    ON_BLOCK_EXIT([originalSampleRate] { serverGlobalParams.sampleRate = originalSampleRate; });

    // Set the op duration to be greater than slowOpThreshold so that the op is considered slow.
    const auto slowOpDurationMS = Milliseconds(11);
    // Set verbosity level of operation component to info so that it doesn't log due to the log
    // level.
    setMinimumLoggedSeverity(MONGO_LOG_DEFAULT_COMPONENT, logger::LogSeverity::Info());

    bool shouldLogSlowOp, shouldSample;
    std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
        opCtx.get(), MONGO_LOG_DEFAULT_COMPONENT, slowOpDurationMS, slowOpThresholdMS);

    // Verify that shouldLogSlowOp is true when the sampleRate is 1.
    ASSERT_TRUE(shouldLogSlowOp);

    // Verify that shouldSample is true when the sampleRate is 1.
    ASSERT_TRUE(shouldSample);

    // Set sample rate to never profile a slow operation.
    serverGlobalParams.sampleRate = 0;

    std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
        opCtx.get(), MONGO_LOG_DEFAULT_COMPONENT, slowOpDurationMS, slowOpThresholdMS);

    // Verify that shouldLogSlowOp is false when the sampleRate is 0.
    ASSERT_FALSE(shouldLogSlowOp);

    // Verify that shouldSample is false when the sampleRate is 0.
    ASSERT_FALSE(shouldSample);
}

TEST(LogWithSamplingTest, ShouldAlwaysLogsWithVerbosityLevelDebug) {
    const auto serviceContext = ServiceContext::make();
    const auto client = serviceContext->makeClient("log_with_sampling_test");
    const auto opCtx = client->makeOperationContext();

    const auto slowOpThresholdMS = Milliseconds(10);

    const auto originalSampleRate = serverGlobalParams.sampleRate;
    // Set sample rate to always profile a slow operation.
    serverGlobalParams.sampleRate = 1;

    // Reset sample rate to the original value after the test exits.
    ON_BLOCK_EXIT([originalSampleRate] { serverGlobalParams.sampleRate = originalSampleRate; });

    // Set the op duration to be greater than slowMS so that the op is considered slow.
    const auto slowOpDurationMS = Milliseconds(11);
    // Set verbosity level of operation component to debug so that it should always log.
    setMinimumLoggedSeverity(MONGO_LOG_DEFAULT_COMPONENT, logger::LogSeverity::Debug(1));

    bool shouldLogSlowOp, shouldSample;
    std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
        opCtx.get(), MONGO_LOG_DEFAULT_COMPONENT, slowOpDurationMS, slowOpThresholdMS);

    // Verify that shouldLogSlowOp is true when the op is slow.
    ASSERT_TRUE(shouldLogSlowOp);

    // Verify that shouldSample should be true when the sampleRate is 1.
    ASSERT_TRUE(shouldSample);

    // Set sample rate to never profile a slow operation.
    serverGlobalParams.sampleRate = 0;

    std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
        opCtx.get(), MONGO_LOG_DEFAULT_COMPONENT, slowOpDurationMS, slowOpThresholdMS);

    // Verify that we should still log even when the sampleRate is 0.
    ASSERT_TRUE(shouldLogSlowOp);

    // Verify that shouldSample should be false even if shouldLogSlowOp is true.
    ASSERT_FALSE(shouldSample);
}

TEST(LogWithSamplingTest, ShouldNotLogFastOp) {
    const auto serviceContext = ServiceContext::make();
    const auto client = serviceContext->makeClient("log_with_sampling_test");
    const auto opCtx = client->makeOperationContext();

    const auto slowOpThresholdMS = Milliseconds(10);

    const auto originalSampleRate = serverGlobalParams.sampleRate;
    // Set sample rate to always profile a slow operation.
    serverGlobalParams.sampleRate = 1;

    // Reset sample rate to the original value after the test exits.
    ON_BLOCK_EXIT([originalSampleRate] { serverGlobalParams.sampleRate = originalSampleRate; });

    // Set the op duration to be less than than slowOpThreshold so that the op is considered fast.
    const auto fastOpDurationMS = Milliseconds(9);
    // Set verbosity level of operation component to info so that it doesn't log due to the log
    // level.
    setMinimumLoggedSeverity(MONGO_LOG_DEFAULT_COMPONENT, logger::LogSeverity::Info());

    bool shouldLogSlowOp, shouldSample;
    std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
        opCtx.get(), MONGO_LOG_DEFAULT_COMPONENT, fastOpDurationMS, slowOpThresholdMS);

    // Verify that shouldLogSlowOp is false when the op is fast.
    ASSERT_FALSE(shouldLogSlowOp);

    // Verify that shouldSample is true when the sampleRate is 1.
    ASSERT_TRUE(shouldSample);

    // Set sample rate to never profile a slow operation.
    serverGlobalParams.sampleRate = 0;

    std::tie(shouldLogSlowOp, shouldSample) = shouldLogSlowOpWithSampling(
        opCtx.get(), MONGO_LOG_DEFAULT_COMPONENT, fastOpDurationMS, slowOpThresholdMS);

    // Verify that we should still not log when the sampleRate is 0.
    ASSERT_FALSE(shouldLogSlowOp);

    // Verify that shouldSample is false when the sampleRate is 0.
    ASSERT_FALSE(shouldSample);
}

}  // namespace
}  // namespace mongo