Repository: drill Updated Branches: refs/heads/gh-pages fa2e899ec -> 5b1089c39
add opentsdb SP doc, update other docs so titles have quotes Project: http://git-wip-us.apache.org/repos/asf/drill/repo Commit: http://git-wip-us.apache.org/repos/asf/drill/commit/5b1089c3 Tree: http://git-wip-us.apache.org/repos/asf/drill/tree/5b1089c3 Diff: http://git-wip-us.apache.org/repos/asf/drill/diff/5b1089c3 Branch: refs/heads/gh-pages Commit: 5b1089c392c7dcb4395c7c2fb57242538bcfd5e6 Parents: fa2e899 Author: Bridget Bevens <[email protected]> Authored: Wed Feb 7 16:38:54 2018 -0800 Committer: Bridget Bevens <[email protected]> Committed: Wed Feb 7 16:38:54 2018 -0800 ---------------------------------------------------------------------- .../plugins/112-opentsdb-storage-plugin.md | 90 ++++++++++++++++++++ ...is-enabled-and-authentication-is-disabled.md | 12 +-- .../050-starting-drill-in-distributed-mode.md | 4 +- _docs/install/060-starting-the-web-ui.md | 4 +- ...ying-multiple-drill-versions-in-a-cluster.md | 4 +- .../sql-commands/005-supported-sql-commands.md | 4 +- community-resources.md | 2 +- faq.md | 2 +- mailinglists.md | 2 +- team.md | 2 +- 10 files changed, 108 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/_docs/connect-a-data-source/plugins/112-opentsdb-storage-plugin.md ---------------------------------------------------------------------- diff --git a/_docs/connect-a-data-source/plugins/112-opentsdb-storage-plugin.md b/_docs/connect-a-data-source/plugins/112-opentsdb-storage-plugin.md new file mode 100644 index 0000000..75af1af --- /dev/null +++ b/_docs/connect-a-data-source/plugins/112-opentsdb-storage-plugin.md @@ -0,0 +1,90 @@ +--- +title: "OpenTSDB Storage Plugin" +date: 2018-02-06 21:49:40 UTC +parent: "Connect a Data Source" +--- + +As of Drill 1.12, Drill provides a storage plugin for OpenTSDB. The OpenTSDB storage plugin uses the REST API with OpenTSDB. + +When you install Drill, a preconfigured OpenTSDB storage plugin is available on the Storage page in the Drill Web Console. Once you enable the storage plugin, you can query OpenTSDB from Drill. + +The following sections describe how to enable the OpenTSDB storage plugin in Drill and the types of queries Drill currently supports on OpenTSDB. You can refer to the [README](https://github.com/apache/drill/blob/master/contrib/storage-opentsdb/README.md) and [OpenTSDB](http://opentsdb.net/) for additional information. + +##Enabling the OpenTSDB Storage Plugin + +To enable the OpenTSDB storage plugin, enter the following URL in the address bar of your browser to access the Storage page in the Drill Web Console: +http://<drill-node-ip-address>:8047/storage/ + +In the Disabled Storage Plugins section, click **Enable** next to OpenTSDB. OpenTSDB moves to the Enabled Storage Plugins section. Click **Update** to see the default configuration: + + { + "type": "openTSDB", + "connection": "http://localhost:4242";, + "enabled": true + } + +The URL, http://localhost:4242, works for TSD running locally. If you have TSD running on another machine, change the URL to reflect that. Verify that âenabledâ is set to true. +Click **Update** if you edit the configuration and then click **Back** to return to the Storage page. + +##Querying OpenTSDB +When querying OpenTSDB, you must include the required request parameters in the FROM clause of queries, using commas to separate the parameters, as shown in the following example: + + SELECT * FROM openTSDB.`(metric=warp.speed.test, start=47y-ago, aggregator=sum)`; + + +In addition to the required request parameters, you can also include some optional request parameters in queries. + + +###Required Request Parameters + +The following table lists the required request parameters: + +| **Name** | **Data Type** | **Description** | +|------------|-----------------|--------------------------------------------------------------------| +| metric | string | The name of a metric stored in the system | +| start | string, integer | The start time for the query; a relative or absolute timestamp. | +| aggregator | string | The name of an aggregation function to use. | + +###Optional Request Parameters + +The following table lists optional request parameters: +| **Name** | **Data Type** | **Description** | +|------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| downsample | string | An optional downsampling function to reduce the amount of data returned. | +| end | string, integer | An end time for the query. If not supplied, the TSD assumes the local system time on the server. If this parameter is not specified, null is sent to the database in this field, but in this case the database assumes the local system time on the server. | + +###Supported Aggregators + +For a list of supported aggegrators, see [Aggregators](http://opentsdb.net/docs/build/html/user_guide/query/aggregators.html). + +###Supported Dates and Times + +For a list of supported dates and times, see [Dates](http://opentsdb.net/docs/build/html/user_guide/query/dates.html). + +##Examples of Queries that Drill Supports on OpenTSDB + +Drill currently supports the following types of queries on the OpenTSDB: + + USE openTSDB; + //Switches Drill to the OpenTSDB schema so that Drill only queries OpenTSDB. + + SHOW tables; + //Prints the available metrics. The max number of the printed results is an Integer.MAX value. + + SELECT * FROM openTSDB.`(metric=warp.speed.test, start=47y-ago, aggregator=sum)`; + //Returns aggregated elements from the warp.speed.test table from 47y-ago. + + SELECT * FROM openTSDB.`(metric=warp.speed.test, aggregator=avg, start=47y-ago)`; + //Returns aggregated elements from the warp.speed.test table. + + SELECT `timestamp`, sum(`aggregated value`) FROM openTSDB.`(metric=warp.speed.test, aggregator=avg, start=47y-ago)` GROUP BY `timestamp`; + //Returns aggregated and grouped value by standard Drill functions from the warp.speed.test table with the custom aggregator. + + SELECT * FROM openTSDB.`(metric=warp.speed.test, aggregator=avg, start=47y-ago, downsample=5m-avg)`; + //Returns aggregated data limited by the downsample. + + SELECT * FROM openTSDB.`(metric=warp.speed.test, aggregator=avg, start=47y-ago, end=1407165403000)`; + //Returns aggregated data limited by the end time. + + + http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/_docs/developer-information/rest-api/010-submitting-queries-from-the-rest-api-when-impersonation-is-enabled-and-authentication-is-disabled.md ---------------------------------------------------------------------- diff --git a/_docs/developer-information/rest-api/010-submitting-queries-from-the-rest-api-when-impersonation-is-enabled-and-authentication-is-disabled.md b/_docs/developer-information/rest-api/010-submitting-queries-from-the-rest-api-when-impersonation-is-enabled-and-authentication-is-disabled.md index 9cc0d41..84dfcbf 100644 --- a/_docs/developer-information/rest-api/010-submitting-queries-from-the-rest-api-when-impersonation-is-enabled-and-authentication-is-disabled.md +++ b/_docs/developer-information/rest-api/010-submitting-queries-from-the-rest-api-when-impersonation-is-enabled-and-authentication-is-disabled.md @@ -1,6 +1,6 @@ --- title: "Submitting Queries from the REST API when Impersonation is Enabled and Authentication is Disabled" -date: 2018-01-22 20:29:50 UTC +date: 2018-02-08 00:38:56 UTC parent: "REST API" --- @@ -13,13 +13,13 @@ This feature only works when impersonation is enabled and authentication is disa A user can issue queries through the Drill Web Console, SQLLine, using curl commands, or Java code, as follows: -#Drill Web Console +##Drill Web Console You can submit a query through the Query page in the Drill Web Console after entering a valid username in the Username field. The Drill Web Console is accessible through the URL http(s)://<ip-address>:8047. To re-run a query from the Profiles page in the Drill Web Console, you must submit a username prior to re-running the query. -#SQLLine +##SQLLine You can submit a query through SQLLine if you include a username when starting SQLLine, as follows: @@ -27,7 +27,7 @@ You can submit a query through SQLLine if you include a username when starting S **Note:** The startup scripts are located in the `../bin` directory of the Drill installation. -#Curl +##Curl When making curl requests, you must include the User-Name header with the username in the command, as follows: @@ -36,7 +36,7 @@ When making curl requests, you must include the User-Name header with the userna **Note:** The User-Name header is required for POST requests to /query or /query.json. Failure to include the User-Name header results in an error. For other types of requests, the User-Name header is not required. If you do not include the User-Name header (or it is null or empty), the default principal âanonymousâ is used. -#Java +##Java When using an application to submit a query, you must include the User-Name header with the username in the connection request, as follows: @@ -57,7 +57,7 @@ When using an application to submit a query, you must include the User-Name head } -**Note:** You can also use Apache HttpClient. +**Note:** You can also use the Apache HttpClient. http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/_docs/install/050-starting-drill-in-distributed-mode.md ---------------------------------------------------------------------- diff --git a/_docs/install/050-starting-drill-in-distributed-mode.md b/_docs/install/050-starting-drill-in-distributed-mode.md index 0d3a254..edbba49 100644 --- a/_docs/install/050-starting-drill-in-distributed-mode.md +++ b/_docs/install/050-starting-drill-in-distributed-mode.md @@ -1,6 +1,6 @@ --- -title: Starting Drill in Distributed Mode -date: 2018-01-22 19:42:55 UTC +title: "Starting Drill in Distributed Mode" +date: 2018-02-08 00:38:56 UTC parent: "Installing Drill in Distributed Mode" --- http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/_docs/install/060-starting-the-web-ui.md ---------------------------------------------------------------------- diff --git a/_docs/install/060-starting-the-web-ui.md b/_docs/install/060-starting-the-web-ui.md index e9d7418..525645b 100644 --- a/_docs/install/060-starting-the-web-ui.md +++ b/_docs/install/060-starting-the-web-ui.md @@ -1,6 +1,6 @@ --- -title: Starting the Web Console -date: 2018-01-22 19:42:56 UTC +title: "Starting the Web Console" +date: 2018-02-08 00:38:57 UTC parent: Install Drill --- http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/_docs/install/070-identifying-multiple-drill-versions-in-a-cluster.md ---------------------------------------------------------------------- diff --git a/_docs/install/070-identifying-multiple-drill-versions-in-a-cluster.md b/_docs/install/070-identifying-multiple-drill-versions-in-a-cluster.md index e5971bb..5e0099d 100644 --- a/_docs/install/070-identifying-multiple-drill-versions-in-a-cluster.md +++ b/_docs/install/070-identifying-multiple-drill-versions-in-a-cluster.md @@ -1,6 +1,6 @@ --- -title: Identifying Multiple Drill Versions in a Cluster -date: +title: "Identifying Multiple Drill Versions in a Cluster" +date: 2018-02-08 00:38:57 UTC parent: Install Drill --- http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/_docs/sql-reference/sql-commands/005-supported-sql-commands.md ---------------------------------------------------------------------- diff --git a/_docs/sql-reference/sql-commands/005-supported-sql-commands.md b/_docs/sql-reference/sql-commands/005-supported-sql-commands.md index 6605469..2d838d9 100644 --- a/_docs/sql-reference/sql-commands/005-supported-sql-commands.md +++ b/_docs/sql-reference/sql-commands/005-supported-sql-commands.md @@ -1,6 +1,6 @@ --- -title: Supported SQL Commands -date: 2017-03-14 22:11:02 UTC +title: "Supported SQL Commands" +date: 2018-02-08 00:38:57 UTC parent: "SQL Commands" --- The following table provides a list of the SQL commands that Drill supports, http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/community-resources.md ---------------------------------------------------------------------- diff --git a/community-resources.md b/community-resources.md index 03677e3..4712781 100755 --- a/community-resources.md +++ b/community-resources.md @@ -1,6 +1,6 @@ --- layout: page -title: Community Resources +title: "Community Resources" --- ## User Resources http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/faq.md ---------------------------------------------------------------------- diff --git a/faq.md b/faq.md index 1c5d625..25ac0a4 100755 --- a/faq.md +++ b/faq.md @@ -1,6 +1,6 @@ --- layout: page -title: Frequently Asked Questions +title: "Frequently Asked Questions" --- ## Overview http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/mailinglists.md ---------------------------------------------------------------------- diff --git a/mailinglists.md b/mailinglists.md index e05a3e5..625a7b3 100644 --- a/mailinglists.md +++ b/mailinglists.md @@ -1,6 +1,6 @@ --- layout: page -title: Mailing Lists +title: "Mailing Lists" --- All communication related to the Apache Drill project happens on the mailing lists: http://git-wip-us.apache.org/repos/asf/drill/blob/5b1089c3/team.md ---------------------------------------------------------------------- diff --git a/team.md b/team.md index c6585ff..871f7c5 100755 --- a/team.md +++ b/team.md @@ -1,6 +1,6 @@ --- layout: page -title: Team +title: "Team" --- The Apache Drill developer community is growing rapidly. It currently includes dozens of contributors employed by many organizations, such as MapR, Intuit, Hortonworks, Elastic, LinkedIn, Pentaho, Cisco and the University of Wisconsin-Madison.
