com.opentable.logging.CommonLogFields Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of otj-logging Show documentation
Logging component
There is a newer version: 6.0.0
/*
 * 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 com.opentable.logging;

import java.util.UUID;

import com.fasterxml.jackson.annotation.JsonProperty;

import org.slf4j.MDC;

/**
 * Covers common log fields that are not already in the {@link MDC}.  (Especially
 * RequestId is in the MDC).
 * Log Fields.
 */
public interface CommonLogFields
{
    String REQUEST_ID_KEY = "request-id";

    @JsonProperty("@timestamp")
    String getTimestamp();

    @JsonProperty("@uuid")
    UUID getMessageId();

    @JsonProperty("component-id")
    default String getComponentId() {
        return getServiceType();
    }

    @JsonProperty("service-type")
    String getServiceType();

    @JsonProperty("log-name")
    String getLogTypeName();

    @JsonProperty("logger-name")
    String getLogClass();

    @JsonProperty("host")
    default String getHost() {
        return CommonLogHolder.HOST_NAME;
    }

    @JsonProperty("instance-no")
    default Integer getInstanceNo() {
        return CommonLogHolder.INSTANCE_NO;
    }

    @JsonProperty("ot-env")
    default String getOtEnv() {
        return CommonLogHolder.OT_ENV;
    }

    @JsonProperty("ot-env-type")
    default String getOtEnvType() {
        return CommonLogHolder.OT_ENV_TYPE;
    }

    @JsonProperty("ot-env-location")
    default String getOtEnvLocation() {
        return CommonLogHolder.OT_ENV_LOCATION;
    }

    @JsonProperty("ot-env-flavor")
    default String getOtEnvFlavor() {
        return CommonLogHolder.OT_ENV_FLAVOR;
    }

    @JsonProperty("severity")
    String getSeverity();

    @JsonProperty("message")
    String getMessage();

    @JsonProperty("thread-name")
    String getThreadName();

    @JsonProperty("exception")
    String getThrowable();

    /** Written by the encoder, value is ignored for serialization. */
    @JsonProperty("sequence-number")
    default long getSequenceNumber() {
        return Long.MIN_VALUE;
    }

    /** Declare the OTL type for selectorless processing. */
    @JsonProperty("@loglov3-otl")
    String getLoglov3Otl();
}