aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/vespa/searchcore/proton/persistenceengine/resource_usage_tracker.cpp
blob: ac79c298b1fdc93ecc35c742a4743a76a66f3f81 (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
228
229
230
231
232
233
234
235
236
237
238
239
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "resource_usage_tracker.h"
#include <vespa/searchcore/proton/attribute/i_attribute_usage_listener.h>
#include <vespa/searchcore/proton/server/disk_mem_usage_state.h>
#include <vespa/searchcore/proton/server/i_disk_mem_usage_notifier.h>
#include <vespa/persistence/spi/i_resource_usage_listener.h>
#include <vespa/vespalib/util/idestructorcallback.h>
#include <vespa/vespalib/stllike/hash_map.hpp>
#include <cassert>

using storage::spi::AttributeResourceUsage;
using storage::spi::ResourceUsage;

namespace proton {

class ResourceUsageTracker::ListenerGuard : public vespalib::IDestructorCallback
{
    std::weak_ptr<ResourceUsageTracker> _tracker;
public:
    ListenerGuard(std::shared_ptr<ResourceUsageTracker> tracker);
    ~ListenerGuard() override;
};

ResourceUsageTracker::ListenerGuard::ListenerGuard(std::shared_ptr<ResourceUsageTracker> tracker)
    : _tracker(tracker)
{
}

ResourceUsageTracker::ListenerGuard::~ListenerGuard()
{
    auto tracker = _tracker.lock();
    if (tracker) {
        tracker->remove_listener();
    }
}

class ResourceUsageTracker::AttributeUsageListener : public IAttributeUsageListener
{
    std::shared_ptr<ResourceUsageTracker> _tracker;
    vespalib::string                      _document_type;

public:
    AttributeUsageListener(std::shared_ptr<ResourceUsageTracker> tracker, const vespalib::string& document_type);

    ~AttributeUsageListener() override;
    void notify_attribute_usage(const AttributeUsageStats &attribute_usage) override;
};

ResourceUsageTracker::AttributeUsageListener::AttributeUsageListener(std::shared_ptr<ResourceUsageTracker> tracker, const vespalib::string &document_type)
    : IAttributeUsageListener(),
      _tracker(std::move(tracker)),
      _document_type(document_type)
{
}

ResourceUsageTracker::AttributeUsageListener::~AttributeUsageListener()
{
    _tracker->remove_document_type(_document_type);
}

void
ResourceUsageTracker::AttributeUsageListener::notify_attribute_usage(const AttributeUsageStats &attribute_usage)
{
    _tracker->notify_attribute_usage(_document_type, attribute_usage);
}

ResourceUsageTracker::ResourceUsageTracker(IDiskMemUsageNotifier& disk_mem_usage_notifier)
    : std::enable_shared_from_this<ResourceUsageTracker>(),
      IDiskMemUsageListener(),
      _lock(),
      _resource_usage(),
      _listener(nullptr),
      _disk_mem_usage_notifier(disk_mem_usage_notifier),
      _attribute_usage(),
      _attribute_address_space_max_document_type()
{
    _disk_mem_usage_notifier.addDiskMemUsageListener(this);
}

ResourceUsageTracker::~ResourceUsageTracker()
{
    _disk_mem_usage_notifier.removeDiskMemUsageListener(this);
}

storage::spi::ResourceUsage
ResourceUsageTracker::get_resource_usage() const
{
    std::lock_guard guard(_lock);
    return _resource_usage;
}

void
ResourceUsageTracker::notifyDiskMemUsage(DiskMemUsageState state)
{
    std::lock_guard guard(_lock);
    // The transient resource usage is subtracted from the total resource usage
    // before it eventually is reported to the cluster controller (to decide whether to block client feed).
    // This ensures that the transient resource usage is covered by the resource headroom on the content node,
    // instead of leading to feed blocked due to natural fluctuations.
    _resource_usage = ResourceUsage(state.non_transient_disk_usage(),
                                    state.non_transient_memory_usage(),
                                    _resource_usage.get_attribute_address_space_usage());
    if (_listener != nullptr) {
        _listener->update_resource_usage(_resource_usage);
    }
}

std::unique_ptr<vespalib::IDestructorCallback>
ResourceUsageTracker::set_listener(storage::spi::IResourceUsageListener& listener)
{
    std::lock_guard guard(_lock);
    assert(_listener == nullptr);
    _listener = &listener;
    listener.update_resource_usage(_resource_usage);
    return std::make_unique<ListenerGuard>(shared_from_this());
}

void
ResourceUsageTracker::remove_listener()
{
    std::lock_guard guard(_lock);
    _listener = nullptr;
}

void
ResourceUsageTracker::remove_document_type(const vespalib::string &document_type)
{
    std::lock_guard guard(_lock);
    _attribute_usage.erase(document_type);
    if (scan_attribute_usage(true, guard) && _listener != nullptr) {
        _listener->update_resource_usage(_resource_usage);
    }
}

namespace {

bool same_usage(const AddressSpaceUsageStats &lhs, const AddressSpaceUsageStats &rhs) {
    return ((lhs.getUsage().usage() == rhs.getUsage().usage()) &&
            (lhs.get_component_name() == rhs.get_component_name()) &&
            (lhs.getAttributeName() == rhs.getAttributeName()) &&
            (lhs.getSubDbName() == rhs.getSubDbName()));
}

bool can_skip_scan(double max, double old_max, bool same_document_type) noexcept {
    return (!same_document_type && (max <= old_max));
}

}

void
ResourceUsageTracker::notify_attribute_usage(const vespalib::string &document_type, const AttributeUsageStats &attribute_usage)
{
    std::lock_guard guard(_lock);
    auto& old_usage = _attribute_usage[document_type];
    if (same_usage(old_usage.max_address_space_usage(), attribute_usage.max_address_space_usage())) {
        return; // usage for document type has not changed
    }
    old_usage = attribute_usage;
    double address_space_max = attribute_usage.max_address_space_usage().getUsage().usage();
    double old_address_space_max = _resource_usage.get_attribute_address_space_usage().get_usage();

    if (can_skip_scan(address_space_max, old_address_space_max,
                      document_type == _attribute_address_space_max_document_type)) {
        return; // usage for document type is less than or equal to usage for other document types
    }
    if (scan_attribute_usage(false, guard) && _listener != nullptr) {
        _listener->update_resource_usage(_resource_usage);
    }
}

namespace {

class MaxAttributeUsage
{
    const AddressSpaceUsageStats* _max;
    const vespalib::string*       _document_type;
    double                        _max_usage;

    vespalib::string get_name() const {
        return *_document_type + "." + _max->getSubDbName() + "." + _max->getAttributeName() + "." + _max->get_component_name();
    }

public:
    MaxAttributeUsage()
        : _max(nullptr),
          _document_type(nullptr),
          _max_usage(0.0)
    {
    }

    void sample(const vespalib::string& document_type, const AddressSpaceUsageStats& usage) {
        if (_max == nullptr || usage.getUsage().usage() > _max_usage) {
            _max = &usage;
            _document_type = &document_type;
            _max_usage = usage.getUsage().usage();
        }
    }
    
    AttributeResourceUsage get_max_resource_usage() {
        if (_max != nullptr) {
            return AttributeResourceUsage(_max_usage, get_name());
        } else {
            return AttributeResourceUsage();
        }
    }

    const vespalib::string get_document_type() const { return _document_type != nullptr ? *_document_type : ""; }
};

}

bool
ResourceUsageTracker::scan_attribute_usage(bool force_changed, std::lock_guard<std::mutex>&)
{
    MaxAttributeUsage address_space_max;
    for (const auto& kv : _attribute_usage) {
        address_space_max.sample(kv.first, kv.second.max_address_space_usage());
    }
    ResourceUsage new_resource_usage(_resource_usage.get_disk_usage(),
                                     _resource_usage.get_memory_usage(),
                                     address_space_max.get_max_resource_usage());

    bool changed = (new_resource_usage != _resource_usage) ||
                   force_changed;
    if (changed) {
        _resource_usage = std::move(new_resource_usage);
        _attribute_address_space_max_document_type = address_space_max.get_document_type();
    }
    return changed;
}

std::unique_ptr<IAttributeUsageListener>
ResourceUsageTracker::make_attribute_usage_listener(const vespalib::string &document_type)
{
    return std::make_unique<AttributeUsageListener>(shared_from_this(), document_type);
}

};