org.graylog.plugins.pipelineprocessor.functions.debug.MetricCounterIncrement 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.1
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.plugins.pipelineprocessor.functions.debug;

import com.codahale.metrics.Counter;
import com.codahale.metrics.MetricRegistry;
import com.google.common.collect.ImmutableList;
import org.graylog.plugins.pipelineprocessor.EvaluationContext;
import org.graylog.plugins.pipelineprocessor.ast.functions.AbstractFunction;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionArgs;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionDescriptor;
import org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor;

import javax.inject.Inject;

public class MetricCounterIncrement extends AbstractFunction {

    public static final String NAME = "metric_counter_inc";
    private final ParameterDescriptor nameParam;
    private final ParameterDescriptor valueParam;

    @Inject
    public MetricCounterIncrement(MetricRegistry metricRegistry) {
        nameParam = ParameterDescriptor.string("name", Counter.class)
                .description("The counter metric name, will always be prefixed with 'org.graylog.rulemetrics.'")
                .transform(name -> metricRegistry.counter(MetricRegistry.name("org.graylog.rulemetrics", name)))
                .build();
        valueParam = ParameterDescriptor.integer("value")
                .description("Value to increment the counter by")
                .optional()
                .build();
    }

    @Override
    public Void evaluate(FunctionArgs args, EvaluationContext context) {
        final Counter counter = nameParam.required(args, context);
        final Long aLong = valueParam.optional(args, context).orElse(1L);
        //noinspection ConstantConditions
        counter.inc(aLong);
        return null;
    }

    @Override
    public FunctionDescriptor descriptor() {
        return FunctionDescriptor.builder()
                .name(NAME)
                .returnType(Void.class)
                .description("")
                .params(ImmutableList.of(nameParam, valueParam))
                .build();
    }
}