com.ps.s4l.service.LoggingDetailService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of splunk4logback Show documentation

Controls runtime logging levels via a splunk app

The newest version!

package com.ps.s4l.service;

import com.ps.s4l.model.LoggingDetail;

import java.util.Collection;

/**
 * A service to set log levels
 */
public interface LoggingDetailService{

    /**
     * Returns all the details
     *
     * @return a collection of details
     */
    Collection findAll();

    /**
     * Find the ones just for the supplied appId
     * @param appId the app id you're concerned with
     * @return a collection of details with this app id
     */
    Collection findByAppId(String appId);


    /**
     * Persist logging details
     *
     * @return a fully hydrated logging detail, the id is set.
     */
    LoggingDetail save(LoggingDetail loggingDetail);


    /**
     * Restart the monitoring process, there is no need to start it because the constructors will. If you want
     * finer control then stop it immediately and the restart it when your ready.
     */
    void restart();


    /**
     * Stop the monitoring process
     */
    void stop();

    /**
     * health check
     * @return true=yes, false=no
     */
    boolean isRunning();
}