io.micrometer.datadog.DatadogMetricMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micrometer-registry-datadog Show documentation
Application monitoring instrumentation facade
There is a newer version: 1.14.1
Show newest version
/*
 * Copyright 2017 VMware, Inc.
 *
 * Licensed 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
 *
 * https://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 io.micrometer.datadog;

import io.micrometer.common.lang.Nullable;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.Statistic;
import io.micrometer.core.instrument.util.StringEscapeUtils;

import java.util.*;

/**
 * @author Jon Schneider
 * @author Gregory Zussa
 */
class DatadogMetricMetadata {

    // Datadog rejects anything not on this list: https://docs.datadoghq.com/units/
    // @formatter:off
    private static final Set UNIT_WHITELIST = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
            "bit", "byte", "kibibyte", "mebibyte", "gibibyte", "tebibyte", "pebibyte", "exbibyte",
            "microsecond", "millisecond", "second", "minute", "hour", "day", "week", "nanosecond",
            "fraction", "percent", "percent_nano", "apdex",
            "connection", "request", "packet", "segment", "response", "message", "payload", "timeout", "datagram", "route", "session",
            "process", "core", "thread", "host", "node", "fault", "service", "instance", "cpu",
            "file", "inode", "sector", "block",
            "buffer", "error", "read", "write", "occurrence", "event", "time", "unit", "operation", "item", "task", "worker", "resource",
            "email", "sample", "stage", "monitor", "location", "check", "attempt", "device", "update", "method", "job", "container",
            "table", "index", "lock", "transaction", "query", "row", "key", "command", "offset", "record", "object", "cursor", "assertion", "scan", "document", "shard", "flush", "merge", "refresh", "fetch", "column", "commit", "wait", "ticket", "question",
            "hit", "miss", "eviction", "get", "set",
            "dollar", "cent",
            "page", "split",
            "hertz", "kilohertz", "megahertz", "gigahertz",
            "entry")));
    // @formatter:on

    private static final Map PLURALIZED_UNIT_MAPPING;

    static {
        Map pluralizedUnitMapping = new HashMap<>();
        UNIT_WHITELIST.forEach(unit -> pluralizedUnitMapping.put(unit + "s", unit));
        pluralizedUnitMapping.put("indices", "index");
        pluralizedUnitMapping.put("indexes", "index");
        PLURALIZED_UNIT_MAPPING = Collections.unmodifiableMap(pluralizedUnitMapping);
    }

    private final Meter.Id id;

    private final String type;

    private final boolean descriptionsEnabled;

    @Nullable
    private final String overrideBaseUnit;

    DatadogMetricMetadata(Meter.Id id, Statistic statistic, boolean descriptionsEnabled,
            @Nullable String overrideBaseUnit) {
        this.id = id;
        this.descriptionsEnabled = descriptionsEnabled;
        this.overrideBaseUnit = overrideBaseUnit;

        this.type = sanitizeType(statistic);
    }

    String editMetadataBody() {
        if (descriptionsEnabled && id.getDescription() != null) {
            String body = "{\"type\":\"" + type + "\"";

            String baseUnit = sanitizeBaseUnit(id.getBaseUnit(), overrideBaseUnit);
            if (baseUnit != null) {
                body += ",\"unit\":\"" + baseUnit + "\"";
            }
            body += ",\"description\":\"" + StringEscapeUtils.escapeJson(id.getDescription()) + "\"}";
            return body;
        }
        return null;
    }

    static String sanitizeBaseUnit(@Nullable String baseUnit, @Nullable String overrideBaseUnit) {
        String sanitizeBaseUnit = overrideBaseUnit != null ? overrideBaseUnit : baseUnit;
        if (sanitizeBaseUnit != null) {
            return UNIT_WHITELIST.contains(sanitizeBaseUnit) ? sanitizeBaseUnit
                    : PLURALIZED_UNIT_MAPPING.get(sanitizeBaseUnit);
        }
        return null;
    }

    static String sanitizeType(Statistic statistic) {
        switch (statistic) {
            case COUNT:
            case TOTAL:
            case TOTAL_TIME:
                return "count";
            default:
                return "gauge";
        }
    }

}