summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/oracledb/README.md
blob: 2e5972a051251dfc69c2588468aa994561b7820b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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)]()