HADOOP-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class #7122

bhattmanish98 · 2024-10-17T09:04:50Z

Description of PR

JIRA: https://issues.apache.org/jira/browse/HADOOP-19311

Current Flow: We have implemented metrics collection in ABFS flow. We have created a custom AbfsBackoffMetrics and AbfsReadFooterMetrics class which stores all the metrics on the file system level. Our objective is to move away from the custom class implementation and use IOStatisticsStore to store the metrics which is present in hadoop-common.

Changes Made: This PR contains the changes related to storing metrics related to above mentioned classes in IOStatisticStore which is present in hadoop-common. AbstractAbfsStatisticsSource abstract class is created which is implementing IOStatisticsSource interface. This will store IOStatistics of the child metrics class.

Both AbfsBackoffMetrics and AbfsReadFooterMetrics is inheriting AbstractAbfsStatisticsSource and store the respective metrics in IOStatisticsStore.

anmolanmol1234 · 2024-11-20T12:13:51Z

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

+  private void getRetryMetrics(StringBuilder metricBuilder) {
+    for (RetryValue retryCount : RETRY_LIST) {
+      long totalRequests = getMetricValue(TOTAL_REQUESTS, retryCount);
+      metricBuilder.append("$RCTSI$_").append(retryCount.getValue())


we can create a separate constants file for all these acronyms to make it easier to modify if needed later

+1

All these constants are used specifically for Metric work. They qualify to be added into MetricConstants class. It make sesne to retain that class and add all these constants there itself.

anmolanmol1234 · 2024-11-20T12:15:58Z

...hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsReadFooterMetrics.java

@@ -242,68 +243,104 @@ public void updateMap(String filePathIdentifier) {
     * @param nextReadPos the position of the next read
     */
    public void checkMetricUpdate(final String filePathIdentifier, final int len, final long contentLength, final long nextReadPos) {


nit: (optional) method can be renamed to updateReadMetrics

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/utils/StringUtils.java

anujmodi2021

Please update the account setting template file to add the required configs to be added to run the tests related to metrics,

Also add the test results for All combinations

manika137 · 2024-11-27T03:55:30Z

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

+  8.TR :- Total number of requests which were made
+  9.MRC :- Max retry count across all requests
+   */
+  private void getMmaMetrics(StringBuilder metricBuilder) {


This function would only be catering to the backoff or sleep time (like mentioned above for MMA) or the number of requests as well (like here in the function)?

...adoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/services/TestAbfsBackoffMetrics.java

bhattmanish98 · 2024-12-11T12:43:17Z

============================================================
HNS-OAuth

[WARNING] Tests run: 166, Failures: 0, Errors: 0, Skipped: 4
[WARNING] Tests run: 653, Failures: 0, Errors: 0, Skipped: 83
[WARNING] Tests run: 171, Failures: 0, Errors: 0, Skipped: 25
[WARNING] Tests run: 262, Failures: 0, Errors: 0, Skipped: 23

============================================================
HNS-SharedKey

[WARNING] Tests run: 166, Failures: 0, Errors: 0, Skipped: 5
[WARNING] Tests run: 653, Failures: 0, Errors: 0, Skipped: 35
[WARNING] Tests run: 171, Failures: 0, Errors: 0, Skipped: 25
[WARNING] Tests run: 262, Failures: 0, Errors: 0, Skipped: 10

============================================================
NonHNS-SharedKey

[WARNING] Tests run: 166, Failures: 0, Errors: 0, Skipped: 12
[WARNING] Tests run: 637, Failures: 0, Errors: 0, Skipped: 278
[WARNING] Tests run: 171, Failures: 0, Errors: 0, Skipped: 27
[WARNING] Tests run: 262, Failures: 0, Errors: 0, Skipped: 11

============================================================
AppendBlob-HNS-OAuth

[WARNING] Tests run: 166, Failures: 0, Errors: 0, Skipped: 4
[WARNING] Tests run: 653, Failures: 0, Errors: 0, Skipped: 85
[WARNING] Tests run: 171, Failures: 0, Errors: 0, Skipped: 49
[WARNING] Tests run: 262, Failures: 0, Errors: 0, Skipped: 23

anujmodi2021

Thanks for the recent changes, design looks simpler now.
Added a few more minor comments. Rest looks good to me.

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsCountersImpl.java

anujmodi2021 · 2024-12-17T04:00:03Z

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/enums/RetryValue.java

+package org.apache.hadoop.fs.azurebfs.enums;
+
+/**
+ * Enum for retry values.


We can also add where these are used, i.e. Metrics

anujmodi2021 · 2024-12-17T04:00:25Z

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/enums/FileType.java

+ */
+
+package org.apache.hadoop.fs.azurebfs.enums;
+


Javadoc for class and where/how it is used

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

anujmodi2021 · 2024-12-17T04:04:12Z

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

+  private void getRetryMetrics(StringBuilder metricBuilder) {
+    for (RetryValue retryCount : RETRY_LIST) {
+      long totalRequests = getMetricValue(TOTAL_REQUESTS, retryCount);
+      metricBuilder.append("$RCTSI$_").append(retryCount.getValue())


+1

All these constants are used specifically for Metric work. They qualify to be added into MetricConstants class. It make sesne to retain that class and add all these constants there itself.

...adoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/enums/AbfsReadFooterMetricsEnum.java

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

anujmodi2021 · 2024-12-17T04:16:15Z

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

+
+      if (totalRequests > 0) {
+        metricBuilder.append("$MMA$_").append(retryCount.getValue())
+                .append("R=").append(format(DOUBLE_PRECISION_FORMAT, (double) getMetricValue(MIN_BACK_OFF, retryCount) / THOUSAND)).append("s")


Here I was suggesting we can move the logic to format the value iside getMetricValue() method itself.
We can have an overloaded getMetricValue(metric, rertyValue, precision) which will first internally call the original getMetricValue(metric, retryValue) and convert that based on precision.

This will simplify these redundant code lines.

...-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/statistics/package-info.java

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsCountersImpl.java

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java

...hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsReadFooterMetrics.java

hadoop-yetus · 2024-12-17T14:32:46Z

🎊 +1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	12m 50s		Docker mode activated.
			_ Prechecks _
+1 💚	dupname	0m 1s		No case conflicting files found.
+0 🆗	codespell	0m 0s		codespell was not available.
+0 🆗	detsecrets	0m 0s		detect-secrets was not available.
+1 💚	@author	0m 0s		The patch does not contain any @author tags.
+1 💚	test4tests	0m 0s		The patch appears to include 5 new or modified test files.
			_ trunk Compile Tests _
+1 💚	mvninstall	36m 55s		trunk passed
+1 💚	compile	0m 39s		trunk passed with JDK Ubuntu-11.0.25+9-post-Ubuntu-1ubuntu120.04
+1 💚	compile	0m 36s		trunk passed with JDK Private Build-1.8.0_432-8u432-ga~~us1-0ubuntu2~~20.04-ga
+1 💚	checkstyle	0m 35s		trunk passed
+1 💚	mvnsite	0m 40s		trunk passed
+1 💚	javadoc	0m 45s		trunk passed with JDK Ubuntu-11.0.25+9-post-Ubuntu-1ubuntu120.04
+1 💚	javadoc	0m 34s		trunk passed with JDK Private Build-1.8.0_432-8u432-ga~~us1-0ubuntu2~~20.04-ga
+1 💚	spotbugs	1m 12s		trunk passed
+1 💚	shadedclient	33m 8s		branch has no errors when building and testing our client artifacts.
-0 ⚠️	patch	33m 29s		Used diff version of patch file. Binary files and potentially other changes not applied. Please rebase and squash commits if necessary.
			_ Patch Compile Tests _
+1 💚	mvninstall	0m 28s		the patch passed
+1 💚	compile	0m 31s		the patch passed with JDK Ubuntu-11.0.25+9-post-Ubuntu-1ubuntu120.04
+1 💚	javac	0m 31s		the patch passed
+1 💚	compile	0m 27s		the patch passed with JDK Private Build-1.8.0_432-8u432-ga~~us1-0ubuntu2~~20.04-ga
+1 💚	javac	0m 27s		the patch passed
+1 💚	blanks	0m 0s		The patch has no blanks issues.
+1 💚	checkstyle	0m 19s		the patch passed
+1 💚	mvnsite	0m 30s		the patch passed
+1 💚	javadoc	0m 28s		the patch passed with JDK Ubuntu-11.0.25+9-post-Ubuntu-1ubuntu120.04
+1 💚	javadoc	0m 26s		the patch passed with JDK Private Build-1.8.0_432-8u432-ga~~us1-0ubuntu2~~20.04-ga
+1 💚	spotbugs	1m 4s		the patch passed
+1 💚	shadedclient	32m 31s		patch has no errors when building and testing our client artifacts.
			_ Other Tests _
+1 💚	unit	2m 37s		hadoop-azure in the patch passed.
+1 💚	asflicense	0m 37s		The patch does not generate ASF License warnings.
		129m 15s

Subsystem	Report/Notes
Docker	ClientAPI=1.47 ServerAPI=1.47 base: https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-7122/20/artifact/out/Dockerfile
GITHUB PR	#7122
JIRA Issue	HADOOP-19311
Optional Tests	dupname asflicense compile javac javadoc mvninstall mvnsite unit shadedclient spotbugs checkstyle codespell detsecrets
uname	Linux 1289fe3943d9 5.15.0-126-generic #136-Ubuntu SMP Wed Nov 6 10:38:22 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/bin/hadoop.sh
git revision	trunk / `bd4b131`
Default Java	Private Build-1.8.0_432-8u432-ga~~us1-0ubuntu2~~20.04-ga
Multi-JDK versions	/usr/lib/jvm/java-11-openjdk-amd64:Ubuntu-11.0.25+9-post-Ubuntu-1ubuntu120.04 /usr/lib/jvm/java-8-openjdk-amd64:Private Build-1.8.0_432-8u432-ga~~us1-0ubuntu2~~20.04-ga
Test Results	https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-7122/20/testReport/
Max. process+thread count	552 (vs. ulimit of 5500)
modules	C: hadoop-tools/hadoop-azure U: hadoop-tools/hadoop-azure
Console output	https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-7122/20/console
versions	git=2.25.1 maven=3.6.3 spotbugs=4.2.2
Powered by	Apache Yetus 0.14.0 https://yetus.apache.org

This message was automatically generated.

manishbhatt added 7 commits September 16, 2024 00:43

AbfsBackoffMetrics new implementation

f2e8409

ABFS Backoff metrics sample usecase implementation

10906cd

ABFS Backoff metrics using IOStatistics

db9ec05

AbfsBackoff metrics changes

6531e83

Move AbfsBackoffMetrics to service directory

7c6e0ff

Hadoop-19311 Abfs Backoff and read footer metrics using IOStatistics

b7f7fbe

Added license to newly added file

dabc171

bhattmanish98 marked this pull request as draft October 17, 2024 09:04

github-actions bot added trunk TOOLS ABFS labels Oct 17, 2024

manishbhatt added 3 commits October 17, 2024 02:12

pulled latest trunk code

3692134

Revert AbfsClient changes

c24f0eb

Abfs Client format fix

8a87b39

This comment was marked as outdated.

Sign in to view

Files refactor

fcaf09f

This comment was marked as outdated.

Sign in to view

Fix checkstyle and added license

04c45a6

This comment was marked as outdated.

Sign in to view

Fix checkstyle errors

53b6623

This comment was marked as outdated.

Sign in to view

Added java doc for each classes and methods

231a434

This comment was marked as outdated.

Sign in to view

Added test case for back off metrics

e56e2e0

This comment was marked as outdated.

Sign in to view

Fix magic value checkstyle error

dfbc356

This comment was marked as outdated.

Sign in to view

abfs client unnecessary changes reverted

26ec83e

This comment was marked as outdated.

Sign in to view

anmolanmol1234 reviewed Nov 20, 2024

View reviewed changes

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/utils/StringUtils.java Outdated Show resolved Hide resolved

apache deleted a comment from hadoop-yetus Nov 25, 2024

anujmodi2021 requested changes Nov 25, 2024

View reviewed changes

manika137 reviewed Nov 27, 2024

View reviewed changes

...adoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/services/TestAbfsBackoffMetrics.java Outdated Show resolved Hide resolved

manishbhatt added 3 commits December 8, 2024 23:15

Merged latest trunk code

24e49f8

Changes based on comments given

f636f41

Use of Mean statistics in read footer metrics

154a4ae

This comment was marked as outdated.

Sign in to view

Rename update read method name

7d80bd2

This comment was marked as outdated.

Sign in to view

manishbhatt added 2 commits December 10, 2024 04:08

Fixed test cases and checkstyle failures

4feaac7

Read Length correction in test case

bc6f9cb

This comment was marked as outdated.

Sign in to view

Added metrics config in account template

98c8716

This comment was marked as outdated.

Sign in to view

bhattmanish98 requested a review from anujmodi2021 December 12, 2024 06:13

bhattmanish98 changed the title ~~Hadoop-19311. [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class~~ Hadoop-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class Dec 17, 2024

bhattmanish98 changed the title ~~Hadoop-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class~~ HADOOP-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class Dec 17, 2024

anujmodi2021 requested changes Dec 17, 2024

View reviewed changes

anmolanmol1234 reviewed Dec 17, 2024

View reviewed changes

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsCountersImpl.java Show resolved Hide resolved

anmolanmol1234 reviewed Dec 17, 2024

View reviewed changes

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java Show resolved Hide resolved

anmolanmol1234 reviewed Dec 17, 2024

View reviewed changes

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java Outdated Show resolved Hide resolved

anmolanmol1234 reviewed Dec 17, 2024

View reviewed changes

...ls/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsBackoffMetrics.java Show resolved Hide resolved

anmolanmol1234 reviewed Dec 17, 2024

View reviewed changes

...hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsReadFooterMetrics.java Show resolved Hide resolved

Move constant to metrics constant file

bd4b131

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HADOOP-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class #7122

HADOOP-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class #7122

bhattmanish98 commented Oct 17, 2024 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

anmolanmol1234 Nov 20, 2024

anujmodi2021 Dec 17, 2024

anmolanmol1234 Nov 20, 2024

anujmodi2021 left a comment

manika137 Nov 27, 2024

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

bhattmanish98 commented Dec 11, 2024

This comment was marked as outdated.

anujmodi2021 left a comment

anujmodi2021 Dec 17, 2024

anujmodi2021 Dec 17, 2024

anujmodi2021 Dec 17, 2024

anujmodi2021 Dec 17, 2024

hadoop-yetus commented Dec 17, 2024

		*/

		package org.apache.hadoop.fs.azurebfs.enums;

HADOOP-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class #7122

Are you sure you want to change the base?

HADOOP-19311: [ABFS] Implement Backoff and Read Footer metrics using IOStatistics Class #7122

Conversation

bhattmanish98 commented Oct 17, 2024 • edited Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anujmodi2021 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

bhattmanish98 commented Dec 11, 2024

============================================================ HNS-OAuth

============================================================ HNS-SharedKey

============================================================ NonHNS-SharedKey

============================================================ AppendBlob-HNS-OAuth

This comment was marked as outdated.

anujmodi2021 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hadoop-yetus commented Dec 17, 2024

bhattmanish98 commented Oct 17, 2024 •

edited

Loading

============================================================
HNS-OAuth

============================================================
HNS-SharedKey

============================================================
NonHNS-SharedKey

============================================================
AppendBlob-HNS-OAuth