bitsondatadev commented on code in PR #8345: URL: https://github.com/apache/iceberg/pull/8345#discussion_r1297536935
########## docs/metrics-reporting.md: ########## @@ -0,0 +1,175 @@ +--- +title: "Metrics Reporting" +url: metrics-reporting +aliases: + - "tables/metrics-reporting" +menu: + main: + parent: Tables + identifier: metrics_reporting + weight: 0 +--- +<!-- + - Licensed to the Apache Software Foundation (ASF) under one or more + - contributor license agreements. See the NOTICE file distributed with + - this work for additional information regarding copyright ownership. + - The ASF licenses this file to You under the Apache License, Version 2.0 + - (the "License"); you may not use this file except in compliance with + - the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, software + - distributed under the License is distributed on an "AS IS" BASIS, + - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + - See the License for the specific language governing permissions and + - limitations under the License. + --> + +# Metrics Reporting + +As of 1.1.0 Iceberg supports the `MetricsReporter` and the `MetricsReport` APIs. These two APIs allow expressing different metrics reports while supporting a pluggable way of reporting these reports. + + +## Type of Reports + +### ScanReport +A `ScanReport` carries metrics that were collected during scan planning against a given table. Amongst some general information about the involved table, such as the snapshot id or the table name, it includes metrics like: Review Comment: Don't worry about fixing this now, I'll be adding a linter and fixing all of these once we have the basic build in place. But in general when writing any technical content, use present tense. https://learn.microsoft.com/en-us/style-guide/grammar/verbs#verb-tense We have a lot of international readers who struggle with silly ol' English and it's inconsistencies. Let's aim for present unless the situation absolutely calls for another tense. e.g. ``` A `ScanReport` carries metrics that were collected during scan planning against a given table. ``` to ``` A `ScanReport` carries metrics that result from a scan planning operation against a given table. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
