-
Notifications
You must be signed in to change notification settings - Fork 615
HDDS-15333. Expose volume and bucket utilization metrics on OM /prom #10576
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
prathmesh12-coder
wants to merge
2
commits into
apache:master
Choose a base branch
from
prathmesh12-coder:HDDS-15333
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+247
−5
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
135 changes: 135 additions & 0 deletions
135
...zone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/VolumeUtilizationMetrics.java
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,135 @@ | ||
| /* | ||
| * 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.ozone.om; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Iterator; | ||
| import java.util.Map; | ||
| import java.util.Map.Entry; | ||
| import org.apache.hadoop.hdds.annotation.InterfaceAudience; | ||
| import org.apache.hadoop.hdds.utils.db.cache.CacheKey; | ||
| import org.apache.hadoop.hdds.utils.db.cache.CacheValue; | ||
| import org.apache.hadoop.metrics2.MetricsCollector; | ||
| import org.apache.hadoop.metrics2.MetricsInfo; | ||
| import org.apache.hadoop.metrics2.MetricsSource; | ||
| import org.apache.hadoop.metrics2.MetricsSystem; | ||
| import org.apache.hadoop.metrics2.annotation.Metrics; | ||
| import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem; | ||
| import org.apache.hadoop.ozone.OzoneConsts; | ||
| import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; | ||
| import org.apache.hadoop.ozone.om.helpers.OmVolumeArgs; | ||
|
|
||
| /** | ||
| * A class for collecting and reporting volume utilization metrics. | ||
| * <p> | ||
| * Available metrics: | ||
| * <ul> | ||
| * <li>Volume quota in bytes. | ||
| * <li>Volume used bytes (aggregated from all buckets in the volume). | ||
| * <li>Volume available bytes. Calculated from difference between volume quota and used bytes. | ||
| * If volume quota is not set then this metric shows -1 as value. | ||
| * <li>Volume quota in namespace (maximum number of buckets). | ||
| * <li>Volume used namespace (current number of buckets). | ||
| * </ul> | ||
| */ | ||
| @InterfaceAudience.Private | ||
| @Metrics(about = "Ozone Volume Utilization Metrics", context = OzoneConsts.OZONE) | ||
| public class VolumeUtilizationMetrics implements MetricsSource { | ||
|
|
||
| private static final String SOURCE = VolumeUtilizationMetrics.class.getSimpleName(); | ||
|
|
||
| private final OMMetadataManager metadataManager; | ||
|
|
||
| public VolumeUtilizationMetrics(OMMetadataManager metadataManager) { | ||
| this.metadataManager = metadataManager; | ||
| } | ||
|
|
||
| public static VolumeUtilizationMetrics create(OMMetadataManager metadataManager) { | ||
| MetricsSystem ms = DefaultMetricsSystem.instance(); | ||
| return ms.register(SOURCE, "Volume Utilization Metrics", new VolumeUtilizationMetrics(metadataManager)); | ||
| } | ||
|
|
||
| @Override | ||
| public void getMetrics(MetricsCollector collector, boolean all) { | ||
| Map<String, OmVolumeArgs> volumes = new HashMap<>(); | ||
| Iterator<Entry<CacheKey<String>, CacheValue<OmVolumeArgs>>> volumeIterator = metadataManager.getVolumeIterator(); | ||
| while (volumeIterator.hasNext()) { | ||
| Entry<CacheKey<String>, CacheValue<OmVolumeArgs>> entry = volumeIterator.next(); | ||
| OmVolumeArgs volumeArgs = entry.getValue().getCacheValue(); | ||
| if (volumeArgs != null) { | ||
| volumes.put(volumeArgs.getVolume(), volumeArgs); | ||
| } | ||
| } | ||
|
|
||
| Map<String, Long> usedBytesPerVolume = new HashMap<>(); | ||
| Iterator<Entry<CacheKey<String>, CacheValue<OmBucketInfo>>> bucketIterator = metadataManager.getBucketIterator(); | ||
| while (bucketIterator.hasNext()) { | ||
| Entry<CacheKey<String>, CacheValue<OmBucketInfo>> entry = bucketIterator.next(); | ||
| OmBucketInfo bucketInfo = entry.getValue().getCacheValue(); | ||
| if (bucketInfo == null) { | ||
| continue; | ||
| } | ||
| usedBytesPerVolume.merge(bucketInfo.getVolumeName(), bucketInfo.getUsedBytes(), Long::sum); | ||
| } | ||
|
|
||
| for (OmVolumeArgs volumeArgs : volumes.values()) { | ||
| long quotaInBytes = volumeArgs.getQuotaInBytes(); | ||
| long usedBytes = usedBytesPerVolume.getOrDefault(volumeArgs.getVolume(), 0L); | ||
| long availableBytes; | ||
| if (quotaInBytes == -1) { | ||
| availableBytes = -1; | ||
| } else { | ||
| availableBytes = Math.max(quotaInBytes - usedBytes, 0); | ||
| } | ||
|
|
||
| collector.addRecord(SOURCE) | ||
| .setContext("Volume metrics") | ||
| .tag(VolumeMetricsInfo.VolumeName, volumeArgs.getVolume()) | ||
| .addGauge(VolumeMetricsInfo.VolumeQuotaBytes, quotaInBytes) | ||
| .addGauge(VolumeMetricsInfo.VolumeUsedBytes, usedBytes) | ||
| .addGauge(VolumeMetricsInfo.VolumeAvailableBytes, availableBytes) | ||
| .addGauge(VolumeMetricsInfo.VolumeQuotaNamespace, volumeArgs.getQuotaInNamespace()) | ||
| .addGauge(VolumeMetricsInfo.VolumeUsedNamespace, volumeArgs.getUsedNamespace()); | ||
| } | ||
| } | ||
|
|
||
| public void unRegister() { | ||
| MetricsSystem ms = DefaultMetricsSystem.instance(); | ||
| ms.unregisterSource(SOURCE); | ||
| } | ||
|
|
||
| enum VolumeMetricsInfo implements MetricsInfo { | ||
| VolumeName("Volume name."), | ||
| VolumeQuotaBytes("Volume quota in bytes."), | ||
| VolumeUsedBytes("Bytes used across all buckets in the volume."), | ||
| VolumeAvailableBytes("Volume available space."), | ||
| VolumeQuotaNamespace("Volume quota in namespace."), | ||
| VolumeUsedNamespace("Volume used namespace."); | ||
|
|
||
| private final String desc; | ||
|
|
||
| VolumeMetricsInfo(String desc) { | ||
| this.desc = desc; | ||
| } | ||
|
|
||
| @Override | ||
| public String description() { | ||
| return desc; | ||
| } | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
Thanks for adding these metrics. Overall these look like good additions, I just have a concern with the volume used bytes. It is not directly tracked by Ozone because volumes don't have any connection to files, only buckets. Hence the used namespace tracked per volume is just a count of number of buckets and there is no used bytes for volumes.
I think this could be aggregated with promQL outside of Ozone if needed.
cc @sumitagrawl
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.
Hi @errose28, Thanks for the feedback!
Removed the VolumeUsedBytes and VolumeAvailableBytes metrics along with the aggregation logic.