ctubbsii commented on a change in pull request #1381: Update gc metrics reporting to use hadoop metrics2 URL: https://github.com/apache/accumulo/pull/1381#discussion_r331254209
########## File path: server/gc/src/main/java/org/apache/accumulo/gc/metrics2/package-info.java ########## @@ -0,0 +1,34 @@ +/* + * 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. + */ +package org.apache.accumulo.gc.metrics2; + +/** + * This package contains classes to publish Accumulo Garbage Collection run cycle statistics to the + * hadoop metrics2 system. The hadoop metrics2 system publishes to jmx and can be configured, via a + * configuration file, to publish to other metric collection systems (files,...) + * <p> + * Accumulo will search for a file named hadoop-metrics2-accumulo.properties on the Accumulo + * classpath. + * <p> + * A note on naming: The naming for jmx vs the metrics2 systems are slightly different. Hadoop + * metrics2 records will start with CONTEXT.RECORD (accgc.AccGcCycleMetrics). The value for context + * is also used by the configuration file for sink configuration. + * <p> + * In JMX, the hierarchy is: Hadoop..Accumulo..[jmxName]..[processName]..attributes..[name] + * <p> + * For jvm metrics, the hierarchy is Hadoop..Accumulo..JvmMetrics..attributes..[name] + */ Review comment: Rather than a `package-info.java` file, some of this info might be more useful as a class-level javadoc on `server/base/src/main/java/org/apache/accumulo/server/metrics/Metrics.java`, and the remaining would probably be useful on either `GcMetrics` or `GcMetricsFactory`. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
