zhangmeng916 commented on a change in pull request #1187: URL: https://github.com/apache/helix/pull/1187#discussion_r466845143
########## File path: helix-core/src/main/java/org/apache/helix/monitoring/mbeans/CustomizedViewMonitor.java ########## @@ -0,0 +1,145 @@ +package org.apache.helix.monitoring.mbeans; + +/* + * 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. + */ + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.concurrent.TimeUnit; +import javax.management.JMException; +import javax.management.MalformedObjectNameException; +import javax.management.ObjectName; + +import com.codahale.metrics.Histogram; +import com.codahale.metrics.SlidingTimeWindowArrayReservoir; +import org.apache.helix.model.CustomizedView; +import org.apache.helix.model.Partition; +import org.apache.helix.monitoring.mbeans.dynamicMBeans.DynamicMBeanProvider; +import org.apache.helix.monitoring.mbeans.dynamicMBeans.DynamicMetric; +import org.apache.helix.monitoring.mbeans.dynamicMBeans.HistogramDynamicMetric; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class CustomizedViewMonitor extends DynamicMBeanProvider { + private static final Logger LOG = LoggerFactory.getLogger(CustomizedViewMonitor.class); + + private static final String MBEAN_DESCRIPTION = "Helix Customized View Aggregation Monitor"; + private final String _clusterName; + private final String _sensorName; + private HistogramDynamicMetric _updateToAggregationLatencyGauge; + public static final String UPDATE_TO_AGGREGATION_LATENCY_GAUGE = + "UpdateToAggregationLatencyGauge"; + + public CustomizedViewMonitor(String clusterName) { + _clusterName = clusterName; + _sensorName = String.format("%s.%s", MonitorDomainNames.AggregatedView.name(), _clusterName); + _updateToAggregationLatencyGauge = + new HistogramDynamicMetric(UPDATE_TO_AGGREGATION_LATENCY_GAUGE, new Histogram( + new SlidingTimeWindowArrayReservoir(getResetIntervalInMs(), TimeUnit.MILLISECONDS))); + } + + @Override + public DynamicMBeanProvider register() throws JMException { + List<DynamicMetric<?, ?>> attributeList = new ArrayList<>(); + attributeList.add(_updateToAggregationLatencyGauge); + doRegister(attributeList, MBEAN_DESCRIPTION, getMBeanName()); + return this; + } + + private ObjectName getMBeanName() throws MalformedObjectNameException { + return new ObjectName(String + .format("%s:%s=%s", MonitorDomainNames.AggregatedView.name(), "Cluster", _clusterName)); + } + + @Override + public String getSensorName() { + return _sensorName; + } + + void recordUpdateToAggregationLatency(long latency) { + if (_updateToAggregationLatencyGauge != null) { + _updateToAggregationLatencyGauge.updateValue(latency); + } + } + + /** + * Find updated customized states and report the aggregation latency of each customized state + * @param updatedCustomizedViews Customized views that have been updated, obtained from CustomizedStateOutput + * @param curCustomizedViews Current customized view values from the CustomizedViewCache + * @param updatedStartTimestamps All customized state START_TIME property values from CustomizedStateOutput + * @param updateSuccess If the customized view update to ZK is successful or not + * @param endTime The timestamp when the new customized view is updated to ZK + */ + public void reportLatency(List<CustomizedView> updatedCustomizedViews, + Map<String, CustomizedView> curCustomizedViews, + Map<String, Map<Partition, Map<String, Long>>> updatedStartTimestamps, + boolean[] updateSuccess, long endTime) { + if (updatedCustomizedViews == null || curCustomizedViews == null + || updatedStartTimestamps == null) { + LOG.warn("Cannot find updated time stamps for customized states, input parameter is null."); + return; + } + + List<Long> collectedTimestamps = new ArrayList<>(); + + for (int i = 0; i < updatedCustomizedViews.size(); i++) { + if (!updateSuccess[i]) { + continue; + } + CustomizedView newCV = updatedCustomizedViews.get(i); + String resourceName = newCV.getResourceName(); + CustomizedView oldCV = + curCustomizedViews.getOrDefault(resourceName, new CustomizedView(resourceName)); Review comment: Is getOrDefault necessary? You already new one in aggregation stage. ########## File path: helix-core/src/main/java/org/apache/helix/controller/stages/CustomizedViewAggregationStage.java ########## @@ -112,14 +115,18 @@ public void execute(final ClusterEvent event) throws Exception { } // add/update customized-views from zk and cache if (updatedCustomizedViews.size() > 0) { - dataAccessor.setChildren(keys, updatedCustomizedViews); + boolean[] success = dataAccessor.setChildren(keys, updatedCustomizedViews); Review comment: Can we log somewhere how many updates are failed? It's useful information. ########## File path: helix-core/src/test/java/org/apache/helix/controller/stages/TestCustomizedViewStage.java ########## @@ -112,4 +110,60 @@ public void testCachedCustomizedViews() throws Exception { deleteLiveInstances(clusterName); deleteCluster(clusterName); } + + @Test + public void testLatencyMetricReporting() throws Exception { + String clusterName = "CLUSTER_" + TestHelper.getTestMethodName(); + + HelixDataAccessor accessor = + new ZKHelixDataAccessor(clusterName, new ZkBaseDataAccessor<>(_gZkClient)); + HelixManager manager = new DummyClusterManager(clusterName, accessor); + + // ideal state: node0 is MASTER, node1 is SLAVE + // replica=2 means 1 master and 1 slave + setupIdealState(clusterName, new int[]{0, 1}, new String[]{"TestDB"}, 1, 2); + setupLiveInstances(clusterName, new int[]{0, 1}); + setupStateModel(clusterName); + + ClusterEvent event = new ClusterEvent(clusterName, ClusterEventType.Unknown); + ResourceControllerDataProvider cache = new ResourceControllerDataProvider(clusterName); + event.addAttribute(AttributeName.helixmanager.name(), manager); + event.addAttribute(AttributeName.ControllerDataProvider.name(), cache); + + CustomizedStateConfig config = new CustomizedStateConfig(); + List<String> aggregationEnabledTypes = new ArrayList<>(); + aggregationEnabledTypes.add(CUSTOMIZED_STATE_NAME); + config.setAggregationEnabledTypes(aggregationEnabledTypes); + + PropertyKey.Builder keyBuilder = accessor.keyBuilder(); + accessor.setProperty(keyBuilder.customizedStateConfig(), config); + + CustomizedState customizedState = new CustomizedState(RESOURCE_NAME); + customizedState.setState(PARTITION_NAME, "STATE"); + customizedState.setStartTime(PARTITION_NAME, 0); + accessor.setProperty( + keyBuilder.customizedState(INSTANCE_NAME, CUSTOMIZED_STATE_NAME, RESOURCE_NAME), + customizedState); + + Pipeline dataRefresh = new Pipeline(); + dataRefresh.addStage(new ReadClusterDataStage()); + runPipeline(event, dataRefresh); + runStage(event, new ResourceComputationStage()); + runStage(event, new CustomizedStateComputationStage()); + runStage(event, new CustomizedViewAggregationStage()); + + ObjectName objectName = new ObjectName(String + .format("%s:%s=%s", MonitorDomainNames.AggregatedView.name(), "Cluster", clusterName)); + ObjectInstance monitor = _server.getObjectInstance(objectName); + Assert.assertNotNull(monitor); + TestHelper.verify(() -> (long) _server.getAttribute(objectName, + CustomizedViewMonitor.UPDATE_TO_AGGREGATION_LATENCY_GAUGE + ".Max") != 0, + TestHelper.WAIT_DURATION); + + if (manager.isConnected()) { + manager.disconnect(); // For DummyClusterManager, this is not necessary Review comment: You commented as not 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
