org.jitsi.utils.logging.DiagnosticContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jitsi-utils Show documentation
A set of basic utilities used in Jitsi projects
There is a newer version: 1.0-133-g6af1020
/*
 * Copyright @ 2017 Atlassian Pty Ltd
 *
 * 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
 *
 *     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.jitsi.utils.logging;

import edu.umd.cs.findbugs.annotations.*;
import org.jitsi.utils.*;

import java.time.*;
import java.util.*;
import java.util.concurrent.*;

/**
 * @author George Politis
 */
@SuppressFBWarnings(
    value = "EQ_DOESNT_OVERRIDE_EQUALS",
    justification = "We only add methods, we don't override anything.")
public class DiagnosticContext
    extends ConcurrentHashMap
{
    Clock clock;

    /**
     * {@inheritDoc}
     */
    public DiagnosticContext()
    {
        super();
        this.clock = Clock.systemUTC();
    }

    /**
     * Creates a diagnostic context using the specified clock for timestamp values.
     * @param clock
     */
    public DiagnosticContext(Clock clock)
    {
        super();
        this.clock = clock;
    }

    /**
     * Makes a new time series point without a timestamp. This is recommended
     * for time series where the exact timestamp value isn't important and can
     * be deduced via other means (i.e. Java logging timestamps).
     *
     * @param timeSeriesName the name of the time series
     */
    public TimeSeriesPoint makeTimeSeriesPoint(String timeSeriesName)
    {
        return makeTimeSeriesPoint(timeSeriesName, clock.instant());
    }

    /**
     * Makes a new time series point with a timestamp. This is recommended for
     * time series where it's important to have the exact timestamp value.
     *
     * @param timeSeriesName the name of the time series
     * @param tsMs the timestamp of the time series point (in millis)
     */
    public TimeSeriesPoint makeTimeSeriesPoint(String timeSeriesName, long tsMs)
    {
        return new TimeSeriesPoint(this)
            .addField("series", timeSeriesName)
            .addField("time", tsMs);
    }

    /**
     * Makes a new time series point with an Instant. This is recommended for
     * time series where it's important to have the exact timestamp value,
     * when the process is working in Instant values.
     *
     * @param timeSeriesName the name of the time series
     * @param ts the timestamp of the time series point
     */
    public TimeSeriesPoint makeTimeSeriesPoint(String timeSeriesName, Instant ts)
    {
        return new TimeSeriesPoint(this)
            .addField("series", timeSeriesName)
            .addField("time", TimeUtils.formatTimeAsFullMillis(ts.getEpochSecond(), ts.getNano()));
    }

    public static class TimeSeriesPoint
        extends HashMap
    {
        public TimeSeriesPoint(Map m)
        {
            super(m);
        }

        /**
         * Adds a field to the time series point.
         */
        public TimeSeriesPoint addField(String key, Object value)
        {
            put(key, value);
            return this;
        }
    }
}