Add support for tracking Hadoop and GCS API level metrics at a thread… #1299
There are no files selected for viewing
This file contains 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 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 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,125 @@ | ||
| /* | ||
| * Copyright 2025 Google Inc. | ||
| * | ||
| * Licensed 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 com.google.cloud.hadoop.fs.gcs; | ||
|
|
||
| import static com.google.cloud.hadoop.fs.gcs.GhfsStatistic.GCS_CONNECTOR_TIME; | ||
|
|
||
| import com.google.cloud.hadoop.gcsio.GoogleCloudStorageStatistics; | ||
| import java.util.HashMap; | ||
| import java.util.Iterator; | ||
| import java.util.Map; | ||
| import org.apache.hadoop.fs.StorageStatistics; | ||
|
|
||
| class GhfsThreadLocalStatistics extends StorageStatistics { | ||
| static final String NAME = "GhfsThreadLocalStatistics"; | ||
| static final String HADOOP_API_COUNT = "hadoopApiCount"; | ||
|
There was a problem hiding this comment. Enum would be better to represent this I think. So ThreadLocalValue and corresponding strings stay together and not set different one by mistake. There was a problem hiding this comment. Same as above. The consumer framework is not aware of the enums and will have to use string to adhere to the interface. |
||
| static final String HADOOP_API_TIME = "hadoopApiTime"; | ||
| static final String GCS_API_COUNT = "gcsApiCount"; | ||
| static final String GCS_API_TIME = "gcsApiTime"; | ||
| static final String BACKOFF_COUNT = "backoffCount"; | ||
| static final String BACKOFF_TIME = "backoffTime"; | ||
|
|
||
| private final ThreadLocalValue hadoopApiCount; | ||
| private final ThreadLocalValue hadoopApiTime; | ||
| private final ThreadLocalValue gcsApiCount; | ||
| private final ThreadLocalValue gcsApiTime; | ||
| private final ThreadLocalValue backoffCount; | ||
| private final ThreadLocalValue backoffTime; | ||
|
|
||
| private Map<String, ThreadLocalValue> metrics = new HashMap<>(); | ||
|
|
||
| GhfsThreadLocalStatistics() { | ||
| super(NAME); | ||
| this.hadoopApiCount = createMetric(HADOOP_API_COUNT); | ||
| this.hadoopApiTime = createMetric(HADOOP_API_TIME); | ||
| this.gcsApiCount = createMetric(GCS_API_COUNT); | ||
| this.gcsApiTime = createMetric(GCS_API_TIME); | ||
| this.backoffCount = createMetric(BACKOFF_COUNT); | ||
| this.backoffTime = createMetric(BACKOFF_TIME); | ||
| } | ||
|
|
||
| private ThreadLocalValue createMetric(String name) { | ||
| ThreadLocalValue result = new ThreadLocalValue(); | ||
| metrics.put(name, result); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| @Override | ||
| public Long getLong(String s) { | ||
| if (!metrics.containsKey(s)) { | ||
| return 0L; | ||
| } | ||
|
|
||
| return metrics.get(s).getValue(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isTracked(String s) { | ||
| return metrics.containsKey(s); | ||
| } | ||
|
|
||
| @Override | ||
| public void reset() { | ||
| for (ThreadLocalValue s : metrics.values()) { | ||
| s.reset(); | ||
| } | ||
| } | ||
|
|
||
| void increment(GhfsStatistic statistic, long count) { | ||
| if (statistic == GCS_CONNECTOR_TIME) { | ||
| this.hadoopApiTime.increment(count); | ||
|
There was a problem hiding this comment. Sorry, I am not able to understand this, why are we incrementing hadoopApiTime for GCS_CONNECTOR_TIME? Also, the below metric (2 lines below) is Count while here it is Time. There was a problem hiding this comment. GCS connector implements Hadoop FS APIs. So we are measuring the wall clock time taken by GcsConnectorHadoopAPIs. Another way to look at this is: From the caller perspective this the "hadoopAPITime" and from the connector perspective it is the GCSConnectorTime. Also, from the caller perspective they need the metric to be generic since the connector could be for a different scheme. |
||
| } else if (statistic.getIsHadoopApi()) { | ||
| this.hadoopApiCount.increment(count); | ||
| } | ||
| } | ||
|
|
||
| void increment(GoogleCloudStorageStatistics op, long count) { | ||
|
There was a problem hiding this comment. I am in double minds since we are not handling all the enum cases. Will change if we add values. |
||
| if (op == GoogleCloudStorageStatistics.GCS_API_TIME) { | ||
| this.gcsApiTime.increment(count); | ||
| } else if (op == GoogleCloudStorageStatistics.GCS_API_REQUEST_COUNT) { | ||
| this.gcsApiCount.increment(count); | ||
| } else if (op == GoogleCloudStorageStatistics.GCS_BACKOFF_COUNT) { | ||
| this.backoffCount.increment(count); | ||
| } else if (op == GoogleCloudStorageStatistics.GCS_BACKOFF_TIME) { | ||
| this.backoffTime.increment(count); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Iterator<LongStatistic> getLongStatistics() { | ||
| return this.metrics.entrySet().stream() | ||
| .map(entry -> new LongStatistic(entry.getKey(), entry.getValue().getValue())) | ||
| .iterator(); | ||
| } | ||
|
|
||
| private static class ThreadLocalValue { | ||
| private ThreadLocal<Long> value = ThreadLocal.withInitial(() -> 0L); | ||
|
|
||
| void increment(long count) { | ||
| value.set(value.get() + count); | ||
| } | ||
|
|
||
| Long getValue() { | ||
| return value.get(); | ||
| } | ||
|
|
||
| void reset() { | ||
| value.set(0L); | ||
| } | ||
| } | ||
| } | ||
This file contains 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.
getClass().getName()?
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.
These are string with special meaning. The consumer framework (eg. spark) will use this name to get the statistics.