/*
* 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.beam.sdk.metrics;
import com.google.auto.value.AutoValue;
import java.io.Serializable;
import org.apache.beam.sdk.annotations.Experimental;
import org.apache.beam.sdk.annotations.Experimental.Kind;
/**
* The name of a metric consists of a {@link #namespace} and a {@link #name}. The {@link #namespace}
* allows grouping related metrics together and also prevents collisions between multiple metrics
* with the same name.
*/
@Experimental(Kind.METRICS)
@AutoValue
public abstract class MetricName implements Serializable {
/** The namespace associated with this metric. */
public abstract String namespace();
/** The name of this metric. */
public abstract String name();
public static MetricName named(String namespace, String name) {
return new AutoValue_MetricName(namespace, name);
}
public static MetricName named(Class<?> namespace, String name) {
return new AutoValue_MetricName(namespace.getName(), name);
}
}