aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/tests/proton/persistenceengine/resource_usage_tracker/resource_usage_tracker_test.cpp
blob: c0d94ba6376f168bdbd48eebec431124a118ad82 (plain) (blame)
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/persistence/spi/resource_usage.h>
#include <vespa/persistence/spi/resource_usage_listener.h>
#include <vespa/searchcore/proton/attribute/attribute_usage_stats.h>
#include <vespa/searchcore/proton/attribute/i_attribute_usage_listener.h>
#include <vespa/searchcore/proton/persistenceengine/resource_usage_tracker.h>
#include <vespa/searchcore/proton/test/disk_mem_usage_notifier.h>
#include <vespa/searchlib/attribute/address_space_components.h>
#include <vespa/vespalib/gtest/gtest.h>
#include <vespa/vespalib/util/idestructorcallback.h>
#include <atomic>

using storage::spi::AttributeResourceUsage;
using storage::spi::ResourceUsage;
using proton::test::DiskMemUsageNotifier;
using proton::AttributeUsageStats;
using proton::DiskMemUsageState;
using proton::ResourceUsageTracker;

namespace {

struct MyResourceUsageListener : public storage::spi::ResourceUsageListener
{
    std::atomic<size_t> _update_count;

    MyResourceUsageListener()
        : storage::spi::ResourceUsageListener(),
          _update_count(0u)
    {
    }

    void update_resource_usage(const ResourceUsage& resource_usage) override {
        storage::spi::ResourceUsageListener::update_resource_usage(resource_usage);
        ++_update_count;
    }
    size_t get_update_count() const { return _update_count; }
};

}

class ResourceUsageTrackerTest : public ::testing::Test
{
protected:
    DiskMemUsageNotifier                     _notifier;
    std::shared_ptr<ResourceUsageTracker>    _tracker;
    std::unique_ptr<MyResourceUsageListener> _listener;

public:
    ResourceUsageTrackerTest()
        : testing::Test(),
          _notifier(DiskMemUsageState({ 0.8, 0.5 }, { 0.8, 0.4 })),
          _tracker(std::make_shared<ResourceUsageTracker>(_notifier)),
          _listener(std::make_unique<MyResourceUsageListener>())
    {
    }

    ~ResourceUsageTrackerTest();

    void notify(double disk_usage, double memory_usage, double transient_disk_usage = 0.0, double transient_memory_usage = 0.0)
    {
        _notifier.notify(DiskMemUsageState({ 0.8, disk_usage }, { 0.8, memory_usage },
                                           transient_disk_usage, transient_memory_usage));
    }

    ResourceUsage get_usage() { return _listener->get_usage(); }
    size_t get_update_count() const { return _listener->get_update_count(); }
};

ResourceUsageTrackerTest::~ResourceUsageTrackerTest() = default;

TEST_F(ResourceUsageTrackerTest, resource_usage_is_forwarded_to_listener)
{
    EXPECT_EQ(ResourceUsage(0.0, 0.0), get_usage());
    auto register_guard = _tracker->set_listener(*_listener);
    EXPECT_EQ(ResourceUsage(0.5, 0.4), get_usage());
    notify(0.75, 0.25);
    EXPECT_EQ(ResourceUsage(0.75, 0.25), get_usage());
}

TEST_F(ResourceUsageTrackerTest, transient_resource_usage_is_subtracted_from_absolute_usage)
{
    auto register_guard = _tracker->set_listener(*_listener);
    notify(0.8, 0.5, 0.4, 0.2);
    EXPECT_EQ(ResourceUsage(0.4, 0.3), get_usage());
    notify(0.8, 0.5, 0.9, 0.6);
    EXPECT_EQ(ResourceUsage(0.0, 0.0), get_usage());
}

TEST_F(ResourceUsageTrackerTest, forwarding_depends_on_register_guard)
{
    auto register_guard = _tracker->set_listener(*_listener);
    register_guard.reset();
    notify(0.75, 0.25);
    EXPECT_EQ(ResourceUsage(0.5, 0.4), get_usage());
}

TEST_F(ResourceUsageTrackerTest, no_forwarding_to_deleted_listener)
{
    _listener->set_register_guard(_tracker->set_listener(*_listener));
    notify(0.75, 0.25);
    EXPECT_EQ(ResourceUsage(0.75, 0.25), get_usage());
    _listener.reset();
    notify(0.2, 0.1);
}

TEST_F(ResourceUsageTrackerTest, register_guard_handles_deleted_tracker)
{
    auto register_guard = _tracker->set_listener(*_listener);
    _tracker.reset();
}

namespace {

struct NamedAttribute
{
    vespalib::string subdb;
    vespalib::string attribute;

    NamedAttribute(const vespalib::string& subdb_in, const vespalib::string& attribute_in)
        : subdb(subdb_in),
          attribute(attribute_in)
    {
    }
};

NamedAttribute ready_a1("0.ready", "a1");
NamedAttribute notready_a1("2.notready", "a1");
NamedAttribute ready_a2("0.ready", "a2");

constexpr size_t usage_limit = 1024;

struct AttributeUsageStatsBuilder
{
    AttributeUsageStats stats;

    AttributeUsageStatsBuilder()
        : stats()
    {
    }

    ~AttributeUsageStatsBuilder();

    AttributeUsageStatsBuilder& reset() { stats = AttributeUsageStats(); return *this; }
    AttributeUsageStatsBuilder& merge(const NamedAttribute& named_attribute, size_t used_address_space);

    AttributeUsageStats build() { return stats; }

};

AttributeUsageStatsBuilder::~AttributeUsageStatsBuilder() = default;

AttributeUsageStatsBuilder&
AttributeUsageStatsBuilder::merge(const NamedAttribute& named_attribute, size_t used_address_space)
{
    vespalib::AddressSpace address_space_usage(used_address_space, 0, usage_limit);
    search::AddressSpaceUsage as_usage;
    as_usage.set("comp", address_space_usage);
    stats.merge(as_usage, named_attribute.attribute, named_attribute.subdb);
    return *this;
}

double rel_usage(size_t usage) noexcept {
    return (double) usage / (double) usage_limit;
}

ResourceUsage make_resource_usage(const vespalib::string& attr_name, size_t used_address_space)
{
    AttributeResourceUsage address_space_usage(rel_usage(used_address_space), attr_name);
    return ResourceUsage(0.0, 0.0, address_space_usage);
}

}

TEST_F(ResourceUsageTrackerTest, aggregates_attribute_usage)
{
    notify(0.0, 0.0);
    auto register_guard = _tracker->set_listener(*_listener);
    auto aul1 = _tracker->make_attribute_usage_listener("doctype1");
    auto aul2 = _tracker->make_attribute_usage_listener("doctype2");
    AttributeUsageStatsBuilder b1;
    AttributeUsageStatsBuilder b2;
    b1.merge(ready_a1, 10).merge(ready_a2, 5);
    b2.merge(ready_a1, 15);
    aul1->notify_attribute_usage(b1.build());
    aul2->notify_attribute_usage(b2.build());
    EXPECT_EQ(make_resource_usage("doctype2.0.ready.a1.comp", 15), get_usage());
    b1.merge(notready_a1, 16);
    aul1->notify_attribute_usage(b1.build());
    EXPECT_EQ(make_resource_usage("doctype1.2.notready.a1.comp", 16), get_usage());
    b1.reset().merge(ready_a1, 10).merge(ready_a2, 5);
    aul1->notify_attribute_usage(b1.build());
    EXPECT_EQ(make_resource_usage("doctype2.0.ready.a1.comp", 15), get_usage());
    aul2.reset();
    EXPECT_EQ(make_resource_usage("doctype1.0.ready.a1.comp", 10), get_usage());
    aul1.reset();
    EXPECT_EQ(make_resource_usage("", 0), get_usage());
    aul2 = _tracker->make_attribute_usage_listener("doctype2");
    aul2->notify_attribute_usage(b2.build());
    EXPECT_EQ(make_resource_usage("doctype2.0.ready.a1.comp", 15), get_usage());
}

TEST_F(ResourceUsageTrackerTest, can_skip_scan_when_aggregating_attributes)
{
    notify(0.0, 0.0);
    auto register_guard = _tracker->set_listener(*_listener);
    auto aul1 = _tracker->make_attribute_usage_listener("doctype1");
    auto aul2 = _tracker->make_attribute_usage_listener("doctype2");
    AttributeUsageStatsBuilder b1;
    AttributeUsageStatsBuilder b2;
    b1.merge(ready_a1, 20).merge(ready_a2, 5);
    b2.merge(ready_a1, 15);
    aul1->notify_attribute_usage(b1.build());
    EXPECT_EQ(make_resource_usage("doctype1.0.ready.a1.comp", 20), get_usage());
    EXPECT_EQ(2u, get_update_count());
    aul1->notify_attribute_usage(b1.build());
    EXPECT_EQ(make_resource_usage("doctype1.0.ready.a1.comp", 20), get_usage());
    EXPECT_EQ(2u, get_update_count()); // usage for doctype1 has not changed
    aul2->notify_attribute_usage(b2.build());
    EXPECT_EQ(make_resource_usage("doctype1.0.ready.a1.comp", 20), get_usage());
    EXPECT_EQ(2u, get_update_count()); // usage for doctype2 is less than usage for doctype1
    aul2.reset();
    aul1.reset();
    EXPECT_EQ(4u, get_update_count()); // never skip scan when removing document type
}

GTEST_MAIN_RUN_ALL_TESTS()