it.jnrpe.PerformanceData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jnrpe-lib Show documentation
Show all versions of jnrpe-lib Show documentation
A library that implements the NRPE protocol for JAVA applications
The newest version!
/*******************************************************************************
* Copyright (c) 2007, 2014 Massimiliano Ziccardi
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/
package it.jnrpe;
import it.jnrpe.ReturnValue.UnitOfMeasure;
import it.jnrpe.plugins.Metric;
import it.jnrpe.plugins.MetricValue;
import it.jnrpe.utils.thresholds.Prefixes;
/**
* This class holds the performance data to be returned with the result of the
* plugin execution.
*
* Refer to http://nagiosplug.sourceforge.net/developer-guidelines.html#AEN201
*
* @author Massimiliano Ziccardi
* @version $Revision: 1.0 $
*/
class PerformanceData {
/**
* The Unit of Measure of {@link #performanceValue}, {@link #minimumValue}
* and {@link #maximumValue}. With the new threshold format this won't be
* used anymore.
*/
private final UnitOfMeasure unitOfMeasure;
/**
* The unit of {@link #performanceValue}, {@link #minimumValue} and
* {@link #maximumValue}.
*/
private final String unit;
/**
* The warning range passed to the plugin that produced this performance
* data. Can be null
*/
private final String warningRange;
/**
* The critical range passed to the plugin that produced this performance
* data. Can be null
*/
private final String criticalRange;
private final Prefixes prefix;
private Metric metric = null;
/**
* Creates a performance data object.
*
* @param perfLabel
* The label identifying this performance data
* @param value
* The performance value
* @param uom
* The Unit of Measure of value,
* minValue and maxValue
* @param warnRange
* the warning range passed to the plugin that is generating this
* performance data. Can be null.
* @param critRange
* the critical range passed to the plugin that is generating
* this performance data. Can be null.
* @param minValue
* the minimum value that this performance data can reach. Can be
* null.
* @param maxValue
* the maximum value that this performance data can reach. Can be
* null.
*/
PerformanceData(final Metric metric, final UnitOfMeasure uom, final String warnRange, final String critRange) {
this.metric = metric;
unitOfMeasure = uom;
warningRange = warnRange;
criticalRange = critRange;
unit = null;
prefix = Prefixes.RAW;
}
/**
* Creates a performance data object.
*
* @param metric
* The metric that contains the performance data
* @param prefix
* The prefix to be used to prepare the data to be inserted into
* the performance data line (mega, kilo, etc).
* It is used to convert the value present inside the metric (for
* example, memory is usually returned in bytes. You could use
* mega here to visualize it as MegaBytes).
* @param unitofMeasure
* The Unit of Measure of value,
* minValue and maxValue
* @param warnRange
* the warning range passed to the plugin that is generating this
* performance data. Can be null.
* @param critRange
* the critical range passed to the plugin that is generating
* this performance data. Can be null.
*/
PerformanceData(final Metric metric, final Prefixes prefix, final String unitofMeasure, final String warnRange, final String critRange) {
this.metric = metric;
unitOfMeasure = null;
warningRange = warnRange;
criticalRange = critRange;
unit = unitofMeasure;
this.prefix = prefix;
}
/**
* Produce a performance string according to Nagios specification based on
* the value of this performance data object.
*
* @return a string that can be returned to Nagios
*/
public String toPerformanceString() {
final StringBuilder res =
new StringBuilder()
.append(
quote(metric.getMetricName()))
.append('=')
.append(((MetricValue)metric.getMetricValue(prefix)).toPrettyPrintedString());
if (unitOfMeasure != null) {
switch (unitOfMeasure) {
case milliseconds:
res.append("ms");
break;
case microseconds:
res.append("us");
break;
case seconds:
res.append('s');
break;
case bytes:
res.append('B');
break;
case kilobytes:
res.append("KB");
break;
case megabytes:
res.append("MB");
break;
case gigabytes:
res.append("GB");
break;
case terabytes:
res.append("TB");
break;
case percentage:
res.append('%');
break;
case counter:
res.append('c');
break;
default:
}
}
if (unit != null) {
res.append(unit);
}
res.append(';');
if (warningRange != null) {
res.append(warningRange);
}
res.append(';');
if (criticalRange != null) {
res.append(criticalRange);
}
res.append(';');
if (metric.getMinValue() != null) {
res.append(((MetricValue) metric.getMinValue(prefix)).toPrettyPrintedString());
}
res.append(';');
if (metric.getMaxValue() != null) {
res.append(((MetricValue) metric.getMaxValue(prefix)).toPrettyPrintedString());
}
while (res.charAt(res.length() - 1) == ';') {
res.deleteCharAt(res.length() - 1);
}
return res.toString();
}
/**
* Quotes the label if required.
*
* @param lbl
* The label to be quoted
* @return The quoted label or the original label if quoting is not
* required. */
private String quote(final String lbl) {
if (lbl.indexOf(' ') == -1) {
return lbl;
}
return new StringBuilder().append('\'').append(lbl).append('\'').toString();
}
/**
* Method toString.
* @return String
*/
@Override
public String toString() {
return "PerformanceData [label=" + metric.getMetricName() + ", performanceValue=" + metric.getMetricValue() + ", unitOfMeasure=" + unitOfMeasure + ", unit=" + unit
+ ", warningRange=" + warningRange + ", criticalRange=" + criticalRange + ", minimumValue=" + metric.getMinValue() + ", maximumValue="
+ metric.getMaxValue() + "]";
}
}