io.sentry.event.Breadcrumb Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sentry Show documentation
SDK for sentry.io
There is a newer version: 8.5.0
package io.sentry.event;

import java.io.Serializable;
import java.util.Date;
import java.util.Map;
import java.util.Objects;

/**
 * An object that represents a single breadcrumb. Events may include a list
 * of breadcrumbs that help users re-create the path of actions that occurred
 * which lead to the Event happening.
 */
public class Breadcrumb implements Serializable {

    /**
     * (Optional) Type of the breadcrumb.
     */
    private final Type type;
    /**
     * Timestamp when the breadcrumb occurred.
     */
    private final Date timestamp;
    /**
     * Level of the breadcrumb.
     */
    private final Level level;
    /**
     * Message of the breadcrumb.
     */
    private final String message;
    /**
     * Category of the breadcrumb.
     */
    private final String category;
    /**
     * Data related to the breadcrumb.
     */
    private final Map data;

    /**
     * Possible choices for the level field.
     */
    public enum Level {
        /**
         * DEBUG level.
         */
        DEBUG("debug"),

        /**
         * INFO level.
         */
        INFO("info"),

        /**
         * WARNING level.
         */
        WARNING("warning"),

        /**
         * ERROR level.
         */
        ERROR("error"),

        /**
         * CRITICAL level.
         */
        CRITICAL("critical");

        private final String value;

        /**
         * Construct a {@link Level} with the value to serialize with.
         *
         * @param value Value to use for serialization.
         */
        Level(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }
    /**
     * Possible choices for the type field.
     */
    public enum Type {
        /**
         * DEFAULT type.
         */
        DEFAULT("default"),

        /**
         * HTTP type.
         */
        HTTP("http"),

        /**
         * NAVIGATION type.
         */
        NAVIGATION("navigation"),

        /**
         * USER type.
         */
        USER("user");


        private final String value;

        /**
         * Construct a {@link Type} with the value to serialize with.
         *
         * @param value Value to use for serialization.
         */
        Type(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }

    /**
     * Create an immutable {@link Breadcrumb} object.
     *
     * @param type Type
     * @param timestamp Date
     * @param level Level
     * @param message String
     * @param category String
     * @param data Map of String to String
     */
    Breadcrumb(Type type, Date timestamp, Level level, String message,
        String category, Map data) {

        if (timestamp == null) {
            timestamp = new Date();
        }

        if (message == null && (data == null || data.size() < 1)) {
            throw new IllegalArgumentException("one of 'message' or 'data' must be set");
        }

        this.type = type;
        this.timestamp = timestamp;
        this.level = level;
        this.message = message;
        this.category = category;
        this.data = data;
    }

    public Type getType() {
        return type;
    }

    public Date getTimestamp() {
        return timestamp;
    }

    public Level getLevel() {
        return level;
    }

    public String getMessage() {
        return message;
    }

    public String getCategory() {
        return category;
    }

    public Map getData() {
        return data;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Breadcrumb that = (Breadcrumb) o;
        return type == that.type
            && Objects.equals(timestamp, that.timestamp)
            && level == that.level
            && Objects.equals(message, that.message)
            && Objects.equals(category, that.category)
            && Objects.equals(data, that.data);
    }

    @Override
    public int hashCode() {
        return Objects.hash(type, timestamp, level, message, category, data);
    }

}