You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The easiest way to get started is to git clone the WorldMap project directly into the `data/plugins` folder in the Grafana source. (A git repo inside of a git repo)
3
+
The easiest way to get started is to git clone the project repository
4
+
directly into the `data/plugins` of your Grafana instance followed
5
+
by building it there.
4
6
5
-
1. Install npm packages: `npm install`
6
-
2. Build and lint the JavaScript: `npm run build`
7
-
2. Run the tests before submitting a PR: `npm run test`
8
-
3. A test watcher when TDD:ing: `npm run test:watch`
7
+
1. Install npm packages: `npx yarn install`
8
+
2. Build and lint the JavaScript: `npx yarn build`
9
+
2. Run the tests before submitting a PR: `npx yarn test`
10
+
3. A test watcher when TDD:ing: `npx yarn dev --watch`
9
11
10
-
Grafana will read in the dist folder first so to see your changes to WorldMap in Grafana, you have to run Grunt. However, you do not need to restart your local Grafana server after every change; just refresh the page.
12
+
Grafana will read in the `dist` folder first so to see your changes in
13
+
Grafana, you will have to build the plugin once. However, you do not
14
+
need to restart your local Grafana server after every change, just
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# Worldmap Panel Plugin for Grafana
1
+
# Grafana Map Panel
2
2
3
-
The Worldmap Panel is a tile map of the world that can be overlaid with circles representing data points from a query. It can be used with time series metrics, with geohash data from Elasticsearch or data in the Table format.
3
+
The Grafana Map Panel is a tile map of the world that can be overlaid with circles representing data points from a query. It can be used with time series metrics, with geohash data from Elasticsearch or data in the Table format.
@@ -50,7 +50,7 @@ Location data should be in the JSON format and should be an array of JSON object
50
50
]
51
51
```
52
52
53
-
The Worldmap will then match the metric name (target in the example data) with a key field from the location data. With this example data there will be two circles drawn on the map, one for Sweden and one for the United States with values 183255 and 192224.
53
+
The metric name (target in the example data) will be matched with a key field from the location data. With this example data there will be two circles drawn on the map, one for Sweden and one for the United States with values 183255 and 192224.
54
54
55
55
### Table Format
56
56
@@ -79,7 +79,7 @@ Table data is tabular data with columns and rows. Here is an example of Table da
79
79
]
80
80
```
81
81
82
-
This query contains both data (the value `75.654324173059`) and a location (the geohash `9wvfgzurfzb` which is in Colorado). So using these, the Worldmap panel will draw one circle in Colorado, USA with the value 75.654324173059.
82
+
This query contains both data (the value `75.654324173059`) and a location (the geohash `9wvfgzurfzb` which is in Colorado). So using these, one circle will be drawn in Colorado, USA with the value 75.654324173059.
83
83
84
84
## Time Series Data as the Data Source
85
85
@@ -121,7 +121,7 @@ Use the aliasByNode function to point to the field containing the country code.
121
121
122
122

123
123
124
-
Example dashboard for Worldmap with Graphite queries on [the Grafana play site](http://localhost:3000/d/000000003/worldmap-panels?panelId=8&fullscreen&edit&orgId=1).
124
+
Example dashboard with Graphite queries on [the Grafana play site](http://localhost:3000/d/000000003/worldmap-panels?panelId=8&fullscreen&edit&orgId=1).
125
125
126
126
#### InfluxDB Query
127
127
@@ -137,19 +137,19 @@ Use a Group By clause on the field containing the country code and a Then by cla
137
137
138
138
#### Map Data Options for Time Series Data
139
139
140
-
Under the Worldmap tab, choose either the `countries` or `states` option.
140
+
On the editor tab, choose either the `countries` or `states` option.
141
141
142
-

142
+

143
143
144
144
Using a JSON endpoint to return a custom list of locations:
145
145
146
-

146
+

147
147
148
148
The endpoint used here is for the demo version of worldPing - [https://worldpingdemo.grafana.net/api/plugin-proxy/raintank-worldping-app/api/v2/probes/locations](https://worldpingdemo.grafana.net/api/plugin-proxy/raintank-worldping-app/api/v2/probes/locations). If you have your own endpoint defined it must be reachable from the client side, as it is approached by client's browser.
149
149
150
150
Using a JSONP endpoint (if you need to wrap the JSON to get around CORS problems):
151
151
152
-

152
+

153
153
154
154
For some details on troubleshooting JSON/JSONP check [#47](https://github.com/grafana/worldmap-panel/issues/47).
155
155
@@ -159,17 +159,17 @@ Supported Databases:
159
159
160
160
- ElasticSearch
161
161
162
-
The [Geo-point](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/geo-point.html) data type with geohash indexing in Elasticsearch can also be used as a datasource for the worldmap panel. Grafana has a new bucket aggregate for Elasticsearch queries - Geo Hash Grid that allows grouping of coordinates. The Geo Hash Grid has a precision option where 1 is the highest level and 7 is the lowest.
162
+
The [Geo-point](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/geo-point.html) data type with geohash indexing in Elasticsearch can also be used as a datasource. Grafana has a new bucket aggregate for Elasticsearch queries - Geo Hash Grid that allows grouping of coordinates. The Geo Hash Grid has a precision option where 1 is the highest level and 7 is the lowest.
163
163
164
-

@@ -190,7 +190,7 @@ Similar to the Elasticsearch query above, 3 fields are expected (2 of them are m
190
190
- A *geohash* field. This is used to calculate where the circle should be drawn.
191
191
- an optional location name field (shown in the mouse over). Used to label each circle on the map. If it is empty then the geohash value is used as the label.
192
192
193
-
The field mappings have to be specified on the Worldmap settings tab.
193
+
The field mappings have to be specified on the Grafana Map settings tab.
@@ -214,7 +214,7 @@ It supports any datasource capable of generating a JSON response with a custom l
214
214
215
215
#### Location Data
216
216
217
-
There are four ways to provide data for the worldmap panel:
217
+
There are four ways to provide data to this plugin:
218
218
219
219
-*countries*: This is a list of all the countries in the world. It works by matching a country code (US, FR, AU) to a node alias in a time series query.
220
220
-*states*: Similar to countries but for the states in USA e.g. CA for California
0 commit comments