1 files changed, 77 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/oracledb/README.md b/collectors/python.d.plugin/oracledb/README.md
new file mode 100644
index 000000000..2e5972a05
--- /dev/null
+++ b/collectors/python.d.plugin/oracledb/README.md
@@ -0,0 +1,77 @@
+# oracledb
+
+Module monitor oracledb performance and health metrics.
+
+**Requirements:**
+ - `cx_Oracle` package.
+ - Oracle Client (using `cx_Oracle` requires Oracle Client libraries to be installed).
+
+It produces following charts:
+ - session activity
+   - Session Count
+   - Session Limit Usage
+   - Logons
+ - disk activity
+   - Physical Disk Reads/Writes
+   - Sorts On Disk
+   - Full Table Scans
+ - database and buffer activity
+   - Database Wait Time Ratio
+   - Shared Pool Free Memory
+   - In-Memory Sorts Ratio
+   - SQL Service Response Time
+   - User Rollbacks
+   - Enqueue Timeouts
+ - cache
+   - Cache Hit Ratio
+   - Global Cache Blocks Events
+ - activities
+   - Activities
+ - wait time
+   - Wait Time
+ - tablespace
+   - 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)).
+
+2. Install Oracle Client libraries ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-oracle-client)).
+
+3. Create a read-only netdata user with proper access to your Oracle Database Server.
+
+Connect to your Oracle database with an administrative user and execute:
+
+```
+ALTER SESSION SET "_ORACLE_SCRIPT"=true;
+
+CREATE USER netdata IDENTIFIED BY <PASSWORD>;
+
+GRANT CONNECT TO netdata;
+GRANT SELECT_CATALOG_ROLE TO netdata;
+
+``` 
+
+### configuration
+
+```yaml
+local:
+  user: 'netdata'
+  password: 'secret'
+  server: 'localhost:1521'
+  service: 'XE'
+
+remote:
+  user: 'netdata'
+  password: 'secret'
+  server: '10.0.0.1:1521'
+  service: 'XE'
+```
+
+All parameters are required. Without them module will fail to start.
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Foracledb%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()