Skip to content

[BEAM-14116] Catch MonitoringInfoMetricName null keys or values in the constructor#17094

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.

Sign up for GitHub

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

Merged
lukecwik merged 7 commits into from
Mar 23, 2022
Merged

[BEAM-14116] Catch MonitoringInfoMetricName null keys or values in the constructor #17094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5111ba9
Catch MonitoringInfoMetricName null keys or values in the constructor
dpcollins-google Mar 15, 2022
3c0e27e
remove nullness suppression and fix bugs
dpcollins-google Mar 16, 2022
ce4c48e
fixes
dpcollins-google Mar 16, 2022
5417d56
fixes
dpcollins-google Mar 18, 2022
2a33d94
fixes
dpcollins-google Mar 18, 2022
db7e179
fixes
dpcollins-google Mar 19, 2022
847fe17
fixes
dpcollins-google Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 23 additions & 25 deletions ...ore-java/src/main/java/org/apache/beam/runners/core/metrics/MonitoringInfoMetricName.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,62 +19,60 @@

import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkArgument;

import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import org.apache.beam.model.pipeline.v1.MetricsApi;
import org.apache.beam.sdk.metrics.MetricName;
import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Strings;
import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableMap;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
* An implementation of {@code MetricKey} based on a MonitoringInfo's URN and label to represent the
* key instead of only a name+namespace. This is useful when defining system defined metrics with a
* specific urn via a {@code CounterContainer}.
*/
@SuppressWarnings({
"nullness" // TODO(https://issues.apache.org/jira/browse/BEAM-10402)
})
public class MonitoringInfoMetricName extends MetricName {

private String urn;
private Map<String, String> labels = new HashMap<String, String>();
private final String urn;
private final Map<String, String> labels;

private MonitoringInfoMetricName(String urn, Map<String, String> labels) {
checkArgument(!Strings.isNullOrEmpty(urn), "MonitoringInfoMetricName urn must be non-empty");
checkArgument(labels != null, "MonitoringInfoMetricName labels must be non-null");
// TODO(ajamato): Move SimpleMonitoringInfoBuilder to :runners:core-construction-java
// and ensure all necessary labels are set for the specific URN.
this.urn = urn;
for (Entry<String, String> entry : labels.entrySet()) {
this.labels.put(entry.getKey(), entry.getValue());
}
this.labels = ImmutableMap.copyOf(labels);
}

@Override
public String getNamespace() {
if (labels.containsKey(MonitoringInfoConstants.Labels.NAMESPACE)) {
// User-generated metric
return labels.getOrDefault(MonitoringInfoConstants.Labels.NAMESPACE, null);
} else if (labels.containsKey(MonitoringInfoConstants.Labels.PCOLLECTION)) {
// System-generated metric
return labels.getOrDefault(MonitoringInfoConstants.Labels.PCOLLECTION, null);
} else if (labels.containsKey(MonitoringInfoConstants.Labels.PTRANSFORM)) {
// System-generated metric
return labels.getOrDefault(MonitoringInfoConstants.Labels.PTRANSFORM, null);
} else {
return urn.split(":", 2)[0];
// User-generated metric
String ret = labels.get(MonitoringInfoConstants.Labels.NAMESPACE);
if (ret != null) {
return ret;
}
// System-generated metric
ret = labels.get(MonitoringInfoConstants.Labels.PCOLLECTION);
if (ret != null) {
return ret;
}
// System-generated metric
ret = labels.get(MonitoringInfoConstants.Labels.PTRANSFORM);
if (ret != null) {
return ret;
}
return urn.split(":", 2)[0];
}

@Override
public String getName() {
if (labels.containsKey(MonitoringInfoConstants.Labels.NAME)) {
return labels.getOrDefault(MonitoringInfoConstants.Labels.NAME, null);
} else {
return urn.split(":", 2)[1];
String ret = labels.get(MonitoringInfoConstants.Labels.NAME);
if (ret != null) {
return ret;
}
return urn.split(":", 2)[1];
}

/** @return the urn of this MonitoringInfo metric. */
Expand Down
6 changes: 4 additions & 2 deletions ...le-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/GcsUtil.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -466,7 +466,8 @@ SeekableByteChannel open(GcsPath path, GoogleCloudStorageReadOptions readOptions
MonitoringInfoConstants.Labels.RESOURCE,
GcpResourceIdentifiers.cloudStorageBucket(path.getBucket()));
baseLabels.put(
MonitoringInfoConstants.Labels.GCS_PROJECT_ID, googleCloudStorageOptions.getProjectId());
MonitoringInfoConstants.Labels.GCS_PROJECT_ID,
String.valueOf(googleCloudStorageOptions.getProjectId()));
baseLabels.put(MonitoringInfoConstants.Labels.GCS_BUCKET, path.getBucket());

ServiceCallMetric serviceCallMetric =
Expand DownExpand Up@@ -580,7 +581,8 @@ public WritableByteChannel create(GcsPath path, CreateOptions options) throws IO
MonitoringInfoConstants.Labels.RESOURCE,
GcpResourceIdentifiers.cloudStorageBucket(path.getBucket()));
baseLabels.put(
MonitoringInfoConstants.Labels.GCS_PROJECT_ID, googleCloudStorageOptions.getProjectId());
MonitoringInfoConstants.Labels.GCS_PROJECT_ID,
String.valueOf(googleCloudStorageOptions.getProjectId()));
baseLabels.put(MonitoringInfoConstants.Labels.GCS_BUCKET, path.getBucket());

ServiceCallMetric serviceCallMetric =
Expand Down