lib/logstash/outputs/statsd.rb in logstash-output-statsd-0.1.0 vs lib/logstash/outputs/statsd.rb in logstash-output-statsd-0.1.1
- old
+ new
@@ -6,30 +6,30 @@
# and shipping over UDP to backend services, such as Graphite or Datadog.
#
# The most basic coverage of this plugin is that the 'namespace', 'sender', and
# 'metric' names are combined into the full metric path like so:
#
-# namespace.sender.metric
+# `namespace.sender.metric`
#
# The general idea is that you send statsd count or latency data and every few
# seconds it will emit the aggregated values to the backend. Example aggregates are
-# average, max, stddev, etc.
+# `average`, `max`, `stddev`, etc.
#
# You can learn about statsd here:
#
-# * <http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/>
-# * <https://github.com/etsy/statsd>
+# * http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/[Etsy blog post announcing statsd]
+# * https://github.com/etsy/statsd[statsd on github]
#
# A simple example usage of this is to count HTTP hits by response code; to learn
-# more about that, check out the [log metrics tutorial](../tutorials/metrics-from-logs)
+# more about that, check out the ../tutorials/metrics-from-logs[log metrics tutorial]
#
# The default final metric sent to statsd would look like this:
#
-# namespace.sender.metric
+# `namespace.sender.metric`
#
# With regards to this plugin, the default namespace is "logstash", the default sender
-# is the ${host} field, and the metric name depends on what is set as the metric name
-# in the increment, decrement, timing, count, set or gauge variable.
+# is the `${host}` field, and the metric name depends on what is set as the metric name
+# in the `increment`, `decrement`, `timing`, `count, `set` or `gauge` variable.
#
class LogStash::Outputs::Statsd < LogStash::Outputs::Base
## Regex stolen from statsd code
RESERVED_CHARACTERS_REGEX = /[\:\|\@]/
config_name "statsd"