| /** |
| * 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.metrics2; |
| |
| import org.apache.hadoop.classification.InterfaceAudience; |
| import org.apache.hadoop.classification.InterfaceStability; |
| |
| /** |
| * The metrics record builder interface |
| */ |
| @InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public abstract class MetricsRecordBuilder { |
| /** |
| * Add a metrics value with metrics information |
| * @param info metadata of the tag |
| * @param value of the tag |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder tag(MetricsInfo info, String value); |
| |
| /** |
| * Add an immutable metrics tag object |
| * @param tag a pre-made tag object (potentially save an object construction) |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder add(MetricsTag tag); |
| |
| /** |
| * Add a pre-made immutable metric object |
| * @param metric the pre-made metric to save an object construction |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder add(AbstractMetric metric); |
| |
| /** |
| * Set the context tag |
| * @param value of the context |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder setContext(String value); |
| |
| /** |
| * Add an integer metric |
| * @param info metadata of the metric |
| * @param value of the metric |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder addCounter(MetricsInfo info, int value); |
| |
| /** |
| * Add an long metric |
| * @param info metadata of the metric |
| * @param value of the metric |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder addCounter(MetricsInfo info, long value); |
| |
| /** |
| * Add a integer gauge metric |
| * @param info metadata of the metric |
| * @param value of the metric |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder addGauge(MetricsInfo info, int value); |
| |
| /** |
| * Add a long gauge metric |
| * @param info metadata of the metric |
| * @param value of the metric |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder addGauge(MetricsInfo info, long value); |
| |
| /** |
| * Add a float gauge metric |
| * @param info metadata of the metric |
| * @param value of the metric |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder addGauge(MetricsInfo info, float value); |
| |
| /** |
| * Add a double gauge metric |
| * @param info metadata of the metric |
| * @param value of the metric |
| * @return self |
| */ |
| public abstract MetricsRecordBuilder addGauge(MetricsInfo info, double value); |
| |
| /** |
| * @return the parent metrics collector object |
| */ |
| public abstract MetricsCollector parent(); |
| |
| /** |
| * Syntactic sugar to add multiple records in a collector in a one liner. |
| * @return the parent metrics collector object |
| */ |
| public MetricsCollector endRecord() { return parent(); } |
| } |