diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ef2c007 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.sublime* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6238fe1 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +Cloudera Manager Datasource for Grafana 3.x +=========================================== + +This plugin for (Grafana)[http://grafana.org] provides a basic datasource for querying metrics +available in Cloudera Manager through its "tsquery" language. It supports Cloudera Manager API +versions v4 and higher. + +This project is open source pursuant to the (Apache License, Version 2.0)[https://www.apache.org/licenses/LICENSE-2.0]. + + +Installation +------------ + +Method #1: + +1. Clone this repository into your Grafana plugins directory: + +``` +cd path/to/grafana/plugins/directory +git clone git@github.com:foursquare/datasource-plugin-clouderamanager.git +``` + +2. Restart the Grafana server. + +Method #2: + +1. Clone this repository in some directory: + +``` +git clone git@github.com:foursquare/datasource-plugin-clouderamanager.git +``` + +2. Point Grafana at the repository directory by editing `grafana.ini` to contain: + +``` +[plugin.clouderamanager] +path = /path/to/some/directory/datasource-plugin-clouderamanager +``` + +3. Restart the Grafana server. + + +Configuration +------------- + +1. Add a new datasource and choose "Cloudera Manager" as the type. + +2. Fill in the "Url" and other server parameters. + +3. Click "Test Connection" to verify that you entered the information correctly. + +4. Set "API Version" to match the API version reported by Test Connection. + +5. Cick "Save". + + +Queries +------- + +Use this datasource just like you would use any other datasource. Fill in a "tsquery" +metric query in the input box and you should see metrics. + +This datasource is very minimal and so there is no autocompletion support. + +Read the [tsquery documentation](https://www.cloudera.com/documentation/enterprise/latest/topics/cm_dg_tsquery.html) +to learn more about tsquery. + + +Contributors +------------ + +- Tom Dyas diff --git a/datasource.js b/datasource.js new file mode 100644 index 0000000..9ca6871 --- /dev/null +++ b/datasource.js @@ -0,0 +1,186 @@ +// Copyright 2015 Foursquare Labs, Inc. +// +// 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. +define([ + 'angular', + 'lodash', + 'jquery', + 'app/core/utils/datemath', + 'moment', +], +function (angular, _, $, dateMath, moment) { + 'use strict'; + + /** @ngInject */ + function ClouderaManagerDatasource(instanceSettings, $q, backendSrv) { + this.url = instanceSettings.url; + if (this.url.endsWith('/')) { + this.url = this.url.substr(0, this.url.length - 1); + } + this.basicAuth = instanceSettings.basicAuth; + this.withCredentials = instanceSettings.withCredentials; + this.name = instanceSettings.name; + + this.apiVersion = 4; + if (instanceSettings.jsonData.cmAPIVersion === 'v6-10') { + this.apiVersion = 6; + } else if (instanceSettings.jsonData.cmAPIVersion === 'v11+') { + this.apiVersion = 11; + } + + // Helper to make API requests to Cloudera Manager. To avoid CORS issues, the requests may be proxied + // through Grafana's backend via `backendSrv.datasourceRequest`. + this._request = function(options) { + options.url = this.url + options.url; + options.method = options.method || 'GET'; + options.inspect = { 'type': 'cloudera_manager' }; + + if (this.basicAuth) { + options.withCredentials = true; + options.headers = { + "Authorization": this.basicAuth + }; + } + + return backendSrv.datasourceRequest(options); + }; + + // Test the connection to Cloudera Manager by querying for the supported API version. + this.testDatasource = function() { + var options = { + url: '/api/version', + transformResponse: function(data) { + return data; + } + }; + + return this._request(options).then(function(response) { + return { + status: "success", + message: "Data source is working. API version is '" + response.data + "'.", + title: "Success" + }; + }); + }; + + // Query for metric targets within the specified time range. + // Returns the promise of a result dictionary. See the convertResponse comment + // for specifics of the result dictionary. + this.query = function(queryOptions) { + var self = this; + + var targetPromises = _(queryOptions.targets) + .filter(function(target) { return target.target && !target.hide; }) + .map(function(target) { + var requestOptions = { + url: '/api/v' + self.apiVersion + '/timeseries', + params: { + query: target.target, + from: queryOptions.range.from.toJSON(), + to: queryOptions.range.to.toJSON(), + } + }; + + if (self.apiVersion >= 6) { + requestOptions.params.contentType = 'application/json'; + } + + return self._request(requestOptions).then(_.bind(self.convertResponse, self)); + }) + .value(); + + return $q.all(targetPromises).then(function(convertedResponses) { + var result = { + data: _.map(convertedResponses, function(convertedResponse) { + return convertedResponse.data; + }) + }; + result.data = _.flatten(result.data); + return result; + }); + }; + + // Convert the metadata returned from Cloudera Manager into the timeseries name for Grafana. + this._makeTimeseriesName = function(metadata) { + if (metadata.metricName && metadata.entityName) { + return metadata.metricName + ' (' + metadata.entityName + ')'; + } else if (metadata.metricName) { + return metadata.metricName; + } else if (metadata.entityName) { + return metadata.entityName; + } else { + return 'UNKNOWN NAME'; + } + }; + + // Convert the Cloudera Manager response to the format expected by Grafana. + // + // Grafana generally expects: + // { data: [ + // { target: 'metricName1', + // datapoints: [ [a1, ts-a1], [a2, ts-a2], [a3, ts-a3] ] + // }, + // { target: 'metricName2', + // datapoints: [ [b1, ts-b1], [b2, ts-b2], [c3, ts-b3] ] + // }, + // ]} + // + // The CM API response has the general form: + // items: { + // timeSeries: [ + // { + // metadata: { + // metricName: "metricName1", + // entityName: "entityName1", + // ... + // }, + // data: [ + // { + // value: 45.1234, + // timestamp: "2015-10-02T12:58:24.009Z", + // ... + // }, { + // value: 98.7654, + // timestamp: "2015-10-02T12:59:24.009Z", + // ... + // } + // ... (more datapoints) + // ] + // } + // ... (more timeseries) + // ] + // } + this.convertResponse = function(response) { + var self = this; + + if (!response || !response.data || !response.data.items) { return []; } + + var seriesList = []; + _(response.data.items).forEach(function(item) { + _.forEach(item.timeSeries, function(timeSeries) { + seriesList.push({ + target: self._makeTimeseriesName(timeSeries.metadata), + datapoints: _.map(timeSeries.data, function(point) { + var ts = moment.utc(dateMath.parse(point.timestamp)).unix() * 1000; + return [point.value, ts]; + }) + }); + }); + }); + + return {data: seriesList}; + }; + } + + return ClouderaManagerDatasource; +}); diff --git a/module.js b/module.js new file mode 100644 index 0000000..7a0a9c7 --- /dev/null +++ b/module.js @@ -0,0 +1,42 @@ +// Copyright 2016 Foursquare Labs, Inc. +// +// 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. +define([ + './datasource', + './query_ctrl', +], +function (ClouderaManagerDatasource) { + 'use strict'; + + function ClouderaManagerMetricsQueryEditor() { + return { + controller: 'ClouderaManagerQueryCtrl', + templateUrl: 'public/plugins/clouderamanager/partials/query.editor.html' + }; + } + + function ClouderaManagerMetricsQueryOptions() { + return {templateUrl: 'public/plugins/clouderamanager/partials/query.options.html'}; + } + + function ClouderaManagerConfigView() { + return {templateUrl: 'public/plugins/clouderamanager/partials/config.html'}; + } + + return { + Datasource: ClouderaManagerDatasource, + metricsQueryEditor: ClouderaManagerMetricsQueryEditor, + metricsQueryOptions: ClouderaManagerMetricsQueryOptions, + configView: ClouderaManagerConfigView, + }; +}); diff --git a/partials/config.html b/partials/config.html new file mode 100644 index 0000000..55fec96 --- /dev/null +++ b/partials/config.html @@ -0,0 +1,19 @@ + + +
Cloudera Manager Settings
+ +
+ +
+
diff --git a/partials/query.editor.html b/partials/query.editor.html new file mode 100644 index 0000000..a75804a --- /dev/null +++ b/partials/query.editor.html @@ -0,0 +1,60 @@ +
+ + + + + + +
+ +
diff --git a/partials/query.options.html b/partials/query.options.html new file mode 100644 index 0000000..eacb43b --- /dev/null +++ b/partials/query.options.html @@ -0,0 +1,10 @@ +
+
+ +
+
+
diff --git a/plugin.json b/plugin.json new file mode 100644 index 0000000..a3f77f1 --- /dev/null +++ b/plugin.json @@ -0,0 +1,11 @@ +{ + "type": "datasource", + "name": "Cloudera Manager", + "id": "clouderamanager", + + "module": "plugins/clouderamanager/module", + "staticRoot": ".", + + "metrics": true, + "annotations": false +} diff --git a/query_ctrl.js b/query_ctrl.js new file mode 100644 index 0000000..760d57e --- /dev/null +++ b/query_ctrl.js @@ -0,0 +1,29 @@ +// Copyright 2015 Foursquare Labs, Inc. +// +// 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. +define([ + 'angular', +], +function (angular) { + 'use strict'; + + var module = angular.module('grafana.controllers'); + + module.controller('ClouderaManagerQueryCtrl', function($scope) { + $scope.init = function() { + if ($scope.target) { + $scope.target.target = $scope.target.target || ''; + } + }; + }); +});