xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/StatsdConfig.java (revision 5d9f3aa0ca3da3a714233f987fa732f62c0965f6)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
 */
package org.opengrok.indexer.configuration;

import io.micrometer.statsd.StatsdFlavor;

/**
 * Configuration for Statsd metrics emitted by the Indexer via {@link org.opengrok.indexer.util.Statistics}.
 */
public class StatsdConfig {
    private int port;
    private String host;
    private boolean enabled;
    private StatsdFlavor flavor;

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public int getPort() {
        return port;
    }

    public void setPort(int port) {
        this.port = port;
    }

    public StatsdFlavor getFlavor() {
        return flavor;
    }

    public void setFlavor(StatsdFlavor flavor) {
        this.flavor = flavor;
    }

    public boolean isEnabled() {
        return port != 0 && host != null && !host.isEmpty() && flavor != null;
    }

    /**
     * Gets an instance version suitable for helper documentation by shifting
     * most default properties slightly.
     */
    static StatsdConfig getForHelp() {
        StatsdConfig res = new StatsdConfig();
        res.setHost("foo.bar");
        res.setPort(8125);
        res.setFlavor(StatsdFlavor.ETSY);
        return res;
    }
}