|
1 | | -# About OCI Grafana Metrics plugin |
2 | | - |
| 1 | +# About OCI Grafana Metrics plugin |
3 | 2 |
|
4 | 3 | ## Installation |
5 | 4 |
|
6 | 5 | ### Oracle Cloud Infrastructure Metrics Data Source |
| 6 | + |
7 | 7 | ## Introduction |
8 | 8 |
|
9 | | -This plugin makes queries to the Oracle Cloud Infrastructure Monitoring Service and displays them on Grafana. |
| 9 | +This plugin makes queries to the Oracle Cloud Infrastructure Monitoring |
| 10 | +Service and displays them on Grafana. |
10 | 11 |
|
11 | | -If you are running Grafana on a machine instance in Oracle Cloud, use the Service Principal with a configured Dynamic Group and policy to allow you to read metrics and compartments. |
| 12 | +If you are running Grafana on a machine instance in Oracle Cloud, use the |
| 13 | +Service Principal with a configured Dynamic Group and policy to allow you to |
| 14 | +read metrics and compartments. |
12 | 15 |
|
13 | | -If you are running Grafana anywhere else, make sure you have `~/.oci` configured properly. You can do this by installing the Oracle Cloud CLI and running the setup |
| 16 | +If you are running Grafana anywhere else, make sure you have `~/.oci` |
| 17 | +configured properly. You can do this by installing the Oracle Cloud CLI and |
| 18 | +running the setup. |
14 | 19 |
|
15 | 20 | ## Note |
16 | 21 |
|
17 | | -If you're using a version of Grafana that's older than 6.0, you will need to download the zip file and install this plugin manually, or chmod the binary that is downloaded to make it executable. |
18 | | - |
| 22 | +If you're using a version of Grafana that's older than 6.0, you will need to |
| 23 | +download the zip file and install this plugin manually, or chmod the binary |
| 24 | +that is downloaded to make it executable. |
19 | 25 |
|
20 | 26 | In order to simplify the installation process, we created detailed guides for you to follow: |
21 | 27 |
|
22 | | -* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a Linux host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linux.md). |
23 | | -* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a MacOS host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/macos.md). |
24 | | -* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a virtual machine in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linuxoci.md). |
25 | | -* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a virtual machine in Oracle Cloud Infrastructure using Terraform using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/terraform.md). |
26 | | -* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on Kubernetes in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/kubernetes.md) |
| 28 | +* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana |
| 29 | + on a Linux host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linux.md). |
| 30 | +* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana |
| 31 | + on a MacOS host using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/macos.md). |
| 32 | +* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana |
| 33 | + on a virtual machine in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/linuxoci.md). |
| 34 | +* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana |
| 35 | +on a virtual machine in Oracle Cloud Infrastructure using Terraform using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/terraform.md). |
| 36 | +* Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana |
| 37 | +on Kubernetes in Oracle Cloud Infrastructure using [this document](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/kubernetes.md) |
27 | 38 |
|
28 | | -Once you have the data source installed, configure your datasource with your tenancy OCID, default region, and where you're running the plugin (Oracle Cloud or elsewhere). |
| 39 | +Once you have the data source installed, configure your datasource with your |
| 40 | +tenancy OCID, default region, and where you're running the plugin |
| 41 | +(Oracle Cloud or elsewhere). |
29 | 42 |
|
30 | | -We also have documentation for how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/using.md) walkthrough. |
| 43 | +We also have documentation for how to use the newly installed and configured |
| 44 | +plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/using.md) walkthrough. |
31 | 45 |
|
32 | 46 | ### Debugging |
33 | 47 |
|
34 | 48 | If you want to debug golang backend plugin code, follow the steps below: |
| 49 | + |
35 | 50 | * Install [gops](https://github.com/google/gops) to list running go processes on your machine |
36 | 51 | * Run `gops` and find processId for `oci-plugin_darwin_amd64` process |
37 | 52 | * Copy this processId to the `.vscode/launch.json` |
|
0 commit comments