adoroszlai commented on a change in pull request #3221: URL: https://github.com/apache/ozone/pull/3221#discussion_r833151308
########## File path: hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/metrics/S3GatewayMetrics.java ########## @@ -0,0 +1,321 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ +package org.apache.hadoop.ozone.s3.metrics; + +import org.apache.hadoop.hdds.annotation.InterfaceAudience; +import org.apache.hadoop.metrics2.MetricsCollector; +import org.apache.hadoop.metrics2.MetricsRecordBuilder; +import org.apache.hadoop.metrics2.MetricsSource; +import org.apache.hadoop.metrics2.MetricsSystem; +import org.apache.hadoop.metrics2.annotation.Metric; +import org.apache.hadoop.metrics2.annotation.Metrics; +import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem; +import org.apache.hadoop.metrics2.lib.MetricsRegistry; +import org.apache.hadoop.metrics2.lib.MutableCounterLong; +import org.apache.hadoop.ozone.OzoneConsts; + +/** + * This class maintains S3 Gateway related metrics. + */ [email protected] +@Metrics(about = "S3 Gateway Metrics", context = OzoneConsts.OZONE) +public final class S3GatewayMetrics implements MetricsSource { + + public static final String SOURCE_NAME = + S3GatewayMetrics.class.getSimpleName(); + + private MetricsRegistry registry; + private static S3GatewayMetrics instance; + + // BucketEndpoint + private @Metric MutableCounterLong getBucketSuccess; + private @Metric MutableCounterLong getBucketFailure; + private @Metric MutableCounterLong createBucketSuccess; + private @Metric MutableCounterLong createBucketFailure; + private @Metric MutableCounterLong headBucketSuccess; + private @Metric MutableCounterLong deleteBucketSuccess; + private @Metric MutableCounterLong deleteBucketFailure; + private @Metric MutableCounterLong getAclSuccess; + private @Metric MutableCounterLong getAclFailure; + private @Metric MutableCounterLong putAclSuccess; + private @Metric MutableCounterLong putAclFailure; + private @Metric MutableCounterLong listMultipartUploadsSuccess; + private @Metric MutableCounterLong listMultipartUploadsFailure; + + // RootEndpoint + private @Metric MutableCounterLong listS3BucketsSuccess; + private @Metric MutableCounterLong listS3BucketsFailure; + + // ObjectEndpoint + private @Metric MutableCounterLong createMultipartKeySuccess; + private @Metric MutableCounterLong createMultipartKeyFailure; + private @Metric MutableCounterLong copyObjectSuccess; + private @Metric MutableCounterLong copyObjectFailure; + private @Metric MutableCounterLong createKeySuccess; + private @Metric MutableCounterLong createKeyFailure; + private @Metric MutableCounterLong listPartsSuccess; + private @Metric MutableCounterLong listPartsFailure; + private @Metric MutableCounterLong getKeySuccess; + private @Metric MutableCounterLong getKeyFailure; + private @Metric MutableCounterLong headKeySuccess; + private @Metric MutableCounterLong headKeyFailure; + private @Metric MutableCounterLong initMultiPartUploadSuccess; + private @Metric MutableCounterLong initMultiPartUploadFailure; + private @Metric MutableCounterLong completeMultiPartUploadSuccess; + private @Metric MutableCounterLong completeMultiPartUploadFailure; + private @Metric MutableCounterLong abortMultiPartUploadSuccess; + private @Metric MutableCounterLong abortMultiPartUploadFailure; + private @Metric MutableCounterLong deleteKeySuccess; + private @Metric MutableCounterLong deleteKeyFailure; + + + /** + * Private constructor. + */ + private S3GatewayMetrics() { + this.registry = new MetricsRegistry(SOURCE_NAME); + } + + /** + * Create and returns SCMPipelineMetrics instance. + * + * @return SCMPipelineMetrics + */ + public static synchronized S3GatewayMetrics create() { + if (instance != null) { + return instance; + } + MetricsSystem ms = DefaultMetricsSystem.instance(); + instance = ms.register(SOURCE_NAME, "S3 Gateway Metrics", + new S3GatewayMetrics()); + return instance; + } + + /** + * Unregister the metrics instance. + */ + public static void unRegister() { + instance = null; + MetricsSystem ms = DefaultMetricsSystem.instance(); + ms.unregisterSource(SOURCE_NAME); + } + + @Override + @SuppressWarnings("SuspiciousMethodCalls") + public void getMetrics(MetricsCollector collector, boolean all) { + MetricsRecordBuilder recordBuilder = collector.addRecord(SOURCE_NAME); + + // BucketEndpoint + getBucketSuccess.snapshot(recordBuilder, true); + getBucketFailure.snapshot(recordBuilder, true); + createBucketSuccess.snapshot(recordBuilder, true); + createBucketFailure.snapshot(recordBuilder, true); + headBucketSuccess.snapshot(recordBuilder, true); + deleteBucketSuccess.snapshot(recordBuilder, true); + deleteBucketFailure.snapshot(recordBuilder, true); + getAclSuccess.snapshot(recordBuilder, true); + getAclFailure.snapshot(recordBuilder, true); + putAclSuccess.snapshot(recordBuilder, true); + putAclFailure.snapshot(recordBuilder, true); + listMultipartUploadsSuccess.snapshot(recordBuilder, true); + listMultipartUploadsFailure.snapshot(recordBuilder, true); + + // RootEndpoint + listS3BucketsSuccess.snapshot(recordBuilder, true); + listS3BucketsFailure.snapshot(recordBuilder, true); + + // ObjectEndpoint + createMultipartKeySuccess.snapshot(recordBuilder, true); + createMultipartKeyFailure.snapshot(recordBuilder, true); + copyObjectSuccess.snapshot(recordBuilder, true); + copyObjectFailure.snapshot(recordBuilder, true); + createKeySuccess.snapshot(recordBuilder, true); + createKeyFailure.snapshot(recordBuilder, true); + listPartsSuccess.snapshot(recordBuilder, true); + listPartsFailure.snapshot(recordBuilder, true); + getKeySuccess.snapshot(recordBuilder, true); + getKeyFailure.snapshot(recordBuilder, true); + headKeySuccess.snapshot(recordBuilder, true); + headKeyFailure.snapshot(recordBuilder, true); + initMultiPartUploadSuccess.snapshot(recordBuilder, true); + initMultiPartUploadFailure.snapshot(recordBuilder, true); + completeMultiPartUploadSuccess.snapshot(recordBuilder, true); + completeMultiPartUploadFailure.snapshot(recordBuilder, true); + abortMultiPartUploadSuccess.snapshot(recordBuilder, true); + abortMultiPartUploadFailure.snapshot(recordBuilder, true); + deleteKeySuccess.snapshot(recordBuilder, true); + deleteKeyFailure.snapshot(recordBuilder, true); + } + + // INC + public void incGetBucketSuccess() { + getBucketSuccess.incr(); + } + + public void incGetBucketFailure() { + getBucketSuccess.incr(); Review comment: Typo: ```suggestion getBucketFailure.incr(); ``` ########## File path: hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/metrics/S3GatewayMetrics.java ########## @@ -0,0 +1,321 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ +package org.apache.hadoop.ozone.s3.metrics; + +import org.apache.hadoop.hdds.annotation.InterfaceAudience; +import org.apache.hadoop.metrics2.MetricsCollector; +import org.apache.hadoop.metrics2.MetricsRecordBuilder; +import org.apache.hadoop.metrics2.MetricsSource; +import org.apache.hadoop.metrics2.MetricsSystem; +import org.apache.hadoop.metrics2.annotation.Metric; +import org.apache.hadoop.metrics2.annotation.Metrics; +import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem; +import org.apache.hadoop.metrics2.lib.MetricsRegistry; +import org.apache.hadoop.metrics2.lib.MutableCounterLong; +import org.apache.hadoop.ozone.OzoneConsts; + +/** + * This class maintains S3 Gateway related metrics. + */ [email protected] +@Metrics(about = "S3 Gateway Metrics", context = OzoneConsts.OZONE) +public final class S3GatewayMetrics implements MetricsSource { + + public static final String SOURCE_NAME = + S3GatewayMetrics.class.getSimpleName(); + + private MetricsRegistry registry; + private static S3GatewayMetrics instance; + + // BucketEndpoint + private @Metric MutableCounterLong getBucketSuccess; + private @Metric MutableCounterLong getBucketFailure; + private @Metric MutableCounterLong createBucketSuccess; + private @Metric MutableCounterLong createBucketFailure; + private @Metric MutableCounterLong headBucketSuccess; + private @Metric MutableCounterLong deleteBucketSuccess; + private @Metric MutableCounterLong deleteBucketFailure; + private @Metric MutableCounterLong getAclSuccess; + private @Metric MutableCounterLong getAclFailure; + private @Metric MutableCounterLong putAclSuccess; + private @Metric MutableCounterLong putAclFailure; + private @Metric MutableCounterLong listMultipartUploadsSuccess; + private @Metric MutableCounterLong listMultipartUploadsFailure; + + // RootEndpoint + private @Metric MutableCounterLong listS3BucketsSuccess; + private @Metric MutableCounterLong listS3BucketsFailure; + + // ObjectEndpoint + private @Metric MutableCounterLong createMultipartKeySuccess; + private @Metric MutableCounterLong createMultipartKeyFailure; + private @Metric MutableCounterLong copyObjectSuccess; + private @Metric MutableCounterLong copyObjectFailure; + private @Metric MutableCounterLong createKeySuccess; + private @Metric MutableCounterLong createKeyFailure; + private @Metric MutableCounterLong listPartsSuccess; + private @Metric MutableCounterLong listPartsFailure; + private @Metric MutableCounterLong getKeySuccess; + private @Metric MutableCounterLong getKeyFailure; + private @Metric MutableCounterLong headKeySuccess; + private @Metric MutableCounterLong headKeyFailure; + private @Metric MutableCounterLong initMultiPartUploadSuccess; + private @Metric MutableCounterLong initMultiPartUploadFailure; + private @Metric MutableCounterLong completeMultiPartUploadSuccess; + private @Metric MutableCounterLong completeMultiPartUploadFailure; + private @Metric MutableCounterLong abortMultiPartUploadSuccess; + private @Metric MutableCounterLong abortMultiPartUploadFailure; + private @Metric MutableCounterLong deleteKeySuccess; + private @Metric MutableCounterLong deleteKeyFailure; + + + /** + * Private constructor. + */ + private S3GatewayMetrics() { + this.registry = new MetricsRegistry(SOURCE_NAME); + } + + /** + * Create and returns SCMPipelineMetrics instance. + * + * @return SCMPipelineMetrics + */ + public static synchronized S3GatewayMetrics create() { + if (instance != null) { + return instance; + } + MetricsSystem ms = DefaultMetricsSystem.instance(); + instance = ms.register(SOURCE_NAME, "S3 Gateway Metrics", + new S3GatewayMetrics()); + return instance; + } + + /** + * Unregister the metrics instance. + */ + public static void unRegister() { + instance = null; + MetricsSystem ms = DefaultMetricsSystem.instance(); + ms.unregisterSource(SOURCE_NAME); + } + + @Override + @SuppressWarnings("SuspiciousMethodCalls") Review comment: Is this `SuppressWarnings` necessary? -- 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]
