org.graylog2.rest.resources.system.BufferResource Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.0.6
/**
 * This file is part of Graylog.
 *
 * Graylog is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Graylog is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Graylog.  If not, see .
 */
package org.graylog2.rest.resources.system;

import com.codahale.metrics.annotation.Timed;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import org.apache.shiro.authz.annotation.RequiresAuthentication;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.graylog2.Configuration;
import org.graylog2.buffers.OutputBuffer;
import org.graylog2.plugin.buffers.InputBuffer;
import org.graylog2.security.RestPermissions;
import org.graylog2.shared.buffers.ProcessBuffer;
import org.graylog2.shared.rest.resources.RestResource;

import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.util.Map;

@RequiresAuthentication
@Api(value = "System/Buffers", description = "Buffer information of this node.")
@Path("/system/buffers")
public class BufferResource extends RestResource {

    private final Configuration configuration;
    private final InputBuffer inputBuffer;
    private final ProcessBuffer processBuffer;
    private final OutputBuffer outputBuffer;

    @Inject
    public BufferResource(Configuration configuration,
                          InputBuffer inputBuffer,
                          ProcessBuffer processBuffer,
                          OutputBuffer outputBuffer) {
        this.configuration = configuration;
        this.inputBuffer = inputBuffer;
        this.processBuffer = processBuffer;
        this.outputBuffer = outputBuffer;
    }

    @GET
    @Timed
    @ApiOperation(value = "Get current utilization of buffers and caches of this node.")
    @RequiresPermissions(RestPermissions.BUFFERS_READ)
    @Produces(MediaType.APPLICATION_JSON)
    public Map> utilization() {
        return ImmutableMap.of(
                "buffers", buffers());
    }

    @GET
    @Timed
    @Path("/classes")
    @ApiOperation(value = "Get classnames of current buffer implementations.")
    @RequiresPermissions(RestPermissions.BUFFERS_READ)
    @Produces(MediaType.APPLICATION_JSON)
    public Map getBufferClasses() {
        return ImmutableMap.of(
                "input_buffer", inputBuffer.getClass().getCanonicalName(),
                "process_buffer", processBuffer.getClass().getCanonicalName(),
                "output_buffer", outputBuffer.getClass().getCanonicalName());
    }

    private Map buffers() {
        Map buffers = Maps.newHashMap();
        Map input = Maps.newHashMap();
        Map process = Maps.newHashMap();
        Map output = Maps.newHashMap();

        long ringSize = configuration.getRingSize();
        long inputRingSize = configuration.getInputBufferRingSize();

        final long inputSize = inputBuffer.size();
        final float inputUtil = ((float) inputSize / inputRingSize) * 100;
        input.put("utilization_percent", inputUtil);
        input.put("utilization", inputSize);

        final long processSize = processBuffer.size();
        final float processUtil = ((float) processSize / ringSize) * 100;
        process.put("utilization_percent", processUtil);
        process.put("utilization", processSize);

        final long outputSize = outputBuffer.size();
        final float outputUtil = ((float) outputSize / ringSize) * 100;
        output.put("utilization_percent", outputUtil);
        output.put("utilization", outputSize);

        buffers.put("input", input);
        buffers.put("process", process);
        buffers.put("output", output);

        return buffers;
    }


}