Coverage Report

Created: 2026-06-02 13:37

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/storage/compaction_task_tracker.cpp
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#include "storage/compaction_task_tracker.h"
19
20
#include "common/config.h"
21
#include "common/logging.h"
22
23
namespace doris {
24
25
17.5k
const char* to_string(CompactionProfileType type) {
26
17.5k
    switch (type) {
27
80
    case CompactionProfileType::BASE:
28
80
        return "base";
29
17.4k
    case CompactionProfileType::CUMULATIVE:
30
17.4k
        return "cumulative";
31
45
    case CompactionProfileType::FULL:
32
45
        return "full";
33
0
    case CompactionProfileType::BINLOG:
34
0
        return "binlog";
35
17.5k
    }
36
0
    return "unknown";
37
17.5k
}
38
39
12.2k
const char* to_string(CompactionTaskStatus status) {
40
12.2k
    switch (status) {
41
2
    case CompactionTaskStatus::PENDING:
42
2
        return "PENDING";
43
12
    case CompactionTaskStatus::RUNNING:
44
12
        return "RUNNING";
45
12.1k
    case CompactionTaskStatus::FINISHED:
46
12.1k
        return "FINISHED";
47
78
    case CompactionTaskStatus::FAILED:
48
78
        return "FAILED";
49
12.2k
    }
50
0
    return "UNKNOWN";
51
12.2k
}
52
53
15.7k
const char* to_string(TriggerMethod method) {
54
15.7k
    switch (method) {
55
13.8k
    case TriggerMethod::AUTO:
56
13.8k
        return "AUTO";
57
1.93k
    case TriggerMethod::MANUAL:
58
1.93k
        return "MANUAL";
59
0
    case TriggerMethod::LOAD_TRIGGERED:
60
0
        return "LOAD_TRIGGERED";
61
15.7k
    }
62
0
    return "UNKNOWN";
63
15.7k
}
64
65
240k
CompactionTaskTracker* CompactionTaskTracker::instance() {
66
240k
    static CompactionTaskTracker s_instance;
67
240k
    return &s_instance;
68
240k
}
69
70
6.79k
void CompactionTaskTracker::register_task(CompactionTaskInfo info) {
71
6.79k
    if (!config::enable_compaction_task_tracker) {
72
1
        return;
73
1
    }
74
6.79k
    std::unique_lock wlock(_mutex);
75
6.79k
    _active_tasks[info.compaction_id] = std::move(info);
76
6.79k
}
77
78
6.45k
void CompactionTaskTracker::update_to_running(int64_t compaction_id, const RunningStats& stats) {
79
6.45k
    if (!config::enable_compaction_task_tracker) {
80
0
        return;
81
0
    }
82
6.45k
    std::unique_lock wlock(_mutex);
83
6.45k
    auto it = _active_tasks.find(compaction_id);
84
6.45k
    if (it != _active_tasks.end()) {
85
6.45k
        auto& task = it->second;
86
6.45k
        task.status = CompactionTaskStatus::RUNNING;
87
6.45k
        task.start_time_ms = stats.start_time_ms;
88
6.45k
        task.is_vertical = stats.is_vertical;
89
6.45k
        task.permits = stats.permits;
90
6.45k
    }
91
6.45k
}
92
93
void CompactionTaskTracker::update_progress(int64_t compaction_id, int64_t total_groups,
94
25.8k
                                            int64_t completed_groups) {
95
25.8k
    if (!config::enable_compaction_task_tracker) {
96
0
        return;
97
0
    }
98
25.8k
    std::unique_lock wlock(_mutex);
99
25.8k
    auto it = _active_tasks.find(compaction_id);
100
25.8k
    if (it != _active_tasks.end()) {
101
23.3k
        auto& task = it->second;
102
23.3k
        task.vertical_total_groups = total_groups;
103
23.3k
        task.vertical_completed_groups = completed_groups;
104
23.3k
    }
105
25.8k
}
106
107
6.27k
void CompactionTaskTracker::complete(int64_t compaction_id, const CompletionStats& stats) {
108
6.27k
    if (!config::enable_compaction_task_tracker) {
109
0
        return;
110
0
    }
111
6.27k
    std::unique_lock wlock(_mutex);
112
6.27k
    auto it = _active_tasks.find(compaction_id);
113
6.27k
    if (it == _active_tasks.end()) {
114
1
        LOG(WARNING) << "compaction_id " << compaction_id << " not found in active_tasks, skip";
115
1
        return;
116
1
    }
117
118
    // Extract the task from active map.
119
6.27k
    auto node = _active_tasks.extract(it);
120
6.27k
    CompactionTaskInfo& info = node.mapped();
121
6.27k
    info.status = CompactionTaskStatus::FINISHED;
122
6.27k
    _apply_completion(info, stats);
123
124
6.28k
    if (config::compaction_task_tracker_max_records > 0) {
125
6.28k
        _completed_tasks.push_back(std::move(info));
126
6.28k
        _trim_completed_locked();
127
6.28k
    }
128
6.27k
}
129
130
void CompactionTaskTracker::fail(int64_t compaction_id, const CompletionStats& stats,
131
186
                                 const std::string& msg) {
132
186
    if (!config::enable_compaction_task_tracker) {
133
0
        return;
134
0
    }
135
186
    std::unique_lock wlock(_mutex);
136
186
    auto it = _active_tasks.find(compaction_id);
137
186
    if (it == _active_tasks.end()) {
138
1
        LOG(WARNING) << "compaction_id " << compaction_id << " not found in active_tasks, skip";
139
1
        return;
140
1
    }
141
142
    // Extract the task from active map.
143
185
    auto node = _active_tasks.extract(it);
144
185
    CompactionTaskInfo& info = node.mapped();
145
185
    info.status = CompactionTaskStatus::FAILED;
146
185
    info.status_msg = msg;
147
185
    _apply_completion(info, stats);
148
149
185
    if (config::compaction_task_tracker_max_records > 0) {
150
185
        _completed_tasks.push_back(std::move(info));
151
185
        _trim_completed_locked();
152
185
    }
153
185
}
154
155
6.75k
void CompactionTaskTracker::remove_task(int64_t compaction_id) {
156
6.75k
    if (!config::enable_compaction_task_tracker) {
157
0
        return;
158
0
    }
159
6.75k
    std::unique_lock wlock(_mutex);
160
6.75k
    _active_tasks.erase(compaction_id); // idempotent: no-op if already removed
161
6.75k
}
162
163
void CompactionTaskTracker::_apply_completion(CompactionTaskInfo& info,
164
6.46k
                                              const CompletionStats& stats) {
165
6.46k
    info.end_time_ms = stats.end_time_ms;
166
6.46k
    info.merged_rows = stats.merged_rows;
167
6.46k
    info.filtered_rows = stats.filtered_rows;
168
6.46k
    info.output_rows = stats.output_rows;
169
6.46k
    info.output_row_num = stats.output_row_num;
170
6.46k
    info.output_data_size = stats.output_data_size;
171
6.46k
    info.output_index_size = stats.output_index_size;
172
6.46k
    info.output_total_size = stats.output_total_size;
173
6.46k
    info.output_segments_num = stats.output_segments_num;
174
6.46k
    info.output_version = stats.output_version;
175
6.46k
    info.is_ordered_data_compaction = stats.is_ordered_data_compaction;
176
6.46k
    info.merge_latency_ms = stats.merge_latency_ms;
177
6.46k
    info.bytes_read_from_local = stats.bytes_read_from_local;
178
6.46k
    info.bytes_read_from_remote = stats.bytes_read_from_remote;
179
6.46k
    info.peak_memory_bytes = stats.peak_memory_bytes;
180
    // Backfill input stats if they were 0 at register time.
181
    // Local compaction populates _input_rowsets_data_size etc. in build_basic_info()
182
    // which runs inside execute_compact_impl(), after register_task().
183
6.46k
    if (info.input_version_range.empty() && !stats.input_version_range.empty()) {
184
0
        info.input_version_range = stats.input_version_range;
185
0
    }
186
6.46k
    if (info.input_rowsets_count == 0 && stats.input_rowsets_count > 0) {
187
0
        info.input_rowsets_count = stats.input_rowsets_count;
188
0
    }
189
6.46k
    if (info.input_row_num == 0 && stats.input_row_num > 0) {
190
44
        info.input_row_num = stats.input_row_num;
191
44
    }
192
6.46k
    if (info.input_data_size == 0 && stats.input_data_size > 0) {
193
44
        info.input_data_size = stats.input_data_size;
194
44
    }
195
6.46k
    if (info.input_index_size == 0 && stats.input_index_size > 0) {
196
2
        info.input_index_size = stats.input_index_size;
197
2
    }
198
6.46k
    if (info.input_total_size == 0 && stats.input_total_size > 0) {
199
44
        info.input_total_size = stats.input_total_size;
200
44
    }
201
6.46k
    if (info.input_segments_num == 0 && stats.input_segments_num > 0) {
202
44
        info.input_segments_num = stats.input_segments_num;
203
44
    }
204
6.46k
}
205
206
6.46k
void CompactionTaskTracker::_trim_completed_locked() {
207
6.46k
    int32_t max = config::compaction_task_tracker_max_records;
208
6.46k
    if (max <= 0) {
209
0
        _completed_tasks.clear();
210
0
        return;
211
0
    }
212
6.47k
    while (static_cast<int32_t>(_completed_tasks.size()) > max) {
213
5
        _completed_tasks.pop_front();
214
5
    }
215
6.46k
}
216
217
433
std::vector<CompactionTaskInfo> CompactionTaskTracker::get_all_tasks() const {
218
433
    std::shared_lock rlock(_mutex);
219
433
    std::vector<CompactionTaskInfo> result;
220
433
    result.reserve(_active_tasks.size() + _completed_tasks.size());
221
2.50k
    for (const auto& [id, info] : _active_tasks) {
222
2.50k
        result.push_back(info);
223
2.50k
    }
224
85.6k
    for (const auto& info : _completed_tasks) {
225
85.6k
        result.push_back(info);
226
85.6k
    }
227
433
    return result;
228
433
}
229
230
std::vector<CompactionTaskInfo> CompactionTaskTracker::get_completed_tasks(
231
        int64_t tablet_id, int64_t top_n, const std::string& compaction_type,
232
19
        int success_filter) const {
233
19
    int32_t max = config::compaction_task_tracker_max_records;
234
19
    if (max <= 0) {
235
0
        return {};
236
0
    }
237
238
19
    std::shared_lock rlock(_mutex);
239
19
    std::vector<CompactionTaskInfo> result;
240
19
    int32_t count = 0;
241
    // Iterate in reverse order (newest first).
242
7.45k
    for (auto it = _completed_tasks.rbegin(); it != _completed_tasks.rend(); ++it) {
243
7.44k
        if (count >= max) {
244
0
            break;
245
0
        }
246
7.44k
        count++;
247
7.44k
        const auto& record = *it;
248
7.44k
        if (tablet_id != 0 && record.tablet_id != tablet_id) {
249
3.87k
            continue;
250
3.87k
        }
251
3.57k
        if (!compaction_type.empty() && compaction_type != to_string(record.compaction_type)) {
252
17
            continue;
253
17
        }
254
3.55k
        if (success_filter == 1 && record.status != CompactionTaskStatus::FINISHED) {
255
1
            continue;
256
1
        }
257
3.55k
        if (success_filter == 0 && record.status != CompactionTaskStatus::FAILED) {
258
4
            continue;
259
4
        }
260
3.54k
        result.push_back(record);
261
3.54k
        if (top_n > 0 && static_cast<int64_t>(result.size()) >= top_n) {
262
4
            break;
263
4
        }
264
3.54k
    }
265
19
    return result;
266
19
}
267
268
15
void CompactionTaskTracker::clear_for_test() {
269
15
    std::unique_lock wlock(_mutex);
270
15
    _active_tasks.clear();
271
15
    _completed_tasks.clear();
272
15
}
273
274
} // namespace doris