Bug 61714 - Grafana config example obsolete
Summary: Grafana config example obsolete
Status: RESOLVED FIXED
Alias: None
Product: JMeter
Classification: Unclassified
Component: Main (show other bugs)
Version: 3.3
Hardware: All All
: P2 enhancement (vote)
Target Milestone: ---
Assignee: JMeter issues mailing list
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-11-02 21:07 UTC by Ray
Modified: 2018-04-21 21:21 UTC (History)
2 users (show)



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ray 2017-11-02 21:07:10 UTC
In http://jmeter.apache.org/usermanual/realtime-results.html section 15.4 the configuration of Grafana is described. The provided information is, however, obsolete for Grafana 2.x see: http://docs.grafana.org/installation/migrating_to2/#adding-data-sources section.

I would assume that #15.3 is also obsolete as creating a grafana database shouldn't be needed anymore.
Comment 1 Philippe Mouawad 2017-11-02 23:25:57 UTC
Thanks for report.
Would you like to contribute a PR fixing this documentation ?:

- http://jmeter.apache.org/building.html => Contributing to JMeter
Comment 2 Antonio Gomes Rodrigues 2018-04-21 21:21:50 UTC
Hi,

Doc updated

Author: agomes
Date: Sat Apr 21 21:15:50 2018
New Revision: 1829749

URL: http://svn.apache.org/viewvc?rev=1829749&view=rev
Log:
Bug 61714 - Grafana config example obsolete - update the doc of Real-time results

Removed:
    jmeter/trunk/docs/images/screenshots/if_controller_expression.png
    jmeter/trunk/docs/images/screenshots/if_controller_javascript.png
    jmeter/trunk/docs/images/screenshots/if_controller_variable.png
Modified:
    jmeter/trunk/xdocs/changes.xml
    jmeter/trunk/xdocs/images/screenshots/backend_listener.png
    jmeter/trunk/xdocs/usermanual/realtime-results.xml

Modified: jmeter/trunk/xdocs/changes.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/changes.xml?rev=1829749&r1=1829748&r2=1829749&view=diff
==============================================================================
--- jmeter/trunk/xdocs/changes.xml [utf-8] (original)
+++ jmeter/trunk/xdocs/changes.xml [utf-8] Sat Apr 21 21:15:50 2018
@@ -142,6 +142,7 @@ this behaviour, set <code>httpclient.res
   <li><bug>62239</bug>Add ability to Break Current Loop</li>
   <li><bug>62065</bug>Use Maven artifact for JAF Module instead of embedded module</li>
   <li><pr>379</pr> Improve chinese translations. Contributed by XmeterNet</li>
+  <li><bug>61714</bug>Update Real-time results documentation</li>
 </ul>

 <ch_section>Non-functional changes</ch_section>

Modified: jmeter/trunk/xdocs/images/screenshots/backend_listener.png
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/backend_listener.png?rev=1829749&r1=1829748&r2=1829749&view=diff
==============================================================================
Binary files - no diff available.

Modified: jmeter/trunk/xdocs/usermanual/realtime-results.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/realtime-results.xml?rev=1829749&r1=1829748&r2=1829749&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/realtime-results.xml (original)
+++ jmeter/trunk/xdocs/usermanual/realtime-results.xml Sat Apr 21 21:15:50 2018
@@ -138,71 +138,34 @@ In this document we will present the con
 </subsection>
 <subsection name="&sect-num;.2 JMeter configuration" anchor="jmeter-configuration">
     <p>
-    To make JMeter send metrics to backend add a <a href="./component_reference.html#Backend_Listener" >BackendListener</a> using the GraphiteBackendListenerClient.
+    To make JMeter send metrics to backend add a <a href="./component_reference.html#Backend_Listener" >BackendListener</a> using the InfluxDBBackendListenerClient.
     </p>
-    <figure width="902" height="341" image="backend_listener.png">Graphite configuration</figure>
+    <figure width="902" height="341" image="backend_listener.png">InfluxDB configuration</figure>
 </subsection>

 <subsection name="&sect-num;.3 InfluxDB database configuration" anchor="influxdb_db_configuration">
-    <p>Connect to InfluxDB using <a href="https://docs.influxdata.com/influxdb/v1.1/introduction/getting_started/" >influx shell</a> and <a href="https://docs.influxdata.com/influxdb/v1.1/query_language/database_management/" >create two databases</a>:
+    <p>Connect to InfluxDB using <a href="https://docs.influxdata.com/influxdb/latest/introduction/getting_started/" >InfluxDB’s Command Line Interface (CLI).</a> and <a href="https://docs.influxdata.com/influxdb/latest/query_language/database_management/" >create JMeter database</a>:
     <ul>
-        <li>grafana : Used by Grafana to store the dashboards we will create</li>
-        <li>jmeter : Used by InfluxDB to store the data sent to Graphite Listener as per database="jmeter" config
-        element in <code>influxdb.conf</code> or <code>config.toml</code></li>
+        <li>jmeter : Used by InfluxDB to store the data sent by the Backend Listener</li>
     </ul>
+    You can do it too by using the HTTP API.
     </p>

 <subsection name="&sect-num;.3.1 InfluxDB setup for InfluxDBBackendListenerClient" anchor="influxdb">
 <p>InfluxDB is an open-source, distributed, time-series database that allows to
 easily store metrics.
-Installation and configuration is very easy, read this for more details <a href="https://docs.influxdata.com/influxdb/v1.1/introduction/installation/" target="_blank" >InfluxDB documentation</a>.<br/>
-InfluxDB data can be easily viewed in a browser through either <a href="https://github.com/hakobera/influga"  target="_blank">Influga</a> or <a href="http://grafana.org/"  target="_blank">Grafana</a>.
-We will use Grafana in this case.
-<b>There is no particular configuration to setup when using <code>InfluxDBBackendListenerClient</code></b>
+Installation and configuration is very easy, read this for more details <a href="https://docs.influxdata.com/influxdb/latest/introduction/installation/" target="_blank" >InfluxDB documentation</a>.<br/>
+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 setup for GraphiteBackendListenerClient" anchor="influxdb_through_graphite_configuration">
-    <p>To enable Graphite listener in InfluxDB for <code>GraphiteBackendListenerClient</code>, edit files <code>/opt/influxdb/shared/config.toml</code> or <code>/usr/local/etc/influxdb.conf</code>,
-    find "<code>[[graphite]]</code>" and set this:
-    </p>
-    <source>
-# Configure the graphite api
-[[graphite]]
-enabled = true
-bind-address = ":2003" # If not set, is actually set to bind-address.
-database = "jmeter"  # store graphite data in this database
-    </source>
-</subsection>
 </subsection>

 <subsection name="&sect-num;.4 Grafana configuration" anchor="grafana_configuration">
     <p>
-    Installing grafana is just a matter of putting the unzipped bundle behind an Apache HTTP server.<br/>
-    Read <a href="http://grafana.org/docs/" target="_blank">documentation</a> for more details.
-    Open <code>config.js</code> file and find <code>datasources</code> element, and edit it like this:<br/>
+    Installing grafana<br/>
+    Read <a href="http://docs.grafana.org/" target="_blank">documentation</a> for more details.
+    Add the <a href="http://docs.grafana.org/features/datasources/influxdb/" target="_blank">datasource</a><br/>
     </p>
-    <source>
-datasources: {
-  influxdb: {
-    type: 'influxdb',
-    url: "http://influx_db_host:8086/db/jmeter",
-    username: 'root',
-    password: 'root',
-  },
-  grafana: {
-    type: 'influxdb',
-    url: "http://influx_db_host:8086/db/grafana",
-    username: 'root',
-    password: 'root',
-    grafanaDB: true
-  },
-},
-    </source>
-    <note>
-    Note that grafana has "<code>grafanaDB:true</code>". Also note that here we use <code>root</code> user for simplicity
-    It is better to dedicate a special user with restricted rights.
-    </note>
     Here is the kind of dashboard that you could obtain:
     <figure width="1265" height="581" image="grafana_dashboard.png">Grafana dashboard</figure>
 </subsection>