/**
* StatsdClient.java
*
* (C) 2011 Meetup, Inc.
* Author: Andrew Gwozdziewycz <andrew@meetup.com>, @apgwoz
*
*
*
* Example usage:
*
* StatsdClient client = new StatsdClient("statsd.example.com", 8125);
* // increment by 1
* client.increment("foo.bar.baz");
* // increment by 10
* client.increment("foo.bar.baz", 10);
* // sample rate
* client.increment("foo.bar.baz", 10, .1);
* // increment multiple keys by 1
* client.increment("foo.bar.baz", "foo.bar.boo", "foo.baz.bar");
* // increment multiple keys by 10 -- yeah, it's "backwards"
* client.increment(10, "foo.bar.baz", "foo.bar.boo", "foo.baz.bar");
* // multiple keys with a sample rate
* client.increment(10, .1, "foo.bar.baz", "foo.bar.boo", "foo.baz.bar");
*
* // To enable multi metrics (aka more than 1 metric in a UDP packet) (disabled by default)
* client.enableMultiMetrics(true); //disable by passing in false
* // To fine-tune udp packet buffer size (default=1500)
* client.setBufferSize((short) 1500);
* // To force flush the buffer out (good idea to add to your shutdown path)
* client.flush();
*
*
* Note: For best results, and greater availability, you'll probably want to
* create a wrapper class which creates a static client and proxies to it.
*
* You know... the "Java way."
*
* Copyright (c) 2010-2016 Etsy
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
*
* ZAP Changes:
* Originally copied from https://github.com/etsy/statsd/blob/master/examples/StatsdClient.java
* Added License from https://github.com/etsy/statsd/blob/master/LICENSE
*
*/
package org.zaproxy.zap.extension.stats;
import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.StandardSocketOptions;
import java.net.UnknownHostException;
import java.nio.ByteBuffer;
import java.nio.channels.DatagramChannel;
import java.util.Locale;
import java.util.Random;
import java.util.Timer;
import java.util.TimerTask;
import org.apache.log4j.Logger;
public class StatsdClient extends TimerTask {
private ByteBuffer sendBuffer;
private Timer flushTimer;
private boolean multi_metrics = false;
private static final Random RNG = new Random();
private static final Logger log = Logger.getLogger(StatsdClient.class.getName());
private final InetSocketAddress _address;
private final DatagramChannel _channel;
public StatsdClient(String host, int port) throws UnknownHostException, IOException {
this(InetAddress.getByName(host), port);
}
public StatsdClient(InetAddress host, int port) throws IOException {
_address = new InetSocketAddress(host, port);
_channel = DatagramChannel.open();
/* Put this in non-blocking mode so send does not block forever. */
_channel.configureBlocking(false);
/* Increase the size of the output buffer so that the size is larger than our buffer size. */
_channel.setOption(StandardSocketOptions.SO_SNDBUF, 4096);
setBufferSize((short) 1500);
}
protected void finalize() {
flush();
}
public synchronized void setBufferSize(short packetBufferSize) {
if(sendBuffer != null) {
flush();
}
sendBuffer = ByteBuffer.allocate(packetBufferSize);
}
public synchronized void enableMultiMetrics(boolean enable) {
multi_metrics = enable;
}
public synchronized boolean startFlushTimer(long period) {
if(flushTimer == null) {
// period is in msecs
if(period <= 0) { period = 2000; }
flushTimer = new Timer();
// We pass this object in as the TimerTask (which calls run())
flushTimer.schedule((TimerTask)this, period, period);
return true;
}
return false;
}
public synchronized void stopFlushTimer() {
if(flushTimer != null) {
flushTimer.cancel();
flushTimer = null;
}
}
public void run() { // used by Timer, we're a Runnable TimerTask
flush();
}
public boolean timing(String key, int value) {
return timing(key, value, 1.0);
}
public boolean timing(String key, int value, double sampleRate) {
return send(sampleRate, String.format(Locale.ENGLISH, "%s:%d|ms", key, value));
}
public boolean decrement(String key) {
return increment(key, -1, 1.0);
}
public boolean decrement(String key, int magnitude) {
return decrement(key, magnitude, 1.0);
}
public boolean decrement(String key, int magnitude, double sampleRate) {
magnitude = magnitude < 0 ? magnitude : -magnitude;
return increment(key, magnitude, sampleRate);
}
public boolean decrement(String... keys) {
return increment(-1, 1.0, keys);
}
public boolean decrement(int magnitude, String... keys) {
magnitude = magnitude < 0 ? magnitude : -magnitude;
return increment(magnitude, 1.0, keys);
}
public boolean decrement(int magnitude, double sampleRate, String... keys) {
magnitude = magnitude < 0 ? magnitude : -magnitude;
return increment(magnitude, sampleRate, keys);
}
public boolean increment(String key) {
return increment(key, 1, 1.0);
}
public boolean increment(String key, int magnitude) {
return increment(key, magnitude, 1.0);
}
public boolean increment(String key, int magnitude, double sampleRate) {
String stat = String.format(Locale.ENGLISH, "%s:%s|c", key, magnitude);
return send(sampleRate, stat);
}
public boolean increment(int magnitude, double sampleRate, String... keys) {
String[] stats = new String[keys.length];
for (int i = 0; i < keys.length; i++) {
stats[i] = String.format(Locale.ENGLISH, "%s:%s|c", keys[i], magnitude);
}
return send(sampleRate, stats);
}
public boolean gauge(String key, double magnitude){
return gauge(key, magnitude, 1.0);
}
public boolean gauge(String key, double magnitude, double sampleRate){
final String stat = String.format(Locale.ENGLISH, "%s:%s|g", key, magnitude);
return send(sampleRate, stat);
}
private boolean send(double sampleRate, String... stats) {
boolean retval = false; // didn't send anything
if (sampleRate < 1.0) {
for (String stat : stats) {
if (RNG.nextDouble() <= sampleRate) {
stat = String.format(Locale.ENGLISH, "%s|@%f", stat, sampleRate);
if (doSend(stat)) {
retval = true;
}
}
}
} else {
for (String stat : stats) {
if (doSend(stat)) {
retval = true;
}
}
}
return retval;
}
private synchronized boolean doSend(String stat) {
try {
final byte[] data = stat.getBytes("utf-8");
// If we're going to go past the threshold of the buffer then flush.
// the +1 is for the potential '\n' in multi_metrics below
if(sendBuffer.remaining() < (data.length + 1)) {
flush();
}
if(sendBuffer.position() > 0) { // multiple metrics are separated by '\n'
sendBuffer.put( (byte) '\n');
}
sendBuffer.put(data); // append the data
if(! multi_metrics) {
flush();
}
return true;
} catch (IOException e) {
log.error(
String.format("Could not send stat %s to host %s:%d", sendBuffer.toString(), _address.getHostName(),
_address.getPort()), e);
return false;
}
}
public synchronized boolean flush() {
try {
final int sizeOfBuffer = sendBuffer.position();
if(sizeOfBuffer <= 0) { return false; } // empty buffer
// send and reset the buffer
sendBuffer.flip();
final int nbSentBytes = _channel.send(sendBuffer, _address);
sendBuffer.limit(sendBuffer.capacity());
sendBuffer.rewind();
if (sizeOfBuffer == nbSentBytes) {
return true;
} else {
log.error(String.format(
"Could not send entirely stat %s to host %s:%d. Only sent %d bytes out of %d bytes", sendBuffer.toString(),
_address.getHostName(), _address.getPort(), nbSentBytes, sizeOfBuffer));
return false;
}
} catch (IOException e) {
/* This would be a good place to close the channel down and recreate it. */
log.error(
String.format("Could not send stat %s to host %s:%d", sendBuffer.toString(), _address.getHostName(),
_address.getPort()), e);
return false;
}
}
}