tsreaper commented on code in PR #2287: URL: https://github.com/apache/incubator-paimon/pull/2287#discussion_r1401843627
########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List Review Comment: ```suggestion ## Metrics List ``` ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List + +Below is lists of paimon built-in metrics. They are summarized into three types of metrics, scan metrics, commit metrics and compaction metrics. And also Flink source / sink metrics implemented are listed here. + +## Scan Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastScanDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last scan.</td> + </tr> + <tr> + <td>scanDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few scans.</td> + </tr> + <tr> + <td>lastScannedManifests</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of scanned manifest files in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByPartitionAndStats</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by partition filter and value / key stats information in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByBucketAndLevelFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket, bucket key and level filter in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByWholeBucketFilesFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket level value filter (only primary key table) in the last scan.</td> + </tr> + <tr> + <td>lastScanSkippedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Total skipped table files in the last scan.</td> + </tr> + <tr> + <td>lastScanResultedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Resulted table files in the last scan.</td> + </tr> + </tbody> +</table> + +## Commit Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCommitDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last commit.</td> + </tr> + <tr> + <td>commitDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few commits.</td> + </tr> + <tr> + <td>lastCommitAttempts</td> + <td>Table</td> + <td>Gauge</td> + <td>The number of attempts the last commit made.</td> + </tr> + <tr> + <td>lastTableFilesAdded</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of added table files in the last commit, including newly created data files and compacted after.</td> + </tr> + <tr> + <td>lastTableFilesDeleted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of deleted table files in the last commit, which comes from compacted before.</td> + </tr> + <tr> + <td>lastTableFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended table files in the last commit, which means the newly created data files.</td> + </tr> + <tr> + <td>lastTableFilesCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted table files in the last commit, including compacted before and after.</td> + </tr> + <tr> + <td>lastChangelogFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended changelog files in last commit.</td> + </tr> + <tr> + <td>lastChangelogFileCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted changelog files in last commit.</td> + </tr> + <tr> + <td>lastGeneratedSnapshots</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of snapshot files generated in the last commit, maybe 1 snapshot or 2 snapshots.</td> + </tr> + <tr> + <td>lastDeltaRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastDeltaRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastPartitionsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of partitions written in the last commit.</td> + </tr> + <tr> + <td>lastBucketsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of buckets written in the last commit.</td> + </tr> + </tbody> +</table> + +## Compaction Metrics Review Comment: ```suggestion ### Compaction Metrics ``` ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). Review Comment: flink, spark, paimon should all be capitalized. flink -> Flink, spark -> Spark, paimon -> Paimon ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List + +Below is lists of paimon built-in metrics. They are summarized into three types of metrics, scan metrics, commit metrics and compaction metrics. And also Flink source / sink metrics implemented are listed here. + +## Scan Metrics Review Comment: ```suggestion ### Scan Metrics ``` ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List + +Below is lists of paimon built-in metrics. They are summarized into three types of metrics, scan metrics, commit metrics and compaction metrics. And also Flink source / sink metrics implemented are listed here. + +## Scan Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastScanDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last scan.</td> + </tr> + <tr> + <td>scanDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few scans.</td> + </tr> + <tr> + <td>lastScannedManifests</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of scanned manifest files in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByPartitionAndStats</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by partition filter and value / key stats information in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByBucketAndLevelFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket, bucket key and level filter in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByWholeBucketFilesFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket level value filter (only primary key table) in the last scan.</td> + </tr> + <tr> + <td>lastScanSkippedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Total skipped table files in the last scan.</td> + </tr> + <tr> + <td>lastScanResultedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Resulted table files in the last scan.</td> + </tr> + </tbody> +</table> + +## Commit Metrics Review Comment: ```suggestion ### Commit Metrics ``` ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List + +Below is lists of paimon built-in metrics. They are summarized into three types of metrics, scan metrics, commit metrics and compaction metrics. And also Flink source / sink metrics implemented are listed here. + +## Scan Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastScanDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last scan.</td> + </tr> + <tr> + <td>scanDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few scans.</td> + </tr> + <tr> + <td>lastScannedManifests</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of scanned manifest files in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByPartitionAndStats</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by partition filter and value / key stats information in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByBucketAndLevelFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket, bucket key and level filter in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByWholeBucketFilesFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket level value filter (only primary key table) in the last scan.</td> + </tr> + <tr> + <td>lastScanSkippedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Total skipped table files in the last scan.</td> + </tr> + <tr> + <td>lastScanResultedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Resulted table files in the last scan.</td> + </tr> + </tbody> +</table> + +## Commit Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCommitDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last commit.</td> + </tr> + <tr> + <td>commitDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few commits.</td> + </tr> + <tr> + <td>lastCommitAttempts</td> + <td>Table</td> + <td>Gauge</td> + <td>The number of attempts the last commit made.</td> + </tr> + <tr> + <td>lastTableFilesAdded</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of added table files in the last commit, including newly created data files and compacted after.</td> + </tr> + <tr> + <td>lastTableFilesDeleted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of deleted table files in the last commit, which comes from compacted before.</td> + </tr> + <tr> + <td>lastTableFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended table files in the last commit, which means the newly created data files.</td> + </tr> + <tr> + <td>lastTableFilesCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted table files in the last commit, including compacted before and after.</td> + </tr> + <tr> + <td>lastChangelogFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended changelog files in last commit.</td> + </tr> + <tr> + <td>lastChangelogFileCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted changelog files in last commit.</td> + </tr> + <tr> + <td>lastGeneratedSnapshots</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of snapshot files generated in the last commit, maybe 1 snapshot or 2 snapshots.</td> + </tr> + <tr> + <td>lastDeltaRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastDeltaRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastPartitionsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of partitions written in the last commit.</td> + </tr> + <tr> + <td>lastBucketsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of buckets written in the last commit.</td> + </tr> + </tbody> +</table> + +## Compaction Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCompactionDuration</td> + <td>Bucket</td> + <td>Gauge</td> + <td>The time it took to complete the last compaction.</td> + </tr> + <tr> + <td>compactionDuration</td> + <td>Bucket</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few compaction.</td> + </tr> + <tr> + <td>lastTableFilesCompactedBefore</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of deleted files in the last compaction.</td> + </tr> + <tr> + <td>lastTableFilesCompactedAfter</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of added files in the last compaction.</td> + </tr> + <tr> + <td>lastChangelogFilesCompacted</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of changelog files compacted in last compaction.</td> + </tr> + <tr> + <td>lastRewriteInputFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of deleted files in the last compaction.</td> + </tr> + <tr> + <td>lastRewriteOutputFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of added files in the last compaction.</td> + </tr> + <tr> + <td>lastRewriteChangelogFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of changelog files compacted in last compaction.</td> + </tr> + </tbody> +</table> + +## Source Metrics (Flink) + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>currentFetchEventTimeLag</td> + <td>Flink Source Operator</td> + <td>Gauge</td> + <td>Time difference between reading the data file and file creation.</td> + </tr> + </tbody> +</table> + +## Sink Metrics (Flink) + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>numBytesOut</td> + <td>Table</td> + <td>Counter</td> + <td>The total number of output bytes.</td> + </tr> + <tr> + <td>numBytesOutPerSecond</td> + <td>Table</td> + <td>Meter</td> + <td>The output bytes per second.</td> + </tr> + <tr> + <td>numRecordsOut</td> + <td>Table</td> + <td>Counter</td> + <td>The total number of output records.</td> + </tr> + <tr> + <td>numRecordsOutPerSecond</td> + <td>Table</td> + <td>Meter</td> + <td>The output records per second.</td> + </tr> + </tbody> +</table> + +# Bridging To Flink + +Paimon has implemented bridging metrics to Flink's metrics system, which can be reported by Flink, and the lifecycle of metric groups are managed by Flink. + +Please join the `<scope>.<infix>.<metric_name>` to get the complete metric identifier when using Flink to access Paimon, `metric_name` can be got from [Metric List]({{< ref "maintenance/metrics#metrics-list" >}}). Review Comment: Provide an example here. "For example, the identifier of metric `lastScanDuration` for table `MyTable` is xxxxxx". ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List + +Below is lists of paimon built-in metrics. They are summarized into three types of metrics, scan metrics, commit metrics and compaction metrics. And also Flink source / sink metrics implemented are listed here. + +## Scan Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastScanDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last scan.</td> + </tr> + <tr> + <td>scanDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few scans.</td> + </tr> + <tr> + <td>lastScannedManifests</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of scanned manifest files in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByPartitionAndStats</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by partition filter and value / key stats information in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByBucketAndLevelFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket, bucket key and level filter in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByWholeBucketFilesFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket level value filter (only primary key table) in the last scan.</td> + </tr> + <tr> + <td>lastScanSkippedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Total skipped table files in the last scan.</td> + </tr> + <tr> + <td>lastScanResultedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Resulted table files in the last scan.</td> + </tr> + </tbody> +</table> + +## Commit Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCommitDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last commit.</td> + </tr> + <tr> + <td>commitDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few commits.</td> + </tr> + <tr> + <td>lastCommitAttempts</td> + <td>Table</td> + <td>Gauge</td> + <td>The number of attempts the last commit made.</td> + </tr> + <tr> + <td>lastTableFilesAdded</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of added table files in the last commit, including newly created data files and compacted after.</td> + </tr> + <tr> + <td>lastTableFilesDeleted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of deleted table files in the last commit, which comes from compacted before.</td> + </tr> + <tr> + <td>lastTableFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended table files in the last commit, which means the newly created data files.</td> + </tr> + <tr> + <td>lastTableFilesCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted table files in the last commit, including compacted before and after.</td> + </tr> + <tr> + <td>lastChangelogFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended changelog files in last commit.</td> + </tr> + <tr> + <td>lastChangelogFileCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted changelog files in last commit.</td> + </tr> + <tr> + <td>lastGeneratedSnapshots</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of snapshot files generated in the last commit, maybe 1 snapshot or 2 snapshots.</td> + </tr> + <tr> + <td>lastDeltaRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastDeltaRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastPartitionsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of partitions written in the last commit.</td> + </tr> + <tr> + <td>lastBucketsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of buckets written in the last commit.</td> + </tr> + </tbody> +</table> + +## Compaction Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCompactionDuration</td> + <td>Bucket</td> + <td>Gauge</td> + <td>The time it took to complete the last compaction.</td> + </tr> + <tr> + <td>compactionDuration</td> + <td>Bucket</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few compaction.</td> + </tr> + <tr> + <td>lastTableFilesCompactedBefore</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of deleted files in the last compaction.</td> + </tr> + <tr> + <td>lastTableFilesCompactedAfter</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of added files in the last compaction.</td> + </tr> + <tr> + <td>lastChangelogFilesCompacted</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of changelog files compacted in last compaction.</td> + </tr> + <tr> + <td>lastRewriteInputFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of deleted files in the last compaction.</td> + </tr> + <tr> + <td>lastRewriteOutputFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of added files in the last compaction.</td> + </tr> + <tr> + <td>lastRewriteChangelogFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of changelog files compacted in last compaction.</td> + </tr> + </tbody> +</table> + +## Source Metrics (Flink) + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>currentFetchEventTimeLag</td> + <td>Flink Source Operator</td> + <td>Gauge</td> + <td>Time difference between reading the data file and file creation.</td> + </tr> + </tbody> +</table> + +## Sink Metrics (Flink) Review Comment: Same as above. ########## docs/content/maintenance/metrics.md: ########## @@ -0,0 +1,387 @@ +--- +title: "Metrics" +weight: 9 +type: docs +aliases: +- /maintenance/metrics.html +--- +<!-- +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. +--> + +# Paimon Metrics + +Paimon has built a metrics system to measure the behaviours of reading and writing, like how many manifest files it scanned in the last planning, how long it took in the last commit operation, how many files it deleted in the last compact operation. + +In paimon's metrics system, metrics are updated and reported at different levels of granularity. Currently, the levels of **table** and **bucket** are provided, which means you can get metrics per table or bucket. + +There are three types of metrics provided in the paimon metric system, `Gauge`, `Counter`, `Histogram`. +- `Gauge`: Provides a value of any type at a point in time. +- `Counter`: Used to count values by incrementing and decrementing. +- `Histogram`: Measure the statistical distribution of a set of values including the min, max, mean, standard deviation and percentile. + +Paimon has supported built-in metrics to measure operations of **commits**, **scans** and **compactions**, which can be bridged to any computing engine that supports, like flink, spark etc. Besides, when using flink to read and write, paimon has implemented some key standard flink connector metrics to measure the source latency and output of sink, see [FLIP-33: Standardize Connector Metrics](https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics). + +# Metrics List + +Below is lists of paimon built-in metrics. They are summarized into three types of metrics, scan metrics, commit metrics and compaction metrics. And also Flink source / sink metrics implemented are listed here. + +## Scan Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastScanDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last scan.</td> + </tr> + <tr> + <td>scanDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few scans.</td> + </tr> + <tr> + <td>lastScannedManifests</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of scanned manifest files in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByPartitionAndStats</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by partition filter and value / key stats information in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByBucketAndLevelFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket, bucket key and level filter in the last scan.</td> + </tr> + <tr> + <td>lastSkippedByWholeBucketFilesFilter</td> + <td>Table</td> + <td>Gauge</td> + <td>Skipped table files by bucket level value filter (only primary key table) in the last scan.</td> + </tr> + <tr> + <td>lastScanSkippedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Total skipped table files in the last scan.</td> + </tr> + <tr> + <td>lastScanResultedTableFiles</td> + <td>Table</td> + <td>Gauge</td> + <td>Resulted table files in the last scan.</td> + </tr> + </tbody> +</table> + +## Commit Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCommitDuration</td> + <td>Table</td> + <td>Gauge</td> + <td>The time it took to complete the last commit.</td> + </tr> + <tr> + <td>commitDuration</td> + <td>Table</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few commits.</td> + </tr> + <tr> + <td>lastCommitAttempts</td> + <td>Table</td> + <td>Gauge</td> + <td>The number of attempts the last commit made.</td> + </tr> + <tr> + <td>lastTableFilesAdded</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of added table files in the last commit, including newly created data files and compacted after.</td> + </tr> + <tr> + <td>lastTableFilesDeleted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of deleted table files in the last commit, which comes from compacted before.</td> + </tr> + <tr> + <td>lastTableFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended table files in the last commit, which means the newly created data files.</td> + </tr> + <tr> + <td>lastTableFilesCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted table files in the last commit, including compacted before and after.</td> + </tr> + <tr> + <td>lastChangelogFilesAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of appended changelog files in last commit.</td> + </tr> + <tr> + <td>lastChangelogFileCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of compacted changelog files in last commit.</td> + </tr> + <tr> + <td>lastGeneratedSnapshots</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of snapshot files generated in the last commit, maybe 1 snapshot or 2 snapshots.</td> + </tr> + <tr> + <td>lastDeltaRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsAppended</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with APPEND commit kind.</td> + </tr> + <tr> + <td>lastDeltaRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Delta records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastChangelogRecordsCommitCompacted</td> + <td>Table</td> + <td>Gauge</td> + <td>Changelog records count in last commit with COMPACT commit kind.</td> + </tr> + <tr> + <td>lastPartitionsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of partitions written in the last commit.</td> + </tr> + <tr> + <td>lastBucketsWritten</td> + <td>Table</td> + <td>Gauge</td> + <td>Number of buckets written in the last commit.</td> + </tr> + </tbody> +</table> + +## Compaction Metrics + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 225pt">Metrics Name</th> + <th class="text-left" style="width: 65pt">Level</th> + <th class="text-left" style="width: 70pt">Type</th> + <th class="text-left" style="width: 300pt">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>lastCompactionDuration</td> + <td>Bucket</td> + <td>Gauge</td> + <td>The time it took to complete the last compaction.</td> + </tr> + <tr> + <td>compactionDuration</td> + <td>Bucket</td> + <td>Histogram</td> + <td>Distributions of the time taken by the last few compaction.</td> + </tr> + <tr> + <td>lastTableFilesCompactedBefore</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of deleted files in the last compaction.</td> + </tr> + <tr> + <td>lastTableFilesCompactedAfter</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of added files in the last compaction.</td> + </tr> + <tr> + <td>lastChangelogFilesCompacted</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Number of changelog files compacted in last compaction.</td> + </tr> + <tr> + <td>lastRewriteInputFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of deleted files in the last compaction.</td> + </tr> + <tr> + <td>lastRewriteOutputFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of added files in the last compaction.</td> + </tr> + <tr> + <td>lastRewriteChangelogFileSize</td> + <td>Bucket</td> + <td>Gauge</td> + <td>Size of changelog files compacted in last compaction.</td> + </tr> + </tbody> +</table> + +## Source Metrics (Flink) Review Comment: Move into section `Bridging to Flink`. -- 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]
