Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

Commit

Permalink
grafana plugin system expects README.md filesystem to be uppercased
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Dyas committed Oct 21, 2016
1 parent 7d85233 commit c704f6f
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ module.exports = function(grunt) {
},
readme: {
expand: true,
src: ['readme.md'],
src: ['README.md'],
dest: 'dist',
},
},
Expand Down
75 changes: 75 additions & 0 deletions dist/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
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).
It is copyright (C) 2015-2016 by Foursquare Labs, Inc.


Installation
------------

The easiest way to install this plugin is with `grafana-cli`. Just run the following command:

```
grafana-cli plugins install foursquare-clouderamanager-datasource
```

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.

Development
-----------

To compile, run the following commands:

```
npm install
grunt
```

To install in your Grafana server locally, either point Grafana at the repository directory by
editing `grafana.ini` to contain:

```
[plugin.clouderamanager]
path = /path/to/some/directory/datasource-plugin-clouderamanager
```

Or symlink the repository directory into the Grafana server's plugin directory:

```
cd /path/to/grafana/data/plugins
ln -s /path/to/some/directory/datasource-plugin-clouderamanager .
```

Then restart the Grafana server.

Contributors
------------

- Tom Dyas

0 comments on commit c704f6f

Please sign in to comment.