Coverage Report

Created: 2026-07-20 19:43

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/format_v2/parquet/parquet_profile.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 "format_v2/parquet/parquet_profile.h"
19
20
#include "format_v2/parquet/parquet_statistics.h"
21
22
namespace doris::format::parquet {
23
24
179
void ParquetProfile::init(RuntimeProfile* profile) {
25
179
    if (profile == nullptr) {
26
94
        return;
27
94
    }
28
29
85
    static const char* parquet_profile = "ParquetReader";
30
85
    ADD_TIMER_WITH_LEVEL(profile, parquet_profile, 1);
31
32
85
    filtered_row_groups = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RowGroupsFiltered", TUnit::UNIT,
33
85
                                                       parquet_profile, 1);
34
85
    filtered_row_groups_by_min_max = ADD_CHILD_COUNTER_WITH_LEVEL(
35
85
            profile, "RowGroupsFilteredByMinMax", TUnit::UNIT, parquet_profile, 1);
36
85
    filtered_row_groups_by_dictionary = ADD_CHILD_COUNTER_WITH_LEVEL(
37
85
            profile, "RowGroupsFilteredByDictionary", TUnit::UNIT, parquet_profile, 1);
38
85
    filtered_row_groups_by_bloom_filter = ADD_CHILD_COUNTER_WITH_LEVEL(
39
85
            profile, "RowGroupsFilteredByBloomFilter", TUnit::UNIT, parquet_profile, 1);
40
85
    filtered_row_groups_by_page_index = ADD_CHILD_COUNTER_WITH_LEVEL(
41
85
            profile, "RowGroupsFilteredByPageIndex", TUnit::UNIT, parquet_profile, 1);
42
85
    to_read_row_groups = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RowGroupsReadNum", TUnit::UNIT,
43
85
                                                      parquet_profile, 1);
44
85
    total_row_groups = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RowGroupsTotalNum", TUnit::UNIT,
45
85
                                                    parquet_profile, 1);
46
85
    selected_row_ranges = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "SelectedRowRanges", TUnit::UNIT,
47
85
                                                       parquet_profile, 1);
48
85
    filtered_group_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FilteredRowsByGroup", TUnit::UNIT,
49
85
                                                       parquet_profile, 1);
50
85
    filtered_page_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FilteredRowsByPage", TUnit::UNIT,
51
85
                                                      parquet_profile, 1);
52
85
    pages_skipped_by_data_page_filter = ADD_CHILD_COUNTER_WITH_LEVEL(
53
85
            profile, "PagesSkippedByDataPageFilter", TUnit::UNIT, parquet_profile, 1);
54
85
    data_page_filter_skip_bytes = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "DataPageFilterSkipBytes",
55
85
                                                               TUnit::BYTES, parquet_profile, 1);
56
85
    selected_rows =
57
85
            ADD_CHILD_COUNTER_WITH_LEVEL(profile, "SelectedRows", TUnit::UNIT, parquet_profile, 1);
58
85
    rows_filtered_by_conjunct = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RowsFilteredByConjunct",
59
85
                                                             TUnit::UNIT, parquet_profile, 1);
60
85
    total_batches =
61
85
            ADD_CHILD_COUNTER_WITH_LEVEL(profile, "TotalBatches", TUnit::UNIT, parquet_profile, 1);
62
85
    empty_selection_batches = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "EmptySelectionBatches",
63
85
                                                           TUnit::UNIT, parquet_profile, 1);
64
85
    range_gap_skipped_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RangeGapSkippedRows",
65
85
                                                          TUnit::UNIT, parquet_profile, 1);
66
85
    reader_read_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "ReaderReadRows", TUnit::UNIT,
67
85
                                                    parquet_profile, 1);
68
85
    reader_skip_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "ReaderSkipRows", TUnit::UNIT,
69
85
                                                    parquet_profile, 1);
70
85
    reader_select_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "ReaderSelectRows", TUnit::UNIT,
71
85
                                                      parquet_profile, 1);
72
85
    arrow_read_records_time =
73
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "ArrowReadRecordsTime", parquet_profile, 1);
74
85
    arrow_skip_records_time =
75
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "ArrowSkipRecordsTime", parquet_profile, 1);
76
85
    materialization_time =
77
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "MaterializationTime", parquet_profile, 1);
78
85
    lazy_read_filtered_rows = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FilteredRowsByLazyRead",
79
85
                                                           TUnit::UNIT, parquet_profile, 1);
80
85
    filtered_bytes = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FilteredBytes", TUnit::BYTES,
81
85
                                                  parquet_profile, 1);
82
85
    raw_rows_read =
83
85
            ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RawRowsRead", TUnit::UNIT, parquet_profile, 1);
84
85
    column_read_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "ColumnReadTime", parquet_profile, 1);
85
85
    parse_meta_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "ParseMetaTime", parquet_profile, 1);
86
85
    parse_footer_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "ParseFooterTime", parquet_profile, 1);
87
85
    file_reader_create_time =
88
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileReaderCreateTime", parquet_profile, 1);
89
85
    open_file_num =
90
85
            ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FileNum", TUnit::UNIT, parquet_profile, 1);
91
85
    page_index_read_calls = ADD_COUNTER_WITH_LEVEL(profile, "PageIndexReadCalls", TUnit::UNIT, 1);
92
85
    page_index_filter_time =
93
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "PageIndexFilterTime", parquet_profile, 1);
94
85
    read_page_index_time =
95
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "PageIndexReadTime", parquet_profile, 1);
96
85
    parse_page_index_time =
97
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "PageIndexParseTime", parquet_profile, 1);
98
85
    expr_zonemap_unusable = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "ExprZoneMapUnusableEvals",
99
85
                                                         TUnit::UNIT, parquet_profile, 1);
100
85
    in_zonemap_point_check = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "InZoneMapPointCheckCount",
101
85
                                                          TUnit::UNIT, parquet_profile, 1);
102
85
    in_zonemap_range_only = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "InZoneMapRangeOnlyCount",
103
85
                                                         TUnit::UNIT, parquet_profile, 1);
104
85
    row_group_filter_time =
105
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "RowGroupFilterTime", parquet_profile, 1);
106
85
    file_footer_read_calls = ADD_COUNTER_WITH_LEVEL(profile, "FileFooterReadCalls", TUnit::UNIT, 1);
107
85
    file_footer_hit_cache = ADD_COUNTER_WITH_LEVEL(profile, "FileFooterHitCache", TUnit::UNIT, 1);
108
85
    decompress_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "DecompressTime", parquet_profile, 1);
109
85
    decompress_cnt = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "DecompressCount", TUnit::UNIT,
110
85
                                                  parquet_profile, 1);
111
85
    page_read_counter =
112
85
            ADD_CHILD_COUNTER_WITH_LEVEL(profile, "PageReadCount", TUnit::UNIT, parquet_profile, 1);
113
85
    page_cache_write_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "PageCacheWriteCount",
114
85
                                                            TUnit::UNIT, parquet_profile, 1);
115
85
    page_cache_compressed_write_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
116
85
            profile, "PageCacheCompressedWriteCount", TUnit::UNIT, parquet_profile, 1);
117
85
    page_cache_decompressed_write_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
118
85
            profile, "PageCacheDecompressedWriteCount", TUnit::UNIT, parquet_profile, 1);
119
85
    page_cache_hit_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "PageCacheHitCount", TUnit::UNIT,
120
85
                                                          parquet_profile, 1);
121
85
    page_cache_missing_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "PageCacheMissingCount",
122
85
                                                              TUnit::UNIT, parquet_profile, 1);
123
85
    page_cache_compressed_hit_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
124
85
            profile, "PageCacheCompressedHitCount", TUnit::UNIT, parquet_profile, 1);
125
85
    page_cache_decompressed_hit_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
126
85
            profile, "PageCacheDecompressedHitCount", TUnit::UNIT, parquet_profile, 1);
127
85
    decode_header_time =
128
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "PageHeaderDecodeTime", parquet_profile, 1);
129
85
    read_page_header_time =
130
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "PageHeaderReadTime", parquet_profile, 1);
131
85
    decode_value_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "DecodeValueTime", parquet_profile, 1);
132
85
    decode_dict_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "DecodeDictTime", parquet_profile, 1);
133
85
    decode_level_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "DecodeLevelTime", parquet_profile, 1);
134
85
    decode_null_map_time =
135
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "DecodeNullMapTime", parquet_profile, 1);
136
85
    skip_page_header_num = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "SkipPageHeaderNum", TUnit::UNIT,
137
85
                                                        parquet_profile, 1);
138
85
    parse_page_header_num = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "ParsePageHeaderNum", TUnit::UNIT,
139
85
                                                         parquet_profile, 1);
140
85
    predicate_filter_time =
141
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "PredicateFilterTime", parquet_profile, 1);
142
85
    dict_filter_rewrite_time =
143
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "DictFilterRewriteTime", parquet_profile, 1);
144
85
    dict_filter_expr_rewrite_time =
145
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "DictFilterExprRewriteTime", parquet_profile, 1);
146
85
    dict_filter_read_dict_time =
147
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "DictFilterReadDictTime", parquet_profile, 1);
148
85
    dict_filter_build_time =
149
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "DictFilterBuildTime", parquet_profile, 1);
150
85
    dict_filter_candidate_columns = ADD_CHILD_COUNTER_WITH_LEVEL(
151
85
            profile, "DictFilterCandidateColumns", TUnit::UNIT, parquet_profile, 1);
152
85
    dict_filter_columns = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "DictFilterColumns", TUnit::UNIT,
153
85
                                                       parquet_profile, 1);
154
85
    dict_filter_unsupported_columns = ADD_CHILD_COUNTER_WITH_LEVEL(
155
85
            profile, "DictFilterUnsupportedColumns", TUnit::UNIT, parquet_profile, 1);
156
85
    dict_filter_read_failures = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "DictFilterReadFailures",
157
85
                                                             TUnit::UNIT, parquet_profile, 1);
158
85
    rows_filtered_by_dict_filter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "RowsFilteredByDictFilter",
159
85
                                                                TUnit::UNIT, parquet_profile, 1);
160
85
    convert_time = ADD_CHILD_TIMER_WITH_LEVEL(profile, "ConvertTime", parquet_profile, 1);
161
85
    bloom_filter_read_time =
162
85
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "BloomFilterReadTime", parquet_profile, 1);
163
85
}
164
165
85
void ParquetProfile::update_pruning_stats(const ParquetPruningStats& pruning_stats) const {
166
85
    COUNTER_UPDATE(filtered_row_groups,
167
85
                   pruning_stats.total_row_groups - pruning_stats.selected_row_groups);
168
85
    COUNTER_UPDATE(filtered_row_groups_by_min_max, pruning_stats.filtered_row_groups_by_statistics);
169
85
    COUNTER_UPDATE(filtered_row_groups_by_dictionary,
170
85
                   pruning_stats.filtered_row_groups_by_dictionary);
171
85
    COUNTER_UPDATE(filtered_row_groups_by_bloom_filter,
172
85
                   pruning_stats.filtered_row_groups_by_bloom_filter);
173
85
    COUNTER_UPDATE(filtered_row_groups_by_page_index,
174
85
                   pruning_stats.filtered_row_groups_by_page_index);
175
85
    COUNTER_UPDATE(to_read_row_groups, pruning_stats.selected_row_groups);
176
85
    COUNTER_UPDATE(total_row_groups, pruning_stats.total_row_groups);
177
85
    COUNTER_UPDATE(selected_row_ranges, pruning_stats.selected_row_ranges);
178
85
    COUNTER_UPDATE(filtered_group_rows, pruning_stats.filtered_group_rows);
179
85
    COUNTER_UPDATE(filtered_page_rows, pruning_stats.filtered_page_rows);
180
85
    COUNTER_UPDATE(page_index_read_calls, pruning_stats.page_index_read_calls);
181
85
    COUNTER_UPDATE(bloom_filter_read_time, pruning_stats.bloom_filter_read_time);
182
85
    COUNTER_UPDATE(row_group_filter_time, pruning_stats.row_group_filter_time);
183
85
    COUNTER_UPDATE(page_index_filter_time, pruning_stats.page_index_filter_time);
184
85
    COUNTER_UPDATE(read_page_index_time, pruning_stats.read_page_index_time);
185
85
    COUNTER_UPDATE(expr_zonemap_unusable, pruning_stats.expr_zonemap_unusable_evals);
186
85
    COUNTER_UPDATE(in_zonemap_point_check, pruning_stats.in_zonemap_point_check_count);
187
85
    COUNTER_UPDATE(in_zonemap_range_only, pruning_stats.in_zonemap_range_only_count);
188
85
}
189
190
181
ParquetPageSkipProfile ParquetProfile::page_skip_profile() const {
191
181
    return {
192
181
            .skipped_pages = pages_skipped_by_data_page_filter,
193
181
            .skipped_bytes = data_page_filter_skip_bytes,
194
181
    };
195
181
}
196
197
181
ParquetColumnReaderProfile ParquetProfile::column_reader_profile() const {
198
181
    return {
199
181
            .reader_read_rows = reader_read_rows,
200
181
            .reader_skip_rows = reader_skip_rows,
201
181
            .reader_select_rows = reader_select_rows,
202
181
            .arrow_read_records_time = arrow_read_records_time,
203
181
            .arrow_skip_records_time = arrow_skip_records_time,
204
181
            .materialization_time = materialization_time,
205
181
    };
206
181
}
207
208
181
ParquetScanProfile ParquetProfile::scan_profile() const {
209
181
    return {
210
181
            .raw_rows_read = raw_rows_read,
211
181
            .selected_rows = selected_rows,
212
181
            .rows_filtered_by_conjunct = rows_filtered_by_conjunct,
213
181
            .lazy_read_filtered_rows = lazy_read_filtered_rows,
214
181
            .total_batches = total_batches,
215
181
            .empty_selection_batches = empty_selection_batches,
216
181
            .range_gap_skipped_rows = range_gap_skipped_rows,
217
181
            .column_read_time = column_read_time,
218
181
            .predicate_filter_time = predicate_filter_time,
219
181
            .dict_filter_rewrite_time = dict_filter_rewrite_time,
220
181
            .dict_filter_expr_rewrite_time = dict_filter_expr_rewrite_time,
221
181
            .dict_filter_read_dict_time = dict_filter_read_dict_time,
222
181
            .dict_filter_build_time = dict_filter_build_time,
223
181
            .dict_filter_candidate_columns = dict_filter_candidate_columns,
224
181
            .dict_filter_columns = dict_filter_columns,
225
181
            .dict_filter_unsupported_columns = dict_filter_unsupported_columns,
226
181
            .dict_filter_read_failures = dict_filter_read_failures,
227
181
            .rows_filtered_by_dict_filter = rows_filtered_by_dict_filter,
228
181
            .column_reader_profile = column_reader_profile(),
229
181
    };
230
181
}
231
232
} // namespace doris::format::parquet