Skip to content

Commit e1d32bf

Browse files
authored
Fix documentation for resourceGroup addition (#79)
Fix for: After the addition of resourceGroups of using.md , the documents got outdated Occured from v1.0.8 release and commit * Updated the queries and replaced the screenshot for variables * Updated versions and date in markdown documents
1 parent 740855a commit e1d32bf

File tree

8 files changed

+11
-10
lines changed

8 files changed

+11
-10
lines changed
-166 KB
Binary file not shown.
142 KB
Loading

docs/linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ grafana-cli plugins install oci-datasource
4242
The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
4343

4444
### Manual installation
45-
Alternatively, you can manually download the .tar file and unpack it into your /grafana/plugins directory. To do so, change to the Grafana plugins directory: `cd /usr/local/var/lib/grafana/plugins`. Download the OCI Grafana Plugin: wget `https://github.com/oracle/oci-grafana-plugin/releases/download/v2.2.1/plugin.tar`. Create a directory and install the plugin: `mkdir oci && tar -C oci -xvf plugin.tar` and then remove the tarball: `rm plugin.tar`.
45+
Alternatively, you can manually download the .tar file and unpack it into your /grafana/plugins directory. To do so, change to the Grafana plugins directory: `cd /usr/local/var/lib/grafana/plugins`. Download the OCI Grafana Plugin: wget `https://github.com/oracle/oci-grafana-plugin/releases/download/v2.2.2/plugin.tar`. Create a directory and install the plugin: `mkdir oci && tar -C oci -xvf plugin.tar` and then remove the tarball: `rm plugin.tar`.
4646

4747
> **Additional step for Grafana 7**. Open the grafana configuration *grafana.ini* file and add the `allow_loading_unsigned_plugins = "oci-datasource"`in the *plugins* section.
4848

docs/linuxoci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ grafana-cli plugins install oci-metrics-datasource
3535
The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
3636

3737
### Manually installation
38-
Alternatively, you can manually download the .tar file and unpack it into your /grafana/plugins directory. To do so, change to the Grafana plugins directory: `cd /usr/local/var/lib/grafana/plugins`. Download the OCI Grafana Plugin: wget `https://github.com/oracle/oci-grafana-plugin/releases/download/v2.2.1/plugin.tar`. Create a directory and install the plugin: `mkdir oci && tar -C oci -xvf plugin.tar` and then remove the tarball: `rm plugin.tar`.
38+
Alternatively, you can manually download the .tar file and unpack it into your /grafana/plugins directory. To do so, change to the Grafana plugins directory: `cd /usr/local/var/lib/grafana/plugins`. Download the OCI Grafana Plugin: wget `https://github.com/oracle/oci-grafana-plugin/releases/download/v2.2.2/plugin.tar`. Create a directory and install the plugin: `mkdir oci && tar -C oci -xvf plugin.tar` and then remove the tarball: `rm plugin.tar`.
3939

4040
> **Additional step for Grafana 7**. Open the grafana configuration *grafana.ini* file and add the `allow_loading_unsigned_plugins = "oci-datasource"`in the *plugins* section.
4141

docs/macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ grafana-cli plugins install oci-metrics-datasource
4040
The plugin will be installed into your Grafana plugins directory, which by default is located at /var/lib/grafana/plugins. [Here is more information on the CLI tool](http://docs.grafana.org/plugins/installation/).
4141

4242
### Manually installation
43-
Alternatively, you can manually download the .tar file and unpack it into your /grafana/plugins directory. To do so, change to the Grafana plugins directory: `cd /usr/local/var/lib/grafana/plugins`. Download the OCI Grafana Plugin: wget `https://github.com/oracle/oci-grafana-plugin/releases/download/v2.2.1/plugin.tar`. Create a directory and install the plugin: `mkdir oci && tar -C oci -xvf plugin.tar` and then remove the tarball: `rm plugin.tar`
43+
Alternatively, you can manually download the .tar file and unpack it into your /grafana/plugins directory. To do so, change to the Grafana plugins directory: `cd /usr/local/var/lib/grafana/plugins`. Download the OCI Grafana Plugin: wget `https://github.com/oracle/oci-grafana-plugin/releases/download/v2.2.2/plugin.tar`. Create a directory and install the plugin: `mkdir oci && tar -C oci -xvf plugin.tar` and then remove the tarball: `rm plugin.tar`
4444

4545
> **Additional step for Grafana 7**. Open the grafana configuration *grafana.ini* file and add the `allow_loading_unsigned_plugins = "oci-datasource"`in the *plugins* section.
4646

docs/using.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,14 @@ Repeat the process for the following OCI variables:
4949
| region | `regions()` |
5050
| compartment | `compartments()` |
5151
| namespace | `namespaces($region,$compartment)` |
52-
| metric | `metrics($region,$compartment,$namespace)` |
53-
| dimensionKey | `dimensions($region,$compartment,$namespace,$metric)` |
54-
| dimensionValue | `dimensionOptions($region,$compartment,$namespace,$metric,$dimensionKey)` |
52+
| resourcegroup | `resourcegroups($region, $compartment, $namespace)` |
53+
| metric | `metrics($region,$compartment, $namespace, $resourcegroup)` |
54+
| dimensionKey | `dimensions($region, $compartment, $namespace, $metric, $resourcegroup)` |
55+
| dimensionValue | `dimensionOptions($region,$compartment,$namespace,$metric,$dimensionKey,$resourcegroup)` |
5556

5657
The final list of variables should look like this:
5758

58-
![Screen Shot 2019-01-11 at 3.19.58 PM](images/Screen%20Shot%202019-01-11%20at%203.19.58%20PM.png)
59+
![Metrics dashboard variables screenshot](images/metrics-dashboard-variables-screenshot.png)
5960

6061
In order for these variables be available to be dynamically changed in your query, edit your existing query, and under **metrics** select the newly created variables for **region**, **compartment**, **namespace**, and **metric** as seen in the image below.
6162

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "oci-metrics-datasource",
33
"private": true,
4-
"version": "2.2.1",
4+
"version": "2.2.2",
55
"description": "Oracle Cloud Infrastructure Metrics Data Source for Grafana",
66
"main": "index.js",
77
"scripts": {

src/plugin.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
{"name": "GitHub", "url": "https://github.com/oracle/oci-grafana-plugin"},
2727
{"name": "UPL", "url": "https://oss.oracle.com/licenses/upl"}
2828
],
29-
"version": "2.2.0",
30-
"updated": "2020-12-08"
29+
"version": "2.2.2",
30+
"updated": "2021-01-11"
3131
},
3232

3333
"dependencies": {

0 commit comments

Comments
 (0)