blob: 80166491491096d704fdd4b702488380a17e86e3 [file]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Apache Zeppelin 0.10.1 Documentation: InfluxDB Interpreter for Apache Zeppelin</title>
<meta name="description" content="InfluxDB is an open-source time series database designed to handle high write and query loads.">
<meta name="author" content="The Apache Software Foundation">
<!-- Enable responsive viewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="/docs/0.10.1/assets/themes/zeppelin/font-awesome.min.css" rel="stylesheet">
<!-- Le styles -->
<link href="/docs/0.10.1/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="/docs/0.10.1/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
<link href="/docs/0.10.1/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
<!-- Le fav and touch icons -->
<!-- Update these with your own images
<link rel="shortcut icon" href="images/favicon.ico">
<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
-->
<!-- Js -->
<script src="/docs/0.10.1/assets/themes/zeppelin/jquery-1.10.2.min.js"></script>
<script src="/docs/0.10.1/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
<script src="/docs/0.10.1/assets/themes/zeppelin/js/docs.js"></script>
<script src="/docs/0.10.1/assets/themes/zeppelin/js/anchor.min.js"></script>
<script src="/docs/0.10.1/assets/themes/zeppelin/js/toc.js"></script>
<script src="/docs/0.10.1/assets/themes/zeppelin/js/lunr.min.js"></script>
<script src="/docs/0.10.1/assets/themes/zeppelin/js/search.js"></script>
<!-- atom & rss feed -->
<link href="/docs/0.10.1/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
<link href="/docs/0.10.1/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(["setDoNotTrack", true]);
_paq.push(["disableCookies"]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '69']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body>
<div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container navbar-container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="navbar-brand">
<a class="navbar-brand-main" href="http://zeppelin.apache.org">
<img src="/docs/0.10.1/assets/themes/zeppelin/img/zeppelin_logo.png" width="50"
style="margin-top: -2px;" alt="I'm zeppelin">
<span style="margin-left: 5px; font-size: 27px;">Zeppelin</span>
<a class="navbar-brand-version" href="/docs/0.10.1"
style="font-size: 15px; color: white;"> 0.10.1
</a>
</a>
</div>
</div>
<nav class="navbar-collapse collapse" role="navigation">
<ul class="nav navbar-nav">
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="title"><span>Getting Started</span></li>
<li><a href="/docs/0.10.1/quickstart/install.html">Install</a></li>
<li><a href="/docs/0.10.1/quickstart/explore_ui.html">Explore UI</a></li>
<li><a href="/docs/0.10.1/quickstart/tutorial.html">Tutorial</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Run Mode</span></li>
<li><a href="/docs/0.10.1/quickstart/kubernetes.html">Kubernetes</a></li>
<li><a href="/docs/0.10.1/quickstart/docker.html">Docker</a></li>
<li><a href="/docs/0.10.1/quickstart/yarn.html">Yarn</a></li>
<li role="separator" class="divider"></li>
<li><a href="/docs/0.10.1/quickstart/spark_with_zeppelin.html">Spark with Zeppelin</a></li>
<li><a href="/docs/0.10.1/quickstart/flink_with_zeppelin.html">Flink with Zeppelin</a></li>
<li><a href="/docs/0.10.1/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
<li><a href="/docs/0.10.1/quickstart/python_with_zeppelin.html">Python with Zeppelin</a></li>
<li><a href="/docs/0.10.1/quickstart/r_with_zeppelin.html">R with Zeppelin</a></li>
</ul>
</li>
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Usage<b class="caret"></b></a>
<ul class="dropdown-menu scrollable-menu">
<li class="title"><span>Dynamic Form</span></li>
<li><a href="/docs/0.10.1/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Display System</span></li>
<li><a href="/docs/0.10.1/usage/display_system/basic.html#text">Text Display</a></li>
<li><a href="/docs/0.10.1/usage/display_system/basic.html#html">HTML Display</a></li>
<li><a href="/docs/0.10.1/usage/display_system/basic.html#table">Table Display</a></li>
<li><a href="/docs/0.10.1/usage/display_system/basic.html#network">Network Display</a></li>
<li><a href="/docs/0.10.1/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li>
<li><a href="/docs/0.10.1/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Interpreter</span></li>
<li><a href="/docs/0.10.1/usage/interpreter/overview.html">Overview</a></li>
<li><a href="/docs/0.10.1/usage/interpreter/interpreter_binding_mode.html">Interpreter Binding Mode</a></li>
<li><a href="/docs/0.10.1/usage/interpreter/user_impersonation.html">User Impersonation</a></li>
<li><a href="/docs/0.10.1/usage/interpreter/dependency_management.html">Dependency Management</a></li>
<li><a href="/docs/0.10.1/usage/interpreter/installation.html">Installing Interpreters</a></li>
<!--<li><a href="/docs/0.10.1/usage/interpreter/dynamic_loading.html">Dynamic Interpreter Loading (Experimental)</a></li>-->
<li><a href="/docs/0.10.1/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Other Features</span></li>
<li><a href="/docs/0.10.1/usage/other_features/publishing_paragraphs.html">Publishing Paragraphs</a></li>
<li><a href="/docs/0.10.1/usage/other_features/personalized_mode.html">Personalized Mode</a></li>
<li><a href="/docs/0.10.1/usage/other_features/customizing_homepage.html">Customizing Zeppelin Homepage</a></li>
<li><a href="/docs/0.10.1/usage/other_features/notebook_actions.html">Notebook Actions</a></li>
<li><a href="/docs/0.10.1/usage/other_features/cron_scheduler.html">Cron Scheduler</a></li>
<li><a href="/docs/0.10.1/usage/other_features/zeppelin_context.html">Zeppelin Context</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>REST API</span></li>
<li><a href="/docs/0.10.1/usage/rest_api/interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.10.1/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li>
<li><a href="/docs/0.10.1/usage/rest_api/notebook.html">Notebook API</a></li>
<li><a href="/docs/0.10.1/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li>
<li><a href="/docs/0.10.1/usage/rest_api/configuration.html">Configuration API</a></li>
<li><a href="/docs/0.10.1/usage/rest_api/credential.html">Credential API</a></li>
<li><a href="/docs/0.10.1/usage/rest_api/helium.html">Helium API</a></li>
<li class="title"><span>Zeppelin SDK</span></li>
<li><a href="/docs/0.10.1/usage/zeppelin_sdk/client_api.html">Client API</a></li>
<li><a href="/docs/0.10.1/usage/zeppelin_sdk/session_api.html">Session API</a></li>
</ul>
</li>
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b class="caret"></b></a>
<ul class="dropdown-menu scrollable-menu">
<li class="title"><span>Basics</span></li>
<li><a href="/docs/0.10.1/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
<li><a href="/docs/0.10.1/setup/basics/hadoop_integration.html">Hadoop Integration</a></li>
<li><a href="/docs/0.10.1/setup/basics/multi_user_support.html">Multi-user Support</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Deployment</span></li>
<!--<li><a href="/docs/0.10.1/setup/deployment/docker.html">Docker Image for Zeppelin</a></li>-->
<li><a href="/docs/0.10.1/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark Cluster Mode: Standalone</a></li>
<li><a href="/docs/0.10.1/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark Cluster Mode: YARN</a></li>
<li><a href="/docs/0.10.1/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark Cluster Mode: Mesos</a></li>
<li><a href="/docs/0.10.1/setup/deployment/flink_and_spark_cluster.html">Zeppelin with Flink, Spark Cluster</a></li>
<li><a href="/docs/0.10.1/setup/deployment/cdh.html">Zeppelin on CDH</a></li>
<li><a href="/docs/0.10.1/setup/deployment/virtual_machine.html">Zeppelin on VM: Vagrant</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Security</span></li>
<li><a href="/docs/0.10.1/setup/security/authentication_nginx.html">HTTP Basic Auth using NGINX</a></li>
<li><a href="/docs/0.10.1/setup/security/shiro_authentication.html">Shiro Authentication</a></li>
<li><a href="/docs/0.10.1/setup/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="/docs/0.10.1/setup/security/datasource_authorization.html">Data Source Authorization</a></li>
<li><a href="/docs/0.10.1/setup/security/http_security_headers.html">HTTP Security Headers</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Notebook Storage</span></li>
<li><a href="/docs/0.10.1/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
<li><a href="/docs/0.10.1/setup/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
<li><a href="/docs/0.10.1/setup/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
<li><a href="/docs/0.10.1/setup/storage/storage.html#notebook-storage-in-oss">OSS Storage</a></li>
<li><a href="/docs/0.10.1/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
<li><a href="/docs/0.10.1/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Operation</span></li>
<li><a href="/docs/0.10.1/setup/operation/configuration.html">Configuration</a></li>
<li><a href="/docs/0.10.1/setup/operation/proxy_setting.html">Proxy Setting</a></li>
<li><a href="/docs/0.10.1/setup/operation/upgrading.html">Upgrading</a></li>
<li><a href="/docs/0.10.1/setup/operation/trouble_shooting.html">Trouble Shooting</a></li>
</ul>
</li>
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
<ul class="dropdown-menu scrollable-menu">
<li class="title"><span>Interpreters</span></li>
<li><a href="/docs/0.10.1/usage/interpreter/overview.html">Overview</a></li>
<li role="separator" class="divider"></li>
<li><a href="/docs/0.10.1/interpreter/spark.html">Spark</a></li>
<li><a href="/docs/0.10.1/interpreter/flink.html">Flink</a></li>
<li><a href="/docs/0.10.1/interpreter/jdbc.html">JDBC</a></li>
<li><a href="/docs/0.10.1/interpreter/python.html">Python</a></li>
<li><a href="/docs/0.10.1/interpreter/r.html">R</a></li>
<li role="separator" class="divider"></li>
<li><a href="/docs/0.10.1/interpreter/alluxio.html">Alluxio</a></li>
<li><a href="/docs/0.10.1/interpreter/beam.html">Beam</a></li>
<li><a href="/docs/0.10.1/interpreter/bigquery.html">BigQuery</a></li>
<li><a href="/docs/0.10.1/interpreter/cassandra.html">Cassandra</a></li>
<li><a href="/docs/0.10.1/interpreter/elasticsearch.html">Elasticsearch</a></li>
<li><a href="/docs/0.10.1/interpreter/geode.html">Geode</a></li>
<li><a href="/docs/0.10.1/interpreter/groovy.html">Groovy</a></li>
<li><a href="/docs/0.10.1/interpreter/hazelcastjet.html">Hazelcast Jet</a></li>
<li><a href="/docs/0.10.1/interpreter/hbase.html">HBase</a></li>
<li><a href="/docs/0.10.1/interpreter/hdfs.html">HDFS</a></li>
<li><a href="/docs/0.10.1/interpreter/hive.html">Hive</a></li>
<li><a href="/docs/0.10.1/interpreter/ignite.html">Ignite</a></li>
<li><a href="/docs/0.10.1/interpreter/influxdb.html">influxDB</a></li>
<li><a href="/docs/0.10.1/interpreter/java.html">Java</a></li>
<li><a href="/docs/0.10.1/interpreter/jupyter.html">Jupyter</a></li>
<li><a href="/docs/0.10.1/interpreter/kotlin.html">Kotlin</a></li>
<li><a href="/docs/0.10.1/interpreter/ksql.html">KSQL</a></li>
<li><a href="/docs/0.10.1/interpreter/kylin.html">Kylin</a></li>
<li><a href="/docs/0.10.1/interpreter/lens.html">Lens</a></li>
<li><a href="/docs/0.10.1/interpreter/livy.html">Livy</a></li>
<li><a href="/docs/0.10.1/interpreter/mahout.html">Mahout</a></li>
<li><a href="/docs/0.10.1/interpreter/markdown.html">Markdown</a></li>
<li><a href="/docs/0.10.1/interpreter/mongodb.html">MongoDB</a></li>
<li><a href="/docs/0.10.1/interpreter/neo4j.html">Neo4j</a></li>
<li><a href="/docs/0.10.1/interpreter/pig.html">Pig</a></li>
<li><a href="/docs/0.10.1/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
<li><a href="/docs/0.10.1/interpreter/sap.html">SAP</a></li>
<li><a href="/docs/0.10.1/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.10.1/interpreter/scio.html">Scio</a></li>
<li><a href="/docs/0.10.1/interpreter/shell.html">Shell</a></li>
<li><a href="/docs/0.10.1/interpreter/sparql.html">Sparql</a></li>
<li><a href="/docs/0.10.1/interpreter/submarine.html">Submarine</a></li>
</ul>
</li>
<li>
<a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a>
<ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;">
<li class="title"><span>Extending Zeppelin</span></li>
<li><a href="/docs/0.10.1/development/writing_zeppelin_interpreter.html">Writing Zeppelin Interpreter</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Helium (Experimental)</span></li>
<li><a href="/docs/0.10.1/development/helium/overview.html">Overview</a></li>
<li><a href="/docs/0.10.1/development/helium/writing_application.html">Writing Helium Application</a></li>
<li><a href="/docs/0.10.1/development/helium/writing_spell.html">Writing Helium Spell</a></li>
<li><a href="/docs/0.10.1/development/helium/writing_visualization_basic.html">Writing Helium Visualization: Basics</a></li>
<li><a href="/docs/0.10.1/development/helium/writing_visualization_transformation.html">Writing Helium Visualization: Transformation</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>Contributing to Zeppelin</span></li>
<li><a href="/docs/0.10.1/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
<li><a href="/docs/0.10.1/development/contribution/useful_developer_tools.html">Useful Developer Tools</a></li>
<li><a href="/docs/0.10.1/development/contribution/how_to_contribute_code.html">How to Contribute (code)</a></li>
<li><a href="/docs/0.10.1/development/contribution/how_to_contribute_website.html">How to Contribute (website)</a></li>
<li role="separator" class="divider"></li>
<li class="title"><span>External Resources</span></li>
<li><a target="_blank" rel="noopener noreferrer" href="https://zeppelin.apache.org/community.html">Mailing List</a></li>
<li><a target="_blank" rel="noopener noreferrer" href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home">Apache Zeppelin Wiki</a></li>
<li><a target="_blank" rel="noopener noreferrer" href="http://stackoverflow.com/questions/tagged/apache-zeppelin">Stackoverflow Questions about Zeppelin</a></li>
</ul>
</li>
<li>
<a href="/docs/0.10.1/search.html" class="nav-search-link">
<span class="fa fa-search nav-search-icon"></span>
</a>
</li>
</ul>
</nav><!--/.navbar-collapse -->
</div>
</div>
<div class="content">
<!--<div class="hero-unit InfluxDB Interpreter for Apache Zeppelin">
<h1></h1>
</div>
-->
<div class="row">
<div class="col-md-12">
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<h1>InfluxDB Interpreter for Apache Zeppelin</h1>
<div id="toc"></div>
<h2>Overview</h2>
<p><a href="https://v2.docs.influxdata.com/v2.0/">InfluxDB</a> is an open-source time series database (TSDB) developed by InfluxData. It is written in Go and optimized for fast, high-availability storage and retrieval of time series data in fields such as operations monitoring, application metrics, Internet of Things sensor data, and real-time analytics.
This interpreter allows to perform queries in <a href="https://v2.docs.influxdata.com/v2.0/reference/flux/">Flux Language</a> in Zeppelin Notebook.</p>
<h3>Notes</h3>
<ul>
<li>This interpreter is compatible with InfluxDB 1.8+ and InfluxDB 2.0+ (v2 API, Flux language)</li>
<li>Code complete and syntax highlighting is not supported for now</li>
</ul>
<h3>Example notebook</h3>
<p><img src="/docs/0.10.1/assets/themes/zeppelin/img/docs-img/influxdb1.png" alt="InfluxDB notebook"></p>
<h3>Configuration</h3>
<table class="table-configuration">
<tr>
<th>Property</th>
<th>Default</th>
<th>Value</th>
</tr>
<tr>
<td>influxdb.url</td>
<td>http://localhost:9999</td>
<td>InfluxDB API connection url</td>
</tr>
<tr>
<td>influxdb.org</td>
<td>my-org</td>
<td>organization name, Organizations are supported in InfluxDB 2.0+, use "-" as org for InfluxDB 1.8</td>
</tr>
<tr>
<td>influxdb.token</td>
<td>my-token</td>
<td>authorization token for InfluxDB API, token are supported in InfluxDB 2.0+, for InfluxDB 1.8 use 'username:password' as a token.</td>
</tr>
<tr>
<td>influxdb.logLevel</td>
<td>NONE</td>
<td>InfluxDB client library verbosity level (for debugging purpose)</td>
</tr>
</table>
<h4>Example configuration</h4>
<p><img src="/docs/0.10.1/assets/themes/zeppelin/img/docs-img/influxdb2.png" alt="InfluxDB notebook"></p>
<h2>Overview</h2>
<h2>How to use</h2>
<p>Basically, you can use</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">%influxdb
from(bucket: &quot;my-bucket&quot;)
|&gt; range(start: -1h)
|&gt; filter(fn: (r) =&gt; r._measurement == &quot;cpu&quot;)
|&gt; filter(fn: (r) =&gt; r.cpu == &quot;cpu-total&quot;)
|&gt; pivot(rowKey:[&quot;_time&quot;], columnKey: [&quot;_field&quot;], valueColumn: &quot;_value&quot;)
</code></pre></div>
<p>In this example we use data collected by <code>[[inputs.cpu]]</code> <a href="https://github.com/influxdata/telegraf">Telegraf</a> input plugin. </p>
<p>The result of Flux command can contain more one or more tables. In the case of multiple tables, each
table is rendered as a separate %table structure. This example uses <code>pivot</code>
function to collect values from multiple tables into single table. </p>
<h2>How to run InfluxDB 2.0 using docker</h2>
<div class="highlight"><pre><code class="bash language-bash" data-lang="bash">docker pull quay.io/influxdb/influxdb:nightly
docker run --name influxdb -p 9999:9999 quay.io/influxdb/influxdb:nightly
<span class="c">## Post onBoarding request, to setup initial user (my-user@my-password), org (my-org) and bucketSetup (my-bucket)&quot;</span>
curl -i -X POST http://localhost:9999/api/v2/setup -H <span class="s1">&#39;accept: application/json&#39;</span> <span class="se">\</span>
-d <span class="s1">&#39;{</span>
<span class="s1"> &quot;username&quot;: &quot;my-user&quot;,</span>
<span class="s1"> &quot;password&quot;: &quot;my-password&quot;,</span>
<span class="s1"> &quot;org&quot;: &quot;my-org&quot;,</span>
<span class="s1"> &quot;bucket&quot;: &quot;my-bucket&quot;,</span>
<span class="s1"> &quot;token&quot;: &quot;my-token&quot;</span>
<span class="s1"> }&#39;</span>
</code></pre></div>
</div>
</div>
<hr>
<footer>
<!-- <p>&copy; 2022 The Apache Software Foundation</p>-->
</footer>
</div>
</body>
</html>