Grafana is a popular technology that makes it easy to visualize metrics. The Oracle Cloud Infrastructure Data Source for Grafana is used to extend Grafana by adding OCI as a data source. The plugin enables you to visualize metrics related to several OCI resources: Compute, Networking, Storage, and custom metrics.
This walkthrough is intended for use by people who would like to deploy Grafana and the OCI Data Source for Grafana in Grafana Cloud.
Make sure you have access to the Monitoring Service and that metrics have been enabled for the resources you are trying to monitor.
To configure OCI Metrics Grafana Data Source, you'll need to get the necessary provider and resource settings. Please note that with Grafana Cloud only version 5.x.x and above are supported. If you are configuring the plugin to work in Multitenancy Mode, you will need to repeat the following steps for each of the Tenancies you want to configure with the plugin (up to 5 additional Tenancies are supported).
To get the region for your OCI cloud, follow these steps:
- Log in to the OCI console.
- From the OCI menu, select the Region dropdown in the top right corner of the page.
- The region is listed next to Home.
For details and reference, see: Regions and Availability Domains Make note of the region as you'll need it later to configure your OCI Metrics Grafana Data Source.
To get the tenancy OCID, follow these steps:
- Log in to the OCI console.
- From the OCI menu, click on your profile icon on the top right:
- Click on Tenancy
- The tenancy OCID is listed in the Tenancy Information section.
For details and reference, see: Where to Get the Tenancy's OCID and User's OCID Make note of the tenancy OCID as you'll need it later to configure your OCI Metrics Grafana Data Source.
To get the user OCID, follow these steps:
- Log in to the OCI console.
- From the OCI menu, select Identity > Users.
- Click on the user you want to use with OCI Metrics Grafana Data Source.
- The user OCID is listed in the User Details section.
For details and reference, see: Where to Get the Tenancy's OCID and User's OCID. Make note of the user OCID as you'll need it later to configure your OCI Metrics Grafana Data Source.
To get the private key, follow these steps:
- Log in to your OCI tenancy and click on your username in the top right corner.
- Go to Resources and API Keys and click on Add API Key.
- Choose if you want to generate a new API key or use your own:
- Select Generate API Key Pair if you want to generate a new API key. Click then on Download Private Key and Download Public Key to get your newly generated key
- Select Public Key File or Paste Public Key in case you want to paste your public key: select Paste Public Key in the Add API Key dialog and copy and paste the key contents into the field, then click Add.
- Once the key is added take note of the API key fingerprint listed in the Fingerprint column.
For details on how to create and configure keys see How to Generate an API Signing Key and How to Upload the Public Key. Make note of the private key file location and API key fingerprint as you'll need it later to configure your OCI Metrics Grafana Data Source.
In the OCI console under Identity > Groups click Create Group and create a new group called grafana. Add the user configured in the OCI CLI to the newly-created group.
Under the Policy tab click Create Policy and create a policy allowing the group to read tenancy metrics. Add the following policy statements:
allow group grafana to read metrics in tenancyallow group grafana to read compartments in tenancy
To install OCI Metrics Plugin on Grafana Cloud you need a valid Grafana Cloud Account.
Log in to your Grafana Cloud Account and go to the Administration section:
Select Plugins and search for oracle:
Click on Oracle Cloud Infrastructure Metrics. You will see the installation option for the plugin. Choose install via grafana.con:
You will be forwarded to the grafana.com website where you can proceed with the one-click installation. Make sure you will choose the correct Grafana Cloud account (in this example the account is named Oracle yours will be different) and follow the instruction on this web page to complete the plugin installation:
Log in to Grafana Cloud using your grafana cloud credentials:
On the Home Dashboard go to the Administration section:
Select Data sources and search for oracle:
Click on Oracle Cloud Infrastructure Metrics as your data source type. This Configuration screen will appear:
For Authentication Provider choose OCI User and then choose between single or multitenancy as Tenancy mode. Please note that with Grafana Cloud the OCI instance Environment option is not supported.
You can then choose between two different modes as Tenancy mode:
- single: to use a single specific Tenancy
- multitenancy: to use multiple tenancies
If you selected single as Tenancy mode then fill in the following credentials:
Profile Name- A user-defined name for this profile. In single mode this is automatically set to DEFAULT and cannot be modified.Region- An OCI region. To get the value, see Getting Region Configuration value.User OCID- OCID of the user calling the API. To get the value, see Getting User OCID Configuration value.*Tenancy OCID- OCID of your tenancy. To get the value, see Getting Tenancy OCID Configuration value.Fingerprint- Fingerprint for the key pair being used. To get the value, see Getting Fingerprint Configuration value.Private Key- The contents of the private key file. To get the value, see Getting Private Key Configuration value.
The configured data source will look like the following:
Click Save & Test to return to the home dashboard.
If you selected multi as Tenancy mode then fill in the following credentials for each Tenancy you want to configure (up to 5 additional tenancies):
Profile Name- A user-defined name for this profile. The first Tenancy is automatically set to DEFAULT and cannot be modified. You need to specify a custom and unique Profile name for each of the additional tenancies.Region- An OCI region. To get the value, see Getting Region Configuration value.User OCID- OCID of the user calling the API. To get the value, see Getting User OCID Configuration value.Tenancy OCID- OCID of your tenancy. To get the value, see Getting Tenancy OCID Configuration value.Fingerprint- Fingerprint for the key pair being used. To get the value, see Getting Fingerprint Configuration value.Private Key- The contents of the private key file. To get the value, see Getting Private Key Configuration value.
By default, if you selected multi as Tenancy mode you can configure one DEFAULT tenancy with an additional one. You may add others tenancy (up to 5 additional tenancies) using the Add another Tenancy checkbox.
The configured data source will look like the following:
Click Save & Test to return to the home dashboard.
After the initial configuration, you can modify the datasource by adding a new tenancy by clicking on the Add another Tenancy checkbox and filling in the additional credentials. You can also disable a configured Tenancy leaving empty the Profile Name as in this screenshot:
Check out how to use the newly installed and configured plugin in our Using Grafana with Oracle Cloud Infrastructure Data Source walkthrough.