org.apache.flink.runtime.metrics.groups.GenericValueMetricGroup Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation

The newest version!

/*
 * 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.flink.runtime.metrics.groups;

import org.apache.flink.annotation.Internal;
import org.apache.flink.metrics.CharacterFilter;
import org.apache.flink.metrics.MetricGroup;
import org.apache.flink.runtime.metrics.MetricRegistry;
import org.apache.flink.runtime.metrics.scope.ScopeFormat;

import java.util.Map;

/**
 * A {@link GenericMetricGroup} for representing the value part of a key-value metric group pair.
 *
 * @see GenericKeyMetricGroup
 * @see MetricGroup#addGroup(String, String)
 */
@Internal
public class GenericValueMetricGroup extends GenericMetricGroup {
    private String key;
    private final String value;

    GenericValueMetricGroup(MetricRegistry registry, GenericKeyMetricGroup parent, String value) {
        super(registry, parent, value);
        this.key = parent.getGroupName(name -> name);
        this.value = value;
    }

    // ------------------------------------------------------------------------

    @Override
    protected void putVariables(Map variables) {
        variables.put(ScopeFormat.asVariable(this.key), value);
    }

    @Override
    protected String createLogicalScope(CharacterFilter filter, char delimiter) {
        return parent.getLogicalScope(filter, delimiter);
    }
}