diff options
Diffstat (limited to 'collectors/python.d.plugin/oracledb/README.md')
| -rw-r--r-- | collectors/python.d.plugin/oracledb/README.md | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/collectors/python.d.plugin/oracledb/README.md b/collectors/python.d.plugin/oracledb/README.md index 708f261d9..d61c7d2ad 100644 --- a/collectors/python.d.plugin/oracledb/README.md +++ b/collectors/python.d.plugin/oracledb/README.md @@ -1,8 +1,14 @@ -# oracledb +<!-- +title: "OracleDB monitoring with Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/oracledb/README.md +sidebar_label: "OracleDB" +--> -Module monitor oracledb performance and health metrics. +# OracleDB monitoring with Netdata -**Requirements:** +Monitors the performance and health metrics of the Oracle database. + +## Requirements - `cx_Oracle` package. - Oracle Client (using `cx_Oracle` requires Oracle Client libraries to be installed). @@ -35,14 +41,19 @@ It produces following charts: - Size - Usage - Usage In Percent +- allocated space + - Size + - Usage + - Usage In Percent ## prerequisite To use the Oracle module do the following: -1. Install `cx_Oracle` package ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-cx-oracle)). +1. Install `cx_Oracle` package ([link](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html)). -2. Install Oracle Client libraries ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-oracle-client)). +2. Install Oracle Client libraries + ([link](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html#install-oracle-client)). 3. Create a read-only `netdata` user with proper access to your Oracle Database Server. @@ -57,7 +68,15 @@ GRANT CONNECT TO netdata; GRANT SELECT_CATALOG_ROLE TO netdata; ``` -### configuration +## Configuration + +Edit the `python.d/oracledb.conf` configuration file using `edit-config` from the Netdata [config +directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`. + +```bash +cd /etc/netdata # Replace this path with your Netdata config directory, if different +sudo ./edit-config python.d/oracledb.conf +``` ```yaml local: |