org.apache.kafka.common.metrics.KafkaMetricsContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kafka-clients Show documentation

There is a newer version: 3.9.0

/*
 * 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.kafka.common.metrics;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * A implementation of MetricsContext, it encapsulates required metrics context properties for Kafka services and clients
 */
public class KafkaMetricsContext implements MetricsContext {
    /**
     * Client or Service's contextLabels map.
     */
    private final Map contextLabels = new HashMap<>();

    /**
     * Create a MetricsContext with namespace, no service or client properties
     * @param namespace value for _namespace key
     */
    public KafkaMetricsContext(String namespace) {
        this(namespace, new HashMap<>());
    }

    /**
     * Create a MetricsContext with namespace, service or client properties
     * @param namespace value for _namespace key
     * @param contextLabels  contextLabels additional entries to add to the context.
     *                  values will be converted to string using Object.toString()
     */
    public KafkaMetricsContext(String namespace, Map contextLabels) {
        this.contextLabels.put(MetricsContext.NAMESPACE, namespace);
        contextLabels.forEach((key, value) -> this.contextLabels.put(key, value != null ? value.toString() : null));
    }

    @Override
    public Map contextLabels() {
        return Collections.unmodifiableMap(contextLabels);
    }

}