Add support for Statsd metric export
This commit is contained in:
Dave Syer
committed by
Andy Wilkinson
Andy Wilkinson
parent
0fde04d325
commit
0bd845d183
@@ -0,0 +1,111 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* 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 org.springframework.boot.actuate.metrics.statsd;
|
||||
|
||||
import java.io.Closeable;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.springframework.boot.actuate.metrics.Metric;
|
||||
import org.springframework.boot.actuate.metrics.writer.Delta;
|
||||
import org.springframework.boot.actuate.metrics.writer.MetricWriter;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
import com.timgroup.statsd.NonBlockingStatsDClient;
|
||||
import com.timgroup.statsd.StatsDClientErrorHandler;
|
||||
|
||||
/**
|
||||
* A {@link MetricWriter} that pushes data to statsd. Statsd has the concept of counters
|
||||
* and gauges, but only supports gauges with data type Long, so values will be truncated
|
||||
* towards zero. Metrics whose name contains "timer." (but not "gauge." or "counter.")
|
||||
* will be treated as execution times (in statsd terms). Anything incremented is treated
|
||||
* as a counter, and anything with a snapshot value in {@link #set(Metric)} is treated as
|
||||
* a gauge.
|
||||
*
|
||||
* @author Dave Syer
|
||||
*/
|
||||
public class StatsdMetricWriter implements MetricWriter, Closeable {
|
||||
|
||||
private static Log logger = LogFactory.getLog(StatsdMetricWriter.class);
|
||||
|
||||
private final NonBlockingStatsDClient client;
|
||||
|
||||
/**
|
||||
* Create a new writer with the given parameters.
|
||||
*
|
||||
* @param host the hostname for the statsd server
|
||||
* @param port the port for the statsd server
|
||||
*/
|
||||
public StatsdMetricWriter(String host, int port) {
|
||||
this(null, host, port);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new writer with the given parameters.
|
||||
*
|
||||
* @param prefix the prefix to apply to all metric names (can be null)
|
||||
* @param host the hostname for the statsd server
|
||||
* @param port the port for the statsd server
|
||||
*/
|
||||
public StatsdMetricWriter(String prefix, String host, int port) {
|
||||
prefix = StringUtils.hasText(prefix) ? prefix : null;
|
||||
while (prefix != null && prefix.endsWith(".")) {
|
||||
prefix = prefix.substring(0, prefix.length() - 1);
|
||||
}
|
||||
this.client = new NonBlockingStatsDClient(prefix, host, port,
|
||||
new LoggingStatsdErrorHandler());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void increment(Delta<?> delta) {
|
||||
this.client.count(delta.getName(), delta.getValue().longValue());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void set(Metric<?> value) {
|
||||
String name = value.getName();
|
||||
if (name.contains("timer.") && !name.contains("gauge.")
|
||||
&& !name.contains("counter.")) {
|
||||
this.client.recordExecutionTime(name, value.getValue().longValue());
|
||||
}
|
||||
else {
|
||||
this.client.gauge(name, value.getValue().longValue());
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void reset(String name) {
|
||||
if (name.contains("counter.")) {
|
||||
this.client.gauge(name, 0L);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void close() {
|
||||
this.client.stop();
|
||||
}
|
||||
|
||||
private static final class LoggingStatsdErrorHandler implements
|
||||
StatsDClientErrorHandler {
|
||||
@Override
|
||||
public void handle(Exception e) {
|
||||
logger.debug("Failed to write metric. Exception: " + e.getClass()
|
||||
+ ", message: " + e.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Metrics integration with Statsd.
|
||||
*/
|
||||
package org.springframework.boot.actuate.metrics.statsd;
|
||||
|
||||
@@ -0,0 +1,145 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* 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 org.springframework.boot.actuate.metrics.statsd;
|
||||
|
||||
import java.net.DatagramPacket;
|
||||
import java.net.DatagramSocket;
|
||||
import java.net.SocketException;
|
||||
import java.nio.charset.Charset;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.junit.After;
|
||||
import org.junit.Test;
|
||||
import org.springframework.boot.actuate.metrics.Metric;
|
||||
import org.springframework.boot.actuate.metrics.writer.Delta;
|
||||
import org.springframework.util.SocketUtils;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests for {@link StatsdMetricWriter}.
|
||||
*
|
||||
* @author Dave Syer
|
||||
*/
|
||||
public class StatsdMetricWriterTests {
|
||||
|
||||
private int port = SocketUtils.findAvailableTcpPort();
|
||||
|
||||
private DummyStatsDServer server = new DummyStatsDServer(this.port);
|
||||
|
||||
private StatsdMetricWriter writer = new StatsdMetricWriter("me", "localhost",
|
||||
this.port);
|
||||
|
||||
@After
|
||||
public void close() {
|
||||
this.server.stop();
|
||||
this.writer.close();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void increment() {
|
||||
this.writer.increment(new Delta<Long>("counter.foo", 3L));
|
||||
this.server.waitForMessage();
|
||||
assertEquals("me.counter.foo:3|c", this.server.messagesReceived().get(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void setLongMetric() throws Exception {
|
||||
this.writer.set(new Metric<Long>("gauge.foo", 3L));
|
||||
this.server.waitForMessage();
|
||||
assertEquals("me.gauge.foo:3|g", this.server.messagesReceived().get(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void setDoubleMetric() throws Exception {
|
||||
this.writer.set(new Metric<Double>("gauge.foo", 3.7));
|
||||
this.server.waitForMessage();
|
||||
// Doubles are truncated
|
||||
assertEquals("me.gauge.foo:3|g", this.server.messagesReceived().get(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void setTimerMetric() throws Exception {
|
||||
this.writer.set(new Metric<Long>("timer.foo", 37L));
|
||||
this.server.waitForMessage();
|
||||
assertEquals("me.timer.foo:37|ms", this.server.messagesReceived().get(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void nullPrefix() throws Exception {
|
||||
this.writer = new StatsdMetricWriter("localhost", this.port);
|
||||
this.writer.set(new Metric<Long>("gauge.foo", 3L));
|
||||
this.server.waitForMessage();
|
||||
assertEquals("gauge.foo:3|g", this.server.messagesReceived().get(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void perioPrefix() throws Exception {
|
||||
this.writer = new StatsdMetricWriter("my.", "localhost", this.port);
|
||||
this.writer.set(new Metric<Long>("gauge.foo", 3L));
|
||||
this.server.waitForMessage();
|
||||
assertEquals("my.gauge.foo:3|g", this.server.messagesReceived().get(0));
|
||||
}
|
||||
|
||||
private static final class DummyStatsDServer {
|
||||
|
||||
private final List<String> messagesReceived = new ArrayList<String>();
|
||||
private final DatagramSocket server;
|
||||
|
||||
public DummyStatsDServer(int port) {
|
||||
try {
|
||||
this.server = new DatagramSocket(port);
|
||||
}
|
||||
catch (SocketException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
new Thread(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
final DatagramPacket packet = new DatagramPacket(new byte[256],
|
||||
256);
|
||||
DummyStatsDServer.this.server.receive(packet);
|
||||
DummyStatsDServer.this.messagesReceived.add(new String(packet
|
||||
.getData(), Charset.forName("UTF-8")).trim());
|
||||
}
|
||||
catch (Exception e) {
|
||||
}
|
||||
}
|
||||
}).start();
|
||||
}
|
||||
|
||||
public void stop() {
|
||||
this.server.close();
|
||||
}
|
||||
|
||||
public void waitForMessage() {
|
||||
while (this.messagesReceived.isEmpty()) {
|
||||
try {
|
||||
Thread.sleep(50L);
|
||||
}
|
||||
catch (InterruptedException e) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public List<String> messagesReceived() {
|
||||
return new ArrayList<String>(this.messagesReceived);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user