HDDS-7282. Add EstimatedKeyCount metrics for SCM DB #3791
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /* | ||
| * 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.hdds.scm.metadata; | ||
|
|
||
| import org.apache.commons.text.WordUtils; | ||
| import org.apache.hadoop.hdds.utils.db.DBColumnFamilyDefinition; | ||
| import org.apache.hadoop.metrics2.MetricsCollector; | ||
| import org.apache.hadoop.metrics2.MetricsInfo; | ||
| import org.apache.hadoop.metrics2.MetricsRecordBuilder; | ||
| import org.apache.hadoop.metrics2.MetricsSource; | ||
| import org.apache.hadoop.metrics2.annotation.Metrics; | ||
| import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem; | ||
| import org.apache.hadoop.metrics2.lib.Interns; | ||
| import org.apache.hadoop.metrics2.lib.MetricsRegistry; | ||
| import org.apache.hadoop.ozone.OzoneConsts; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Class contains metrics related to SCM Metadata Store. | ||
| */ | ||
| @Metrics(about = "SCM Metadata Store Metrics", context = OzoneConsts.OZONE) | ||
| public final class SCMMetadataStoreMetrics implements MetricsSource { | ||
|
|
||
| public static final String METRICS_SOURCE_NAME = | ||
| SCMMetadataStoreMetrics.class.getSimpleName(); | ||
|
|
||
| private static final MetricsInfo ESTIMATED_KEY_COUNT = Interns.info( | ||
| "EstimatedKeyCount", | ||
| "Tracked estimated key count of all column families"); | ||
|
|
||
| private static final Map<String, MetricsInfo> ESTIMATED_KEY_COUNT_METRICS | ||
| = Collections.unmodifiableMap(new LinkedHashMap<String, MetricsInfo>() {{ | ||
| for (DBColumnFamilyDefinition<?, ?> table: | ||
| SCMMetadataStoreImpl.COLUMN_FAMILIES) { | ||
| String name = WordUtils.capitalize(table.getName()); | ||
| String metric = name + "EstimatedKeyCount"; | ||
| String description = "Estimated key count in table of " + name; | ||
| put(table.getName(), Interns.info(metric, description)); | ||
| } | ||
| }}); | ||
|
|
||
| private MetricsRegistry registry; | ||
|
|
||
| private SCMMetadataStoreImpl scmMetadataStore; | ||
|
|
||
| public SCMMetadataStoreMetrics(SCMMetadataStoreImpl scmMetadataStoreImpl) { | ||
| this.registry = new MetricsRegistry(METRICS_SOURCE_NAME); | ||
| this.scmMetadataStore = scmMetadataStoreImpl; | ||
| } | ||
|
|
||
| public static SCMMetadataStoreMetrics create(SCMMetadataStoreImpl | ||
| scmMetadataStore) { | ||
| return DefaultMetricsSystem.instance().register(METRICS_SOURCE_NAME, | ||
| "SCM Metadata store related metrics", | ||
| new SCMMetadataStoreMetrics(scmMetadataStore)); | ||
| } | ||
|
|
||
| @Override | ||
| public void getMetrics(MetricsCollector collector, boolean all) { | ||
| MetricsRecordBuilder builder = collector.addRecord(METRICS_SOURCE_NAME) | ||
| .tag(ESTIMATED_KEY_COUNT, scmMetadataStore.getEstimatedKeyCountStr()); | ||
|
|
||
| for (Map.Entry<String, MetricsInfo> e : | ||
| ESTIMATED_KEY_COUNT_METRICS.entrySet()) { | ||
| long count = 0L; | ||
| try { | ||
| count = scmMetadataStore.getTableMap().get(e.getKey()) | ||
| .getEstimatedKeyCount(); | ||
| } catch (IOException exception) { | ||
| // Ignore exception here. | ||
|
Contributor
There was a problem hiding this comment. We should probably log exceptions here rather than totally ignore them. |
||
| } | ||
| builder.addGauge(e.getValue(), count); | ||
| } | ||
|
|
||
|
|
||
| } | ||
|
|
||
| public void unRegister() { | ||
| DefaultMetricsSystem.instance().unregisterSource(METRICS_SOURCE_NAME); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /** | ||
| * 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.hadoop.hdds.scm.metadata; | ||
|
|
||
| import org.apache.hadoop.hdds.conf.OzoneConfiguration; | ||
| import org.apache.hadoop.ozone.container.common.SCMTestUtils; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
|
|
||
| import static org.apache.hadoop.test.MetricsAsserts.getLongGauge; | ||
| import static org.apache.hadoop.test.MetricsAsserts.getMetrics; | ||
|
|
||
|
|
||
| /** | ||
| * Testing of SCMMetadataStoreImpl. | ||
| */ | ||
| public class TestSCMMetadataStoreImpl { | ||
| private OzoneConfiguration conf; | ||
| private SCMMetadataStore scmMetadataStore; | ||
|
|
||
| @BeforeEach | ||
| public void setUp(@TempDir Path tempDir) throws Exception { | ||
| conf = SCMTestUtils.getConf(); | ||
|
|
||
| scmMetadataStore = new SCMMetadataStoreImpl(conf); | ||
| scmMetadataStore.start(conf); | ||
| } | ||
|
|
||
| @Test | ||
| public void testEstimatedKeyCount() { | ||
| Assertions.assertTrue(((SCMMetadataStoreImpl) scmMetadataStore) | ||
| .getEstimatedKeyCountStr().contains("sequenceId : 0")); | ||
| Assertions.assertEquals(0, getGauge("SequenceIdEstimatedKeyCount")); | ||
|
|
||
| try { | ||
| scmMetadataStore.getSequenceIdTable().put("TestKey", 1L); | ||
| } catch (IOException e) { | ||
| // Ignore | ||
| } | ||
|
|
||
| Assertions.assertFalse(((SCMMetadataStoreImpl) scmMetadataStore) | ||
| .getEstimatedKeyCountStr().contains("sequenceId : 0")); | ||
| Assertions.assertEquals(1, getGauge("SequenceIdEstimatedKeyCount")); | ||
|
sodonnel marked this conversation as resolved.
|
||
| } | ||
|
|
||
| private long getGauge(String metricName) { | ||
| return getLongGauge(metricName, | ||
| getMetrics(SCMMetadataStoreMetrics.METRICS_SOURCE_NAME)); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this extra map containing all the tables? They are already stored in the tableMap, so we can iterate it to list out all the tables.
My concern is that if someone later adds a new table, they can easily miss adding it to this map, and then the metric will not automatically appear.
If we drive it off the tableMap, then there is nothing special to do around metrics when adding a new table.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be necessary, when I use the tableMap from the StoreImpl, the metrics class will invoke NullPointerException.