[GitHub] [hadoop] aimiebell commented on a change in pull request #2675: HADOOP-17511. Add audit/telemetry logging to S3A connector

[GitBox <gi...@apache.org>]

aimiebell commented on a change in pull request #2675:
URL: https://github.com/apache/hadoop/pull/2675#discussion_r572623035



##########
File path: hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AFileSystem.java
##########
@@ -1789,15 +1949,22 @@ public boolean allowAuthoritative(final Path p) {
 
   /**
    * Low-level call to get at the object metadata.
+   * This is used outside the codebase in one or two places, so
+   * is tagged as limited private.
+   * It declares itself to be get file status audit span.
    * @param path path to the object. This will be qualified.
    * @return metadata
    * @throws IOException IO and object access problems.
    */
   @VisibleForTesting
+  @InterfaceAudience.LimitedPrivate("utilities")

Review comment:
       I detect that this code is problematic. According to the [Bad practice (BAD_PRACTICE)](https://spotbugs.readthedocs.io/en/stable/bugDescriptions.html#bad-practice-bad-practice), [Nm: Method names should start with a lower case letter (NM_METHOD_NAMING_CONVENTION)](https://spotbugs.readthedocs.io/en/stable/bugDescriptions.html#nm-method-names-should-start-with-a-lower-case-letter-nm-method-naming-convention).
   Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.
   




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org