[jmeter] 01/02: Write graphite guide in realtime section

[fs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

fschumacher pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jmeter.git

commit 4ea72b5028e3eeac531777496a3a6349064a9fe8
Author: shblue21 <sh...@naver.com>
AuthorDate: Mon Feb 21 13:32:29 2022 +0900

    Write graphite guide in realtime section
    
    write graphite setting, in realtime section,
    with simple pickle protocol
    
    Closes #699
---
 xdocs/changes.xml                                       |   2 ++
 xdocs/images/screenshots/backend_listener_graphite.png  | Bin 0 -> 5760 bytes
 .../screenshots/backend_listener_graphite_pickle.png    | Bin 0 -> 1929 bytes
 xdocs/usermanual/realtime-results.xml                   |  16 ++++++++++++++--
 4 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/xdocs/changes.xml b/xdocs/changes.xml
index 833fd2c..f72c51c 100644
--- a/xdocs/changes.xml
+++ b/xdocs/changes.xml
@@ -145,6 +145,7 @@ however, the profile can't be updated while the test is running.
   <li><bug>65611</bug><pr>673</pr>Add support for IPv6 addresses when specifying a remote worker node. Based on a patch by Peter Wong (peter.wong at csexperts.com)</li>
   <li>Reduce memory consumption by the logging panel (disable undo events for it)</li>
   <li><bug>63620</bug><pr>694</pr>Fix GUI freeze when viewing response body with long line breaks</li>
+  <li><pr>699</pr>Add documentation for Graphite Backend Listener. Contributed by Ji Hun (jihunkimkw at gmail.com)</li>
 </ul>
 
 <ch_section>Non-functional changes</ch_section>
@@ -304,6 +305,7 @@ however, the profile can't be updated while the test is running.
   <li>Magnus Spångdal (magnus.spangdal as avanza.se)</li>
   <li>Piotr Smietana (piotrsmietana1998 at gmail.com)</li>
   <li>Sampath Kumar Krishnasamy (sampathkumar.krishnasamykuppusamy at aexp.com)</li>
+  <li>Ji Hun (jihunkimkw at gmail.com)</li>
 </ul>
 <p>We also thank bug reporters who helped us improve JMeter.</p>
 <ul>
diff --git a/xdocs/images/screenshots/backend_listener_graphite.png b/xdocs/images/screenshots/backend_listener_graphite.png
new file mode 100644
index 0000000..d952b22
Binary files /dev/null and b/xdocs/images/screenshots/backend_listener_graphite.png differ
diff --git a/xdocs/images/screenshots/backend_listener_graphite_pickle.png b/xdocs/images/screenshots/backend_listener_graphite_pickle.png
new file mode 100644
index 0000000..a314543
Binary files /dev/null and b/xdocs/images/screenshots/backend_listener_graphite_pickle.png differ
diff --git a/xdocs/usermanual/realtime-results.xml b/xdocs/usermanual/realtime-results.xml
index 3ba3d7c..5fc9538 100644
--- a/xdocs/usermanual/realtime-results.xml
+++ b/xdocs/usermanual/realtime-results.xml
@@ -186,10 +186,22 @@ InfluxDB data can be easily viewed in a browser through <a href="http://grafana.
     <figure width="1265" height="581" image="grafana_dashboard.png">Grafana dashboard</figure>
 </subsection>
 
-<subsection name="&sect-num;.5 Graphite" anchor="graphite">
-<p>HELP WELCOME for this section, see <a href="../building.html" >Contributing documentation</a></p>
+<subsection name="&sect-num;.5 Graphite Configuration" anchor="graphite_configuration">
+    <p>To make JMeter send metrics to backend, add a BackendListener using the GraphiteBackendListenerClient.</p>
+    <p><a href="./component_reference.html#Backend_Listener">GraphiteBackendListenerClient</a> section will help you do the configuration.</p>
+    <figure width="902" height="341" image="backend_listener_graphite.png">Graphite configuration</figure>
 </subsection>
 
+<subsection name="&sect-num;.5.1 Graphite Sender" anchor="graphite_sendor">
+    <p>Two types of Senders are available. TextGraphiteMetricsSender, PickleGraphiteMetricsSender</p>
+    <ul>
+        <li>For plaintext protocol, set graphiteMetricsSender parameter to <code>org.apache.jmeter.visualizers.backend.graphite.TextGraphiteMetricsSender</code></li>
+        <li>For pickle protocol, set graphiteMetricsSender parameter to <code>org.apache.jmeter.visualizers.backend.graphite.PickleGraphiteMetricsSender</code></li>
+    </ul>    
+    <p>To send large amounts of data, use the Pickle sender. It is an efficient transmission method compared to textplain.
+    Read this for more details <a href="https://graphite.readthedocs.io/en/latest/feeding-carbon.html" target="_blank">Graphite documentation.</a></p>
+    <figure width="902" height="341" image="backend_listener_graphite_pickle.png">Graphite pickle sender</figure>
+</subsection>
 </section>
 
 </body>