From 4b447e2520997ba3c2043238a95967103ff9e1c7 Mon Sep 17 00:00:00 2001
From: Cyrille Le Clerc <cleclerc@cloudbees.com>
Date: Fri, 20 Jan 2017 15:55:48 +0100
Subject: [PATCH] Document the `type` attribute and its values `counter` and
 `gauge`

Better documentation for https://github.com/jmxtrans/jmxtrans-agent/issues/44 and @mindkir 's https://github.com/jmxtrans/jmxtrans-agent/issues/44#issuecomment-273410751
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 1d26166f..6b5c5b6a 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,12 @@ Example - collect the `ThreadCount` attribute from the Threading MBean:
    resultAlias="jvm.thread.count"/>
 ```
 
+Example - collect the `SystemLoadAverage` gauge attribute from the OperatingSystem MBean:
+
+<query objectName="java.lang:type=OperatingSystem" attributes="SystemLoadAverage" type="gauge" resultAlias="#attribute#"/>
+
+(i) Note that the `type` attribute is customizable. Output writers such as the [LibratoWriter](https://github.com/jmxtrans/jmxtrans-agent/blob/jmxtrans-agent-1.2.4/src/main/java/org/jmxtrans/agent/LibratoWriter.java), [StatsDOutputWriter](https://github.com/jmxtrans/jmxtrans-agent/blob/jmxtrans-agent-1.2.4/src/main/java/org/jmxtrans/agent/StatsDOutputWriter.java) and [PerMinuteSummarizerOutputWriter](https://github.com/jmxtrans/jmxtrans-agent/blob/jmxtrans-agent-1.2.4/src/main/java/org/jmxtrans/agent/PerMinuteSummarizerOutputWriter.java) are aware of the `type`s `counter` and `gauge` and assume that non defined `type`means `counter`.
+
 Example - collect `ThreadCount` and `TotalStartedThreadCount` from the Threading MBean:
 
 ```xml