Oracle Cloud by HTTP

Overview

This template is designed as a master template that discovers various Oracle Cloud Infrastructure (OCI) services and resources, such as:

• OCI Compute;

• OCI Autonomous Database (serverless);

• OCI Object Storage;

• OCI Virtual Cloud Networks (VCNs);

• OCI Block Volumes;

• OCI Boot Volumes.

For communication with OCI, this template utilizes script items which execute HTTP GET and POST requests. POST requests are required for OCI Monitoring API as it utilizes Monitoring Query Language (MQL) which uses an HTTP request body for queries.

Requirements

Zabbix version: 7.2 and higher.

Tested versions

This template has been tested on:

• Oracle Cloud Infrastructure

Configuration

Zabbix should be configured according to the instructions in the Templates out of the box section.

Setup

Required setup

For this template to work, it needs authentication details to use in requests. To acquire this information, see the following steps:

1. Log into your administrator account in Oracle Cloud Console.

2. Create a new user that will be used by Zabbix for monitoring.

3. Create a new security policy and assign a previously created user to it.

4. This policy will contain a set of rules that will give monitoring user access to specific resources in your OCI. Make sure to add the following rules to the policy:

   Allow group 'zabbix_api' to read metrics in tenancy
   Allow group 'zabbix_api' to read instances in tenancy
   Allow group 'zabbix_api' to read subnets in tenancy
   Allow group 'zabbix_api' to read vcns in tenancy
   Allow group 'zabbix_api' to read vnic-attachments in tenancy
   Allow group 'zabbix_api' to read volumes in tenancy
   Allow group 'zabbix_api' to read objectstorage-namespaces in tenancy
   Allow group 'zabbix_api' to read buckets in tenancy
   Allow group 'zabbix_api' to read autonomous-databases in tenancy
   

   In this example, zabbix_api is the name of the previously created monitoring user. Rename it to your monitoring user's name.

5. Generate an API key pair for your monitoring user - open your monitoring user profile and on the left side, press API keys and then, Add API key (if generating a new key pair, do not forget to save the private key).

6. After this, Oracle Cloud Console will provide additional information that is required for access, such as:

   • Tenancy OCID;

   • User OCID;

   • Fingerprint;

   • Region.

   Save this information somewhere or keep this window open. This information will be required in later steps.

7. In Zabbix, create a new host and assign this template to it (Oracle Cloud by HTTP).

8. Open the Macros section of the host you created and set the following user macro values according to the OCI configuration file (from step #6):

   • {$OCI.API.TENANCY} - set the tenancy OCID value;

   • {$OCI.API.USER} - set the user OCID value;

   • {$OCI.API.FINGERPRINT} - set the fingerprint value;

   • {$OCI.API.PRIVATE.KEY} - copy and paste the contents of private key file here.

9. After the authentication credentials are entered, you need to identify the OCI API endpoints that match your region (as provided by Oracle Cloud Console in step #6). To do so, you can use the OCI API Reference and Endpoints list, where each API service has a dedicated page with the respective API endpoints.

   The required API service endpoints are:

   • Core Services API;

   • Database Service API;

   • Object Storage Service API;

   • Monitoring API.

10. When the API endpoints are identified, you need to set them in Zabbix as user macros to the host that the template is attached to (similarly to step #8):

    • {$OCI.API.CORE.HOST} - Core Services API endpoint, for example, iaas.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.AUTONOMOUS.DB.HOST} - Database Service API endpoint, for example, database.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.OBJECT.STORAGE.HOST} - Object Storage Service API endpoint, for example, objectstorage.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.TELEMETRY.HOST} - Monitoring API endpoint, for example, telemetry.eu-stockholm-1.oraclecloud.com;

    IMPORTANT! API Endpoint URLs need to be entered without the HTTP scheme (https://).

11. Once you've completed adding the host to Zabbix, and it will automatically discover services and monitor them.

Optional setup

LLD resource filtering by free-form tags of OCI resources

Every LLD rule has pre-added filtering options to avoid discovering unwanted resources, such as terminated OCI compute instances. Most of these filters use specific service item names and states, and values of these filters are defined by the user macros {$....MATCHES} and {$....NOT_MATCHES}.

To add additional filtering options, every discovery script (except VCN discovery), gathers free-form tag data about a specific resource. Since free-form tags are completely custom and format or usage will vary between users, free-from tag filters are not included under LLD filters by default, but can be easily added as they are already being collected by scripts.

Example

1. In Oracle Cloud Console, add a free-form tag to a resource, for example, a compute instance. The tag key will be location_group and the tag value will be eu-north-1.

2. Open the Oracle Cloud by HTTP template in Zabbix and go to "Discovery rules". Find "Compute instances discovery" and open it.

3. Under "LLD macros", add a new macro that will represent this location group tag, for example: {#LOCATION_GROUP} $.tags.location_group.

4. Under the "Filters" tab, there will already be filters regarding the compute instance name and state. Click "Add" to add a new filter and define the previously created LLD macro and add a matching pattern and value, for example, {#LOCATION_GROUP} matches eu-north-*.

5. The next time Compute instances discovery is executed, it will only discover OCI compute instances that have the free-form tag location_group that matches the regex of eu-north-*. You can also experiment with the LLD filter pattern matching value to receive different matching results for a specified value.

HTTP proxy usage

If needed, you can specify an HTTP proxy for the template by changing the value of the {$OCI.HTTP.PROXY} user macro.

Custom OK HTTP response

If using a proxy, the returned OK HTTP response could change from "200" to a different value. In that case, please adjust the user macro {$OCI.HTTP.RETURN.CODE.OK}.

LLD filter value changing

LLD filter values and trigger threshold values can be changed with the respective user macros.

Macros used

LLD rule Compute instances discovery

LLD rule Virtual cloud networks discovery

LLD rule Block volumes discovery

LLD rule Boot volumes discovery

LLD rule Object storage discovery

LLD rule Autonomous database discovery

Oracle Cloud by HTTP

Overview

This template is designed to monitor Oracle Cloud by HTTP. It works without any external scripts and uses the script item. Currently, the template supports the discovery of Compute instances, Autonomous Databases, Object Storage, Virtual Cloud Networks (VCNs), Block Volumes, and Boot Volumes.

Included Monitoring Templates

• Oracle Cloud Autonomous Database by HTTP
• Oracle Cloud Block Volume by HTTP
• Oracle Cloud Boot Volume by HTTP
• Oracle Cloud Compute by HTTP
• Oracle Cloud Networking by HTTP
• Oracle Cloud Object Storage by HTTP

For communication with OCI, this template utilizes script items which execute HTTP GET and POST requests. POST requests are required for OCI Monitoring API as it utilizes Monitoring Query Language (MQL) which uses an HTTP request body for queries.

Requirements

Zabbix version: 7.0 and higher.

Tested versions

This template has been tested on:

• Oracle Cloud Infrastructure

Configuration

Zabbix should be configured according to the instructions in the Templates out of the box section.

Setup

Required setup

For this template to work, it needs authentication details to use in requests. To acquire this information, see the following steps:

1. Log into your administrator account in Oracle Cloud Console.

2. Create a new user that will be used by Zabbix for monitoring. Optionally, create a new group and assign the monitoring user to this group.

3. Create a new security policy and assign a previously created user or group to it.

4. This policy will contain a set of rules that will give monitoring user/group access to specific resources in your OCI. Make sure to add the following rules to the policy:

   Allow group 'zabbix_api' to read metrics in tenancy
   Allow group 'zabbix_api' to read instances in tenancy
   Allow group 'zabbix_api' to read subnets in tenancy
   Allow group 'zabbix_api' to read vcns in tenancy
   Allow group 'zabbix_api' to read vnic-attachments in tenancy
   Allow group 'zabbix_api' to read volumes in tenancy
   Allow group 'zabbix_api' to read objectstorage-namespaces in tenancy
   Allow group 'zabbix_api' to read buckets in tenancy
   Allow group 'zabbix_api' to read autonomous-databases in tenancy
   

   In the example above, the name of the monitoring group is zabbix_api. In your setup, replace it with the name of your monitoring user/group.

   In some cases, these rules might not be enough for the monitoring user to be able to access all resources in your environment. To fix that, replace the previous rules with this single rule:

   Allow group 'zabbix_api' to read all-resources in tenancy
   

5. Generate an API key pair for your monitoring user - open your monitoring user profile and on the left side, press API keys and then, Add API key (if generating a new key pair, do not forget to save the private key).

6. After this, Oracle Cloud Console will provide additional information that is required for access, such as:

   • Tenancy OCID;

   • User OCID;

   • Fingerprint;

   • Region.

   Save this information somewhere or keep this window open. This information will be required in later steps.

7. In Zabbix, create a new host and assign this template to it (Oracle Cloud by HTTP).

8. Open the Macros section of the host you created and set the following user macro values according to the OCI configuration file (from step #6):

   • {$OCI.API.TENANCY} - set the tenancy OCID value;

   • {$OCI.API.USER} - set the user OCID value;

   • {$OCI.API.FINGERPRINT} - set the fingerprint value;

   • {$OCI.API.PRIVATE.KEY} - copy and paste the contents of private key file here.

9. After the authentication credentials are entered, you need to identify the OCI API endpoints that match your region (as provided by Oracle Cloud Console in step #6). To do so, you can use the OCI API Reference and Endpoints list, where each API service has a dedicated page with the respective API endpoints.

   The required API service endpoints are:

   • Core Services API;

   • Database Service API;

   • Object Storage Service API;

   • Monitoring API.

10. When the API endpoints are identified, you need to set them in Zabbix as user macros to the host that the template is attached to (similarly to step #8):

    • {$OCI.API.CORE.HOST} - Core Services API endpoint, for example, iaas.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.AUTONOMOUS.DB.HOST} - Database Service API endpoint, for example, database.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.OBJECT.STORAGE.HOST} - Object Storage Service API endpoint, for example, objectstorage.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.TELEMETRY.HOST} - Monitoring API endpoint, for example, telemetry.eu-stockholm-1.oraclecloud.com;

    IMPORTANT! API Endpoint URLs need to be entered without the HTTP scheme (https://).

11. Once you've completed adding the host to Zabbix, and it will automatically discover services and monitor them.

Optional setup

LLD resource filtering by free-form tags of OCI resources

Every LLD rule has pre-added filtering options to avoid discovering unwanted resources, such as terminated OCI compute instances. Most of these filters use specific service item names and states, and values of these filters are defined by the user macros {$....MATCHES} and {$....NOT_MATCHES}.

To add additional filtering options, every discovery script (except VCN discovery), gathers free-form tag data about a specific resource. Since free-form tags are completely custom and format or usage will vary between users, free-from tag filters are not included under LLD filters by default, but can be easily added as they are already being collected by scripts.

Example

1. In Oracle Cloud Console, add a free-form tag to a resource, for example, a compute instance. The tag key will be location_group and the tag value will be eu-north-1.

2. Open the Oracle Cloud by HTTP template in Zabbix and go to "Discovery rules". Find "Compute instances discovery" and open it.

3. Under "LLD macros", add a new macro that will represent this location group tag, for example: {#LOCATION_GROUP} $.tags.location_group.

4. Under the "Filters" tab, there will already be filters regarding the compute instance name and state. Click "Add" to add a new filter and define the previously created LLD macro and add a matching pattern and value, for example, {#LOCATION_GROUP} matches eu-north-*.

5. The next time Compute instances discovery is executed, it will only discover OCI compute instances that have the free-form tag location_group that matches the regex of eu-north-*. You can also experiment with the LLD filter pattern matching value to receive different matching results for a specified value.

HTTP proxy usage

If needed, you can specify an HTTP proxy for the template by changing the value of the {$OCI.HTTP.PROXY} user macro.

Custom OK HTTP response

If using a proxy, the returned OK HTTP response could change from "200" to a different value. In that case, please adjust the user macro {$OCI.HTTP.RETURN.CODE.OK}.

LLD filter value changing

LLD filter values and trigger threshold values can be changed with the respective user macros.

Macros used

LLD rule Compute instances discovery

LLD rule Virtual cloud networks discovery

LLD rule Block volumes discovery

LLD rule Boot volumes discovery

LLD rule Object storage discovery

LLD rule Autonomous database discovery

Oracle Cloud by HTTP

Overview

This template is designed as a master template that discovers various Oracle Cloud Infrastructure (OCI) services and resources, such as:

• OCI Compute;

• OCI Autonomous Database (serverless);

• OCI Object Storage;

• OCI Virtual Cloud Networks (VCNs);

• OCI Block Volumes;

• OCI Boot Volumes.

For communication with OCI, this template utilizes script items which execute HTTP GET and POST requests. POST requests are required for OCI Monitoring API as it utilizes Monitoring Query Language (MQL) which uses an HTTP request body for queries.

Requirements

Zabbix version: 6.4 and higher.

Tested versions

This template has been tested on:

• Oracle Cloud Infrastructure

Configuration

Zabbix should be configured according to the instructions in the Templates out of the box section.

Setup

Required setup

For this template to work, it needs authentication details to use in requests. To acquire this information, see the following steps:

1. Log into your administrator account in Oracle Cloud Console.

2. Create a new user that will be used by Zabbix for monitoring.

3. Create a new security policy and assign a previously created user to it.

4. This policy will contain a set of rules that will give monitoring user access to specific resources in your OCI. Make sure to add the following rules to the policy:

   Allow group 'zabbix_api' to read metrics in tenancy
   Allow group 'zabbix_api' to read instances in tenancy
   Allow group 'zabbix_api' to read subnets in tenancy
   Allow group 'zabbix_api' to read vcns in tenancy
   Allow group 'zabbix_api' to read vnic-attachments in tenancy
   Allow group 'zabbix_api' to read volumes in tenancy
   Allow group 'zabbix_api' to read objectstorage-namespaces in tenancy
   Allow group 'zabbix_api' to read buckets in tenancy
   Allow group 'zabbix_api' to read autonomous-databases in tenancy
   

   In this example, zabbix_api is the name of the previously created monitoring user. Rename it to your monitoring user's name.

5. Generate an API key pair for your monitoring user - open your monitoring user profile and on the left side, press API keys and then, Add API key (if generating a new key pair, do not forget to save the private key).

6. After this, Oracle Cloud Console will provide additional information that is required for access, such as:

   • Tenancy OCID;

   • User OCID;

   • Fingerprint;

   • Region.

   Save this information somewhere or keep this window open. This information will be required in later steps.

7. In Zabbix, create a new host and assign this template to it (Oracle Cloud by HTTP).

8. Open the Macros section of the host you created and set the following user macro values according to the OCI configuration file (from step #6):

   • {$OCI.API.TENANCY} - set the tenancy OCID value;

   • {$OCI.API.USER} - set the user OCID value;

   • {$OCI.API.FINGERPRINT} - set the fingerprint value;

   • {$OCI.API.PRIVATE.KEY} - copy and paste the contents of private key file here.

9. After the authentication credentials are entered, you need to identify the OCI API endpoints that match your region (as provided by Oracle Cloud Console in step #6). To do so, you can use the OCI API Reference and Endpoints list, where each API service has a dedicated page with the respective API endpoints.

   The required API service endpoints are:

   • Core Services API;

   • Database Service API;

   • Object Storage Service API;

   • Monitoring API.

10. When the API endpoints are identified, you need to set them in Zabbix as user macros to the host that the template is attached to (similarly to step #8):

    • {$OCI.API.CORE.HOST} - Core Services API endpoint, for example, iaas.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.AUTONOMOUS.DB.HOST} - Database Service API endpoint, for example, database.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.OBJECT.STORAGE.HOST} - Object Storage Service API endpoint, for example, objectstorage.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.TELEMETRY.HOST} - Monitoring API endpoint, for example, telemetry.eu-stockholm-1.oraclecloud.com;

    IMPORTANT! API Endpoint URLs need to be entered without the HTTP scheme (https://).

11. Once you've completed adding the host to Zabbix, and it will automatically discover services and monitor them.

Optional setup

LLD resource filtering by free-form tags of OCI resources

Every LLD rule has pre-added filtering options to avoid discovering unwanted resources, such as terminated OCI compute instances. Most of these filters use specific service item names and states, and values of these filters are defined by the user macros {$....MATCHES} and {$....NOT_MATCHES}.

To add additional filtering options, every discovery script (except VCN discovery), gathers free-form tag data about a specific resource. Since free-form tags are completely custom and format or usage will vary between users, free-from tag filters are not included under LLD filters by default, but can be easily added as they are already being collected by scripts.

Example

1. In Oracle Cloud Console, add a free-form tag to a resource, for example, a compute instance. The tag key will be location_group and the tag value will be eu-north-1.

2. Open the Oracle Cloud by HTTP template in Zabbix and go to "Discovery rules". Find "Compute instances discovery" and open it.

3. Under "LLD macros", add a new macro that will represent this location group tag, for example: {#LOCATION_GROUP} $.tags.location_group.

4. Under the "Filters" tab, there will already be filters regarding the compute instance name and state. Click "Add" to add a new filter and define the previously created LLD macro and add a matching pattern and value, for example, {#LOCATION_GROUP} matches eu-north-*.

5. The next time Compute instances discovery is executed, it will only discover OCI compute instances that have the free-form tag location_group that matches the regex of eu-north-*. You can also experiment with the LLD filter pattern matching value to receive different matching results for a specified value.

HTTP proxy usage

If needed, you can specify an HTTP proxy for the template by changing the value of the {$OCI.HTTP.PROXY} user macro.

Custom OK HTTP response

If using a proxy, the returned OK HTTP response could change from "200" to a different value. In that case, please adjust the user macro {$OCI.HTTP.RETURN.CODE.OK}.

LLD filter value changing

LLD filter values and trigger threshold values can be changed with the respective user macros.

Macros used

LLD rule Compute instances discovery

LLD rule Virtual cloud networks discovery

LLD rule Block volumes discovery

LLD rule Boot volumes discovery

LLD rule Object storage discovery

LLD rule Autonomous database discovery

Oracle Cloud by HTTP

Overview

This template is designed as a master template that discovers various Oracle Cloud Infrastructure (OCI) services and resources, such as:

• OCI Compute;

• OCI Autonomous Database (serverless);

• OCI Object Storage;

• OCI Virtual Cloud Networks (VCNs);

• OCI Block Volumes;

• OCI Boot Volumes.

For communication with OCI, this template utilizes script items which execute HTTP GET and POST requests. POST requests are required for OCI Monitoring API as it utilizes Monitoring Query Language (MQL) which uses an HTTP request body for queries.

Requirements

Zabbix version: 6.0 and higher.

Tested versions

This template has been tested on:

• Oracle Cloud Infrastructure

Configuration

Zabbix should be configured according to the instructions in the Templates out of the box section.

Setup

Required setup

For this template to work, it needs authentication details to use in requests. To acquire this information, see the following steps:

1. Log into your administrator account in Oracle Cloud Console.

2. Create a new user that will be used by Zabbix for monitoring.

3. Create a new security policy and assign a previously created user to it.

4. This policy will contain a set of rules that will give monitoring user access to specific resources in your OCI. Make sure to add the following rules to the policy:

   Allow group 'zabbix_api' to read metrics in tenancy
   Allow group 'zabbix_api' to read instances in tenancy
   Allow group 'zabbix_api' to read subnets in tenancy
   Allow group 'zabbix_api' to read vcns in tenancy
   Allow group 'zabbix_api' to read vnic-attachments in tenancy
   Allow group 'zabbix_api' to read volumes in tenancy
   Allow group 'zabbix_api' to read objectstorage-namespaces in tenancy
   Allow group 'zabbix_api' to read buckets in tenancy
   Allow group 'zabbix_api' to read autonomous-databases in tenancy
   

   In this example, zabbix_api is the name of the previously created monitoring user. Rename it to your monitoring user's name.

5. Generate an API key pair for your monitoring user - open your monitoring user profile and on the left side, press API keys and then, Add API key (if generating a new key pair, do not forget to save the private key).

6. After this, Oracle Cloud Console will provide additional information that is required for access, such as:

   • Tenancy OCID;

   • User OCID;

   • Fingerprint;

   • Region.

   Save this information somewhere or keep this window open. This information will be required in later steps.

7. In Zabbix, create a new host and assign this template to it (Oracle Cloud by HTTP).

8. Open the Macros section of the host you created and set the following user macro values according to the OCI configuration file (from step #6):

   • {$OCI.API.TENANCY} - set the tenancy OCID value;

   • {$OCI.API.USER} - set the user OCID value;

   • {$OCI.API.FINGERPRINT} - set the fingerprint value;

   • {$OCI.API.PRIVATE.KEY} - copy and paste the contents of private key file here.

9. After the authentication credentials are entered, you need to identify the OCI API endpoints that match your region (as provided by Oracle Cloud Console in step #6). To do so, you can use the OCI API Reference and Endpoints list, where each API service has a dedicated page with the respective API endpoints.

   The required API service endpoints are:

   • Core Services API;

   • Database Service API;

   • Object Storage Service API;

   • Monitoring API.

10. When the API endpoints are identified, you need to set them in Zabbix as user macros to the host that the template is attached to (similarly to step #8):

    • {$OCI.API.CORE.HOST} - Core Services API endpoint, for example, iaas.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.AUTONOMOUS.DB.HOST} - Database Service API endpoint, for example, database.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.OBJECT.STORAGE.HOST} - Object Storage Service API endpoint, for example, objectstorage.eu-stockholm-1.oraclecloud.com;

    • {$OCI.API.TELEMETRY.HOST} - Monitoring API endpoint, for example, telemetry.eu-stockholm-1.oraclecloud.com;

    IMPORTANT! API Endpoint URLs need to be entered without the HTTP scheme (https://).

11. Once you've completed adding the host to Zabbix, and it will automatically discover services and monitor them.

Optional setup

LLD resource filtering by free-form tags of OCI resources

Every LLD rule has pre-added filtering options to avoid discovering unwanted resources, such as terminated OCI compute instances. Most of these filters use specific service item names and states, and values of these filters are defined by the user macros {$....MATCHES} and {$....NOT_MATCHES}.

To add additional filtering options, every discovery script (except VCN discovery), gathers free-form tag data about a specific resource. Since free-form tags are completely custom and format or usage will vary between users, free-from tag filters are not included under LLD filters by default, but can be easily added as they are already being collected by scripts.

Example

1. In Oracle Cloud Console, add a free-form tag to a resource, for example, a compute instance. The tag key will be location_group and the tag value will be eu-north-1.

2. Open the Oracle Cloud by HTTP template in Zabbix and go to "Discovery rules". Find "Compute instances discovery" and open it.

3. Under "LLD macros", add a new macro that will represent this location group tag, for example: {#LOCATION_GROUP} $.tags.location_group.

4. Under the "Filters" tab, there will already be filters regarding the compute instance name and state. Click "Add" to add a new filter and define the previously created LLD macro and add a matching pattern and value, for example, {#LOCATION_GROUP} matches eu-north-*.

5. The next time Compute instances discovery is executed, it will only discover OCI compute instances that have the free-form tag location_group that matches the regex of eu-north-*. You can also experiment with the LLD filter pattern matching value to receive different matching results for a specified value.

HTTP proxy usage

If needed, you can specify an HTTP proxy for the template by changing the value of the {$OCI.HTTP.PROXY} user macro.

Custom OK HTTP response

If using a proxy, the returned OK HTTP response could change from "200" to a different value. In that case, please adjust the user macro {$OCI.HTTP.RETURN.CODE.OK}.

LLD filter value changing

LLD filter values and trigger threshold values can be changed with the respective user macros.

Macros used

LLD rule Compute instances discovery

LLD rule Virtual cloud networks discovery

LLD rule Block volumes discovery

LLD rule Boot volumes discovery

LLD rule Object storage discovery

LLD rule Autonomous database discovery