io.opentelemetry.sdk.internal.AttributesMap Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.internal;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BiConsumer;
import javax.annotation.Nullable;
/**
* A map with a fixed capacity that drops attributes when the map gets full, and which truncates
* string and array string attribute values to the {@link #lengthLimit}.
*
* This class is internal and is hence not for public use. Its APIs are unstable and can change
* at any time.
*/
public final class AttributesMap extends HashMap, Object> implements Attributes {
private static final long serialVersionUID = -5072696312123632376L;
private final long capacity;
private final int lengthLimit;
private int totalAddedValues = 0;
private AttributesMap(long capacity, int lengthLimit) {
this.capacity = capacity;
this.lengthLimit = lengthLimit;
}
/**
* Create an instance.
*
* @param capacity the max number of attribute entries
* @param lengthLimit the maximum length of string attributes
*/
public static AttributesMap create(long capacity, int lengthLimit) {
return new AttributesMap(capacity, lengthLimit);
}
/** Add the attribute key value pair, applying capacity and length limits. */
public void put(AttributeKey key, T value) {
totalAddedValues++;
if (size() >= capacity && !containsKey(key)) {
return;
}
super.put(key, AttributeUtil.applyAttributeLengthLimit(value, lengthLimit));
}
/** Get the total number of attributes added, including those dropped for capcity limits. */
public int getTotalAddedValues() {
return totalAddedValues;
}
@SuppressWarnings("unchecked")
@Override
@Nullable
public T get(AttributeKey key) {
return (T) super.get(key);
}
@Override
public Map, Object> asMap() {
// Because Attributes is marked Immutable, IDEs may recognize this as redundant usage. However,
// this class is private and is actually mutable, so we need to wrap with unmodifiableMap
// anyways. We implement the immutable Attributes for this class to support the
// Attributes.builder().putAll usage - it is tricky but an implementation detail of this private
// class.
return Collections.unmodifiableMap(this);
}
@Override
public AttributesBuilder toBuilder() {
return Attributes.builder().putAll(this);
}
@Override
public void forEach(BiConsumer, ? super Object> action) {
// https://github.com/open-telemetry/opentelemetry-java/issues/4161
// Help out android desugaring by having an explicit call to HashMap.forEach, when forEach is
// just called through Attributes.forEach desugaring is unable to correctly handle it.
super.forEach(action);
}
@Override
public String toString() {
return "AttributesMap{"
+ "data="
+ super.toString()
+ ", capacity="
+ capacity
+ ", totalAddedValues="
+ totalAddedValues
+ '}';
}
/** Create an immutable copy of the attributes in this map. */
public Attributes immutableCopy() {
return Attributes.builder().putAll(this).build();
}
}