Plugins 〉Oracle Cloud Infrastructure Metrics
Oracle Cloud Infrastructure Metrics
About OCI Metrics plugin for Grafana
Introduction
This plugin makes queries to the Oracle Cloud Infrastructure(OCI) Monitoring Service to fetch metrics for your OCI resources or your custom metrics in OCI. And then displays them on Grafana.
If you are running Grafana on a machine instance in Oracle Cloud, use the Instance Principal with a configured Dynamic Group and policy to allow you to read metrics and compartments.
If you are running Grafana anywhere else you'll need to get the necessary provider and resource settings, as described in this section Getting OCI Configuration values
Latest plugin version 4.X.X(available on Grafana Marketplace) is compatible with Grafana 8**. We will release it's binary on its Github repo very soon.
Breaking change! In case you are migrating from a previous version (3.x.x or below) of the OCI Metrics Grafana Plugin and are not using Instance Principals (Environment not set as OCI instance), please refer to the Migration Instructions for Grafana OCI Metrics Data Source Settings (User Principals and Single Tenancy mode only) because you will have to reconfigure the plugin setup
Oracle Cloud Infrastructure Metrics plugin is datasource with backend type of plugin Grafana. Hereafter referred to as OCI Metrics plugin.
Installation
We highly recommend to use Grafana 8.x.x with plugin version 4.x.x . In order to simplify the installation process, we created detailed guides for you to follow.
Install Grafana and the OCI Metrics plugin on a Linux host using this document.
Install Grafana and the OCI Metrics plugin on Grafana Cloud using this document.
Install Grafana and the OCI Metrics plugin on a MacOS host using this document.
Install Grafana and the OCI Metrics plugin on a virtual machine in Oracle Cloud Infrastructure using this document.
Install Grafana and the OCI Metrics plugin on a virtual machine in Oracle Cloud Infrastructure using Terraform using this document.
Install Grafana and the OCI Metrics plugin on Kubernetes in Oracle Cloud Infrastructure using this document
Once you have the OCI Metrics Plugin installed, configure your datasource with your tenancy OCID, default region, and right IAM setup(Dynamic Group or OCI User Auth with local Private key file on Grafana Server node-depending where you're running the Grafana-Oracle Cloud or elsewhere).
We also have documentation for how to use the newly installed and configured plugin in our Using Grafana with OCI Metric Plugin walkthrough.
Note 1
If you're using a version of Grafana that's older than 6.0, you will need to download the zip file for plugin versions <=2.2.4 and install this plugin manually, or chmod the binary that is downloaded to make it executable.
Note 2
The OCI Metrics plugin supports the integration with Grafana Cloud with Data Source Environment configured as local. See this document for additional information.
Debugging
Please make sure that the golang version installed is 1.16
and grafana version installed is 8.x.x
If you want to debug golang backend plugin code, follow the steps below:
Install gops to list running go processes on your machine
Run
gops
and find processId foroci-plugin_darwin_amd64
processCopy this processId to the
.vscode/launch.json
In your VSCode from 'Debug' menu call 'Start Debugging'
Documentation
Please refer to the docs folder in this repo
Help
Issues and questions about this plugin can be posted as an issue in this GitHub repository
Contributing
This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide
Security
Please consult the security guide for our responsible security
vulnerability disclosure process.
License
Copyright (c) 2021 Oracle and/or its affiliates.
Released under the Universal Permissive License v1.0 as shown at
Grafana Cloud Pro
- $25 / user / month and includes a free trial for new users
- Available with a Grafana Cloud Pro plan
- Access to 1 Enterprise plugin
- Fully managed service (not available to self-manage)
Grafana Cloud Advanced / Grafana Enterprise
- Available with a Grafana Cloud Advanced plan or Grafana Enterprise license
- Access to all Enterprise plugins
- Run fully managed or self-manage on your own infrastructure
Installing Oracle Cloud Infrastructure Metrics on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Data Source
Use the grafana-cli tool to install Oracle Cloud Infrastructure Metrics from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.
Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.