org.elasticsearch.common.logging.JsonLogLine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation
Elasticsearch subproject :test:framework
The newest version!
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.common.logging;

import org.elasticsearch.xcontent.ObjectParser;
import org.elasticsearch.xcontent.ParseField;

import java.util.List;

/**
 * Represents a single log line in a json format.
 * Parsing log lines with this class confirms the json format of logs
 */
public class JsonLogLine {
    public static final ObjectParser ECS_LOG_LINE = createECSParser(true);
    public static final ObjectParser ES_LOG_LINE = createESParser(true);

    private String dataset;
    private String timestamp;
    private String level;
    private String component;
    private String clusterName;
    private String nodeName;
    private String clusterUuid;
    private String nodeId;
    private String message;
    private List tags;
    private List stacktrace;

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("JsonLogLine{");
        sb.append("dataset='").append(dataset).append('\'');
        sb.append(", timestamp='").append(timestamp).append('\'');
        sb.append(", level='").append(level).append('\'');
        sb.append(", component='").append(component).append('\'');
        sb.append(", clusterName='").append(clusterName).append('\'');
        sb.append(", nodeName='").append(nodeName).append('\'');
        sb.append(", clusterUuid='").append(clusterUuid).append('\'');
        sb.append(", nodeId='").append(nodeId).append('\'');
        sb.append(", message='").append(message).append('\'');
        sb.append(", tags='").append(tags).append('\'');
        sb.append(", stacktrace=").append(stacktrace);
        sb.append('}');
        return sb.toString();
    }

    public String getDataset() {
        return dataset;
    }

    public String getTimestamp() {
        return timestamp;
    }

    public String getLevel() {
        return level;
    }

    public String getComponent() {
        return component;
    }

    public String getClusterName() {
        return clusterName;
    }

    public String getNodeName() {
        return nodeName;
    }

    public String getClusterUuid() {
        return clusterUuid;
    }

    public String getNodeId() {
        return nodeId;
    }

    public String getMessage() {
        return message;
    }

    public List getTags() {
        return tags;
    }

    public List stacktrace() {
        return stacktrace;
    }

    public void setDataset(String dataset) {
        this.dataset = dataset;
    }

    public void setTimestamp(String timestamp) {
        this.timestamp = timestamp;
    }

    public void setLevel(String level) {
        this.level = level;
    }

    public void setComponent(String component) {
        this.component = component;
    }

    public void setClusterName(String clusterName) {
        this.clusterName = clusterName;
    }

    public void setNodeName(String nodeName) {
        this.nodeName = nodeName;
    }

    public void setClusterUuid(String clusterUuid) {
        this.clusterUuid = clusterUuid;
    }

    public void setNodeId(String nodeId) {
        this.nodeId = nodeId;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public void setTags(List tags) {
        this.tags = tags;
    }

    public void setStacktrace(List stacktrace) {
        this.stacktrace = stacktrace;
    }

    private static ObjectParser createECSParser(boolean ignoreUnknownFields) {
        ObjectParser parser = new ObjectParser<>("json_log_line", ignoreUnknownFields, JsonLogLine::new);
        parser.declareString(JsonLogLine::setDataset, new ParseField("event.dataset"));
        parser.declareString(JsonLogLine::setTimestamp, new ParseField("@timestamp"));
        parser.declareString(JsonLogLine::setLevel, new ParseField("log.level"));
        parser.declareString(JsonLogLine::setComponent, new ParseField("log.logger"));
        parser.declareString(JsonLogLine::setClusterName, new ParseField("elasticsearch.cluster.name"));
        parser.declareString(JsonLogLine::setNodeName, new ParseField("elasticsearch.node.name"));
        parser.declareString(JsonLogLine::setClusterUuid, new ParseField("elasticsearch.cluster.uuid"));
        parser.declareString(JsonLogLine::setNodeId, new ParseField("elasticsearch.node.id"));
        parser.declareString(JsonLogLine::setMessage, new ParseField("message"));
        parser.declareStringArray(JsonLogLine::setTags, new ParseField("tags"));
        parser.declareStringArray(JsonLogLine::setStacktrace, new ParseField("error.stack_trace"));

        return parser;
    }

    private static ObjectParser createESParser(boolean ignoreUnknownFields) {
        ObjectParser parser = new ObjectParser<>("search_template", ignoreUnknownFields, JsonLogLine::new);
        parser.declareString(JsonLogLine::setDataset, new ParseField("type"));
        parser.declareString(JsonLogLine::setTimestamp, new ParseField("timestamp"));
        parser.declareString(JsonLogLine::setLevel, new ParseField("level"));
        parser.declareString(JsonLogLine::setComponent, new ParseField("component"));
        parser.declareString(JsonLogLine::setClusterName, new ParseField("cluster.name"));
        parser.declareString(JsonLogLine::setNodeName, new ParseField("node.name"));
        parser.declareString(JsonLogLine::setClusterUuid, new ParseField("cluster.uuid"));
        parser.declareString(JsonLogLine::setNodeId, new ParseField("node.id"));
        parser.declareString(JsonLogLine::setMessage, new ParseField("message"));
        parser.declareStringArray(JsonLogLine::setStacktrace, new ParseField("stacktrace"));

        return parser;
    }
}