sirius.web.health.HipChat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirius-web Show documentation
Provides a modern and scalable web server as SIRIUS module
There is a newer version: 22.2.3
/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.web.health;

import com.google.common.base.Charsets;
import sirius.kernel.async.CallContext;
import sirius.kernel.commons.Context;
import sirius.kernel.commons.RateLimit;
import sirius.kernel.commons.Strings;
import sirius.kernel.di.std.ConfigValue;
import sirius.kernel.di.std.Register;
import sirius.kernel.health.ExceptionHandler;
import sirius.kernel.health.Exceptions;
import sirius.kernel.health.Incident;
import sirius.kernel.info.Product;
import sirius.kernel.xml.Outcall;

import javax.annotation.Nullable;
import java.net.URL;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

/**
 * Helper class to notify an hip chat room about certain events.
 */
@Register(classes = {HipChat.class, ExceptionHandler.class})
public class HipChat implements ExceptionHandler {

    @Override
    public void handle(Incident incident) throws Exception {
        sendMessage("incident",
                    Strings.apply("%s [%s]", incident.getException().getMessage(), incident.getLocation()),
                    Color.RED,
                    true);
    }

    /**
     * Determines the color to use for a message
     */
    public enum Color {
        YELLOW, RED, GREEN, PURPLE, GRAY
    }

    @ConfigValue("health.hipchat.messageUrl")
    protected String messageUrl;

    @ConfigValue("health.hipchat.authToken")
    protected String authToken;

    @ConfigValue("health.hipchat.room")
    protected String room;

    @ConfigValue("health.hipchat.sender")
    protected String sender;

    @ConfigValue("health.hipchat.types")
    protected List messageTypes;
    protected Set messageFilter;

    private RateLimit checkInterval = RateLimit.nTimesPerInterval(15, TimeUnit.SECONDS, 5);

    /**
     * Sends the given message to hipchat (if configured property).
     *
     * @param messageType determines the type of message to be sent. Only messages with a type listed in the
     *                    config value health.hipchat.types will be sent, others will be discarded.
     *                    If null is passed in, no filtering is performed and the message is always sent.
     * @param message     the message to send (might contain HTML formatting).
     * @param color       the color to use
     * @param notify      should users be notified or not?
     */
    public void sendMessage(@Nullable String messageType, String message, Color color, boolean notify) {
        try {
            if (!checkInterval.check()) {
                return;
            }
            if (Strings.isEmpty(messageUrl) || Strings.isEmpty(authToken) || Strings.isEmpty(room) || Strings.isEmpty(
                    message)) {
                return;
            }
            if (messageFilter == null) {
                messageFilter = messageTypes.stream().map(String::toLowerCase).collect(Collectors.toSet());
            }
            if (messageType != null && !messageFilter.contains(messageType)) {
                return;
            }

            Context ctx = Context.create();
            ctx.put("from", Strings.isEmpty(sender) ? CallContext.getNodeName() : sender);
            ctx.put("color", color.name().toLowerCase());
            ctx.put("auth_token", authToken);
            ctx.put("message_format", "html");
            ctx.put("room_id", room);
            ctx.put("message",
                    Strings.apply("%s on %s: %s", Product.getProduct().toString(), CallContext.getNodeName(), message));
            ctx.put("notify", notify ? 1 : 0);
            Outcall call = new Outcall(new URL(messageUrl));
            call.postData(ctx, Charsets.UTF_8).getData();
        } catch (Exception e) {
            Exceptions.handle(e);
        }
    }
}