oci-grafana-metrics

README

About OCI Grafana Metrics plugin

Installation

Oracle Cloud Infrastructure Metrics Data Source

Introduction

This plugin makes queries to the Oracle Cloud Infrastructure Monitoring Service and displays them on Grafana.

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.

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.

Note

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.

In order to simplify the installation process, we created detailed guides for you to follow:

• Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a Linux host using this document.
• Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a MacOS host using this document.
• Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a virtual machine in Oracle Cloud Infrastructure using this document.
• Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on a virtual machine in Oracle Cloud Infrastructure using Terraform using this document.
• Install Grafana and the Oracle Cloud Infrastructure Data Source for Grafana on Kubernetes in Oracle Cloud Infrastructure using this document

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).

We also have documentation for how to use the newly installed and configured plugin in our Using Grafana with Oracle Cloud Infrastructure Data Source walkthrough.

Debugging

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 for oci-plugin_darwin_amd64 process
• Copy 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 https://oss.oracle.com/licenses/upl/.

Documentation

Overview

Copyright © 2019 Oracle and/or its affiliates. All rights reserved. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.

Copyright © 2019 Oracle and/or its affiliates. All rights reserved. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.