jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject [jmeter] branch master updated: docs: clarify how to use JMeter with InfluxDB 2
Date Tue, 05 May 2020 14:19:16 GMT
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


The following commit(s) were added to refs/heads/master by this push:
     new f4447f0  docs: clarify how to use JMeter with InfluxDB 2
f4447f0 is described below

commit f4447f07a6f0d2e144122a96d20dc3df35ed590b
Author: Jakub Bednar <jakub.bednar@gmail.com>
AuthorDate: Tue May 5 13:50:16 2020 +0200

    docs: clarify how to use JMeter with InfluxDB 2
    
    Based on patch by Jakub Bednář.
    Closes #588 on github
---
 .../backend/influxdb/InfluxdbBackendListenerClient.java |   2 +-
 xdocs/changes.xml                                       |   2 ++
 .../images/screenshots/backend_listener_influxdb_v2.png | Bin 0 -> 25073 bytes
 xdocs/usermanual/component_reference.xml                |   8 +++++---
 xdocs/usermanual/realtime-results.xml                   |  14 ++++++++++++++
 5 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/src/components/src/main/java/org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.java
b/src/components/src/main/java/org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.java
index 86bbd28..02c6dc1 100644
--- a/src/components/src/main/java/org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.java
+++ b/src/components/src/main/java/org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.java
@@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  * Implementation of {@link AbstractBackendListenerClient} to write in an InfluxDB using
- * custom schema
+ * custom schema; since JMeter 5.2, this also support the InfluxDB v2.
  *
  * @since 3.2
  */
diff --git a/xdocs/changes.xml b/xdocs/changes.xml
index 37142d6..0063cc3 100644
--- a/xdocs/changes.xml
+++ b/xdocs/changes.xml
@@ -223,6 +223,7 @@ Counter Config, XPath2 Extractor, Function Helper Dialog, Search popup,
JMS Elem
     <li>Updated equalsverifier to 3.1.13 (from 3.1.12)</li>
     <li>Updated xstream to 1.4.11.1 (from 1.4.11)</li>
     <li><pr>559</pr>Add a note to the source of TrustAllSSLSocketFactory,
that it is not secure to trust everyone. Based on a PR from YYTVicky (yytvicky at github)</li>
+    <li><pr>588</pr>Add documentation on usage of InfluxDB v2 for real-time
results. Based on PR from Jakub Bednář (jakub.bednar at gmail.com)</li>
 </ul>
 
  <!-- =================== Bug fixes =================== -->
@@ -305,6 +306,7 @@ Counter Config, XPath2 Extractor, Function Helper Dialog, Search popup,
JMS Elem
   <li>Keith Mo(https://github.com/keithmork)</li>
   <li>drivera-armedia (https://github.com/drivera-armedia)</li>
   <li><a href="https://ubikloadpack.com" >Ubik Load Pack</a></li>
+  <li>Jakub Bednář (jakub.bednar 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_influxdb_v2.png b/xdocs/images/screenshots/backend_listener_influxdb_v2.png
new file mode 100644
index 0000000..ca8cf67
Binary files /dev/null and b/xdocs/images/screenshots/backend_listener_influxdb_v2.png differ
diff --git a/xdocs/usermanual/component_reference.xml b/xdocs/usermanual/component_reference.xml
index bbbbd5d..153c96a 100644
--- a/xdocs/usermanual/component_reference.xml
+++ b/xdocs/usermanual/component_reference.xml
@@ -3425,8 +3425,8 @@ By default, a Graphite implementation is provided.
     <figure width="1265" height="581" image="grafana_dashboard.png">Grafana dashboard</figure>
 
 
-    <p>Since JMeter 3.2, a new implementation has been added that allows writing directly
in InfluxDB with a custom schema, it is called <code>InfluxdbBackendListenerClient</code>
-      The following parameters apply to the <apilink href="org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.html">InfluxdbBackendListenerClient</apilink>
implementation:</p>
+    <p>Since JMeter 3.2, a new implementation has been added that allows writing directly
in InfluxDB with a custom schema, it is called <code>InfluxdbBackendListenerClient</code>.
Since JMeter 5.2, <code>InfluxdbBackendListenerClient</code> supports both InfluxDB
v1 and v2.</p>
+    <p>The following parameters apply to the <apilink href="org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.html">InfluxdbBackendListenerClient</apilink>
implementation:</p>
 
     <properties>
         <property name="influxdbMetricsSender" required="Yes"><code>org.apache.jmeter.visualizers.backend.influxdb.HttpMetricsSender</code></property>
@@ -3444,7 +3444,9 @@ By default, a Graphite implementation is provided.
         List must be semicolon separated. Generally 3 or 4 values should be sufficient.</property>
         <property name="TAG_WhatEverYouWant" required="No">You can add as many custom
tags as you want. For each of them, just create a new line and prefix its name by "<code>TAG_</code>"</property>
     </properties>
-    <p>See also <a href="realtime-results.html" >Real-time results</a>
and <a href="http://docs.grafana.org/reference/annotations/#influxdb-annotations">Influxdb
annotations in Grafana</a> for more details.</p>
+    <p>See also <a href="realtime-results.html" >Real-time results</a>
and <a href="http://docs.grafana.org/reference/annotations/#influxdb-annotations">Influxdb
annotations in Grafana</a> for more details.
+        There is also a <a href="realtime-results.html#influxdb_v2">subsection on configuring
the listener for InfluxDB v2</a>.
+    </p>
 </component>
 
 <a href="#">^</a>
diff --git a/xdocs/usermanual/realtime-results.xml b/xdocs/usermanual/realtime-results.xml
index 4ad56d4..6033285 100644
--- a/xdocs/usermanual/realtime-results.xml
+++ b/xdocs/usermanual/realtime-results.xml
@@ -158,6 +158,20 @@ Installation and configuration is very easy, read this for more details
<a href=
 InfluxDB data can be easily viewed in a browser through <a href="http://grafana.org/"
 target="_blank">Grafana</a>.
 </p>
 </subsection>
+<subsection name="&sect-num;.3.2 InfluxDB 2 setup for InfluxDBBackendListenerClient"
anchor="influxdb_v2">
+    <p>
+        The configuration should specify the <code>influxdbToken</code> parameter
and also specify <code>bucket</code> and <code>org</code> as query
parameters in the <code>influxdbUrl</code>. See the <a href="https://v2.docs.influxdata.com/v2.0/api/#operation/PostWrite"
target="_blank">InfluxDB v2 API</a> for more details.
+    </p>
+    <p>
+     How to retrieve the required information in the InfluxDB UI:
+     <ul>
+         <li><a target="_blank" href="https://v2.docs.influxdata.com/v2.0/security/tokens/view-tokens/">influxdbToken</a></li>
+         <li><a target="_blank" href="https://v2.docs.influxdata.com/v2.0/organizations/buckets/view-buckets/">bucket</a></li>
+         <li><a target="_blank" href="https://v2.docs.influxdata.com/v2.0/organizations/view-orgs/">org</a></li>
+    </ul>
+    </p>
+    <figure width="882" height="428" image="backend_listener_influxdb_v2.png">InfluxDB
2 configuration</figure>
+</subsection>
 </subsection>
 
 <subsection name="&sect-num;.4 Grafana configuration" anchor="grafana_configuration">


Mime
View raw message