Skip to content

docs: clarify how to use JMeter with InfluxDB 2 #588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bednar wants to merge 1 commit into from
Closed

docs: clarify how to use JMeter with InfluxDB 2 #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...in/java/org/apache/jmeter/visualizers/backend/influxdb/InfluxdbBackendListenerClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

/**
* Implementation of {@link AbstractBackendListenerClient} to write in an InfluxDB using
* custom schema
* custom schema; since JMeter 5.2, a implementation also support the InfluxDB 2.
*
* @since 3.2
*/
Expand Down
Binary file added xdocs/images/screenshots/backend_listener_influxdb_v2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions xdocs/usermanual/component_reference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, the <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>
Expand All @@ -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" >documentation</a> how to configure listener with InfluxDB 2.
</p>
</component>

<a href="#">^</a>
Expand Down
14 changes: 14 additions & 0 deletions xdocs/usermanual/realtime-results.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 a query parameters in the <code>influxdbUrl</code>. Read this for more detail <a href="https://v2.docs.influxdata.com/v2.0/api/#operation/PostWrite" target="_blank">InfluxDB v2 API</a>.
</p>
<p>
How to retrieve a 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">
Expand Down