keith-turner commented on code in PR #4459: URL: https://github.com/apache/accumulo/pull/4459#discussion_r1572506357
########## core/src/main/java/org/apache/accumulo/core/spi/metrics/MeterRegistryFactory.java: ########## @@ -0,0 +1,62 @@ +/* + * 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 + * + * https://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.core.spi.metrics; + +import java.util.Map; + +import org.apache.accumulo.core.spi.common.ServiceEnvironment; + +import io.micrometer.core.instrument.MeterRegistry; + +/** + * The Micrometer metrics allows for different monitoring systems. and can be enabled within + * Accumulo with properties and are initialized by implementing this interface and providing the + * factory implementation clas name as a property. Metrics are specified with the following + * properties: + * <p> + * Property.GENERAL_MICROMETER_ENABLED = true + * <p> + * Property.GENERAL_MICROMETER_FACTORY = [implementation].class.getName() + */ +public interface MeterRegistryFactory { + // full form in property file is "general.custom.metrics.opts" + String METRICS_PROP_SUBSTRING = "metrics.opts."; Review Comment: This will be part of the SPI, would be good to add javadoc explaining how someone could use it. ########## core/src/main/java/org/apache/accumulo/core/spi/metrics/SimpleLoggingMeterRegistryFactory.java: ########## @@ -0,0 +1,95 @@ +/* + * 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 + * + * https://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.core.spi.metrics; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.function.Consumer; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.logging.LoggingMeterRegistry; +import io.micrometer.core.instrument.logging.LoggingRegistryConfig; + +/** + * Example implementation of enabling a metrics provider by implementing the + * {@link org.apache.accumulo.core.spi.metrics.MeterRegistryFactory} interface. When enabled though + * properties by enabling {@code Property.GENERAL_MICROMETER_ENABLED} and providing this class for + * the {@code Property.GENERAL_MICROMETER_FACTORY} + * <p> + * The metrics will appear in the normal service logs with a named logger of + * {@code org.apache.accumulo.METRICS} at the INFO level. The metrics output can be directed to a + * file using standard logging configuration properties by configuring the log4j2-service.properties + * file. + * <p> + * The update frequency can be adjusted by setting {@code general.custom.metrics.opts.logging.step} + * in the Accumulo configuration. The default is 60 sec. + * + */ +public class SimpleLoggingMeterRegistryFactory implements MeterRegistryFactory { Review Comment: This is a subjective comment feel free to ignore. ```suggestion public class LoggingMeterRegistryFactory implements MeterRegistryFactory { ``` ########## core/src/main/java/org/apache/accumulo/core/spi/metrics/SimpleLoggingMeterRegistryFactory.java: ########## @@ -0,0 +1,95 @@ +/* + * 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 + * + * https://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.core.spi.metrics; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.function.Consumer; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.logging.LoggingMeterRegistry; +import io.micrometer.core.instrument.logging.LoggingRegistryConfig; + +/** + * Example implementation of enabling a metrics provider by implementing the + * {@link org.apache.accumulo.core.spi.metrics.MeterRegistryFactory} interface. When enabled though + * properties by enabling {@code Property.GENERAL_MICROMETER_ENABLED} and providing this class for + * the {@code Property.GENERAL_MICROMETER_FACTORY} + * <p> + * The metrics will appear in the normal service logs with a named logger of + * {@code org.apache.accumulo.METRICS} at the INFO level. The metrics output can be directed to a + * file using standard logging configuration properties by configuring the log4j2-service.properties + * file. + * <p> + * The update frequency can be adjusted by setting {@code general.custom.metrics.opts.logging.step} + * in the Accumulo configuration. The default is 60 sec. + * + */ +public class SimpleLoggingMeterRegistryFactory implements MeterRegistryFactory { + + private static final Logger LOG = + LoggerFactory.getLogger(SimpleLoggingMeterRegistryFactory.class); + + // named logger that can be configured using standard logging properties. + private static final Logger METRICS = LoggerFactory.getLogger("org.apache.accumulo.METRICS"); Review Comment: Why is the last part of the logger name all caps? ########## core/src/main/java/org/apache/accumulo/core/spi/metrics/MeterRegistryFactory.java: ########## @@ -0,0 +1,62 @@ +/* + * 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 + * + * https://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.core.spi.metrics; + +import java.util.Map; + +import org.apache.accumulo.core.spi.common.ServiceEnvironment; + +import io.micrometer.core.instrument.MeterRegistry; + +/** + * The Micrometer metrics allows for different monitoring systems. and can be enabled within + * Accumulo with properties and are initialized by implementing this interface and providing the + * factory implementation clas name as a property. Metrics are specified with the following + * properties: + * <p> + * Property.GENERAL_MICROMETER_ENABLED = true + * <p> + * Property.GENERAL_MICROMETER_FACTORY = [implementation].class.getName() + */ Review Comment: ```suggestion */ ``` ```suggestion * @since 2.1.3 */ ``` -- 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: notifications-unsubscr...@accumulo.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
