Some drivers require additional configuration to work. Find here instructions for these drivers.
To get connected with the Oracle Database
ORACLE_HOME environment variables should be set.
For example: Let us consider Oracle Database 21c installation using RPM manually by following this link, environment variables should be set as follows:
export ORACLE_BASE=/opt/oracle/oradata export ORACLE_HOME=/opt/oracle/product/21c/dbhome_1
ORACLE_HOME/bin to the
PATH environment variable.
Oracle Instant Client enables the development and deployment of applications that connect to the Oracle Database. The Instant Client libraries provide the necessary network connectivity and advanced data features to make full use of the Oracle Database. If you have an OCI Oracle server which comes with these libraries pre-installed, you don’t need a separate client installation.
The OCI library installs a few Client Shared Libraries that must be referenced on the machine where Metricbeat is installed. Please follow this link for OCI Instant Client set up. The OCI Instant Client is available with the Oracle Universal Installer, RPM file or ZIP file. Download links can be found at here.
The Oracle listener is a service that runs on the database host and receives requests from Oracle clients. Make sure that listener should be running. To check if the listener is running or not, run:
If the listener is not running, use the command to start:
Then, Metricbeat can be launched.
The following two types of host configurations are supported:
DSN host configuration as URL:
hosts: ["firstname.lastname@example.org:1521/ORCLPDB1.localdomain as sysdba"]
DSN host configuration:
hosts: ['user="user" password="pass" connectString="0.0.0.0:1521/ORCLPDB1.localdomain"']
hosts: ['user="user" password="password" connectString="host:port/service_name" sysdba=true']
Note: If the password contains the backslash (
\) character, it must be escaped with a backslash. For example, if the password is
my\_password, it should be written as
The username and password to connect to the database can be provided as values to
password keys of
- module: sql metricsets: - query period: 10s driver: "oracle" enabled: true hosts: ['user="" password="" connectString="0.0.0.0:1521/ORCLCDB.localdomain" sysdba=true'] username: sys password: password sql_queries: - query: SELECT METRIC_NAME, VALUE FROM V$SYSMETRIC WHERE GROUP_ID = 2 and METRIC_NAME LIKE '%' response_format: variables
The SQL module supports the standard configuration options that are described in Modules. Here is an example configuration:
metricbeat.modules: - module: sql metricsets: - query period: 10s hosts: ["user=myuser password=mypassword dbname=mydb sslmode=disable"] driver: "postgres" sql_query: "select now()" sql_response_format: table
The following metricsets are available: