[hudi] branch asf-site updated: [HUDI-4610] Document list of metrics emitted by Hudi (#6350)

[yi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

yihua pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new 1d52930027 [HUDI-4610] Document list of metrics emitted by Hudi (#6350)
1d52930027 is described below

commit 1d52930027183857d229a477a244b030f83982c6
Author: Santhosh Kumar M <88...@users.noreply.github.com>
AuthorDate: Wed Sep 7 06:03:28 2022 +0530

    [HUDI-4610] Document list of metrics emitted by Hudi (#6350)
---
 website/docs/metrics.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/website/docs/metrics.md b/website/docs/metrics.md
index 4a831d7981..eddba2a45d 100644
--- a/website/docs/metrics.md
+++ b/website/docs/metrics.md
@@ -201,3 +201,32 @@ These `HoodieMetrics` can then be plotted on a standard tool like grafana. Below
 <figure>
     <img className="docimage" src={require("/assets/images/hudi_commit_duration.png").default} alt="hudi_commit_duration.png"  />
 </figure>
+
+## List of metrics:
+
+The below metrics are available in all timeline operations that involves a commit such as deltacommit, compaction, clustering and rollback.
+
+Name  |  Description
+--- | ---
+commitFreshnessInMs | Milliseconds from the commit end time and the maximum event time of the incoming records
+commitLatencyInMs | Milliseconds from the commit end time and the minimum event time of incoming records
+commitTime  | Time of commit in epoch milliseconds
+duration  | Total time taken for the commit/rollback in milliseconds
+numFilesDeleted | Number of files deleted during a clean/rollback
+numFilesFinalized | Number of files finalized in a write
+totalBytesWritten | Bytes written in a HoodieCommit
+totalCompactedRecordsUpdated  | Number of records updated in a compaction operation
+totalCreateTime | Time taken for file creation during a Hoodie Insert operation
+totalFilesInsert  | Number of newly written files in a HoodieCommit
+totalFilesUpdate  | Number of files updated in a HoodieCommit
+totalInsertRecordsWritten | Number of records inserted or converted to updates(for small file handling) in a HoodieCommit
+totalLogFilesCompacted  | Number of log files under a base file in a file group compacted
+totalLogFilesSize | Total size in bytes of all log files under a base file in a file group
+totalPartitionsWritten  | Number of partitions that took writes in a HoodieCommit
+totalRecordsWritten | Number of records written in a HoodieCommit. For inserts, it is the total numbers of records inserted. And for updates, it the total number of records in the file.
+totalScanTime | Time taken for reading and merging logblocks in a log file
+totalUpdateRecordsWritten | Number of records that got changed in a HoodieCommit
+totalUpsertTime | Time taken for Hoodie Merge
+
+These metrics can be found at org.apache.hudi.metrics.HoodieMetrics and referenced from 
+org.apache.hudi.common.model.HoodieCommitMetadata and org.apache.hudi.common.model.HoodieWriteStat