Regenerate integrations.js (#18671)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Oct 3, 2024 at 08:30 UTC
88ac56fc1dbdcd3873efc63f16de28fd925cf949
5 files changed
+378
integrations/integrations.js
+38
@@ -5849,6 +5849,44 @@ export const integrations = [
5849
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/openvpn_status_log/metadata.yaml",
5850
"related_resources": ""
5851
},
5852
+ {
5853
+ "meta": {
5854
+ "id": "collector-go.d.plugin-oracledb",
5855
+ "plugin_name": "go.d.plugin",
5856
+ "module_name": "oracledb",
5857
+ "monitored_instance": {
5858
+ "name": "Oracle DB",
5859
+ "link": "https://www.oracle.com/database/",
5860
+ "categories": [
5861
+ "data-collection.database-servers"
5862
+ ],
5863
+ "icon_filename": "oracle.svg"
5864
+ },
5865
+ "related_resources": {
5866
+ "integrations": {
5867
+ "list": []
5868
+ }
5869
+ },
5870
+ "info_provided_to_referring_integrations": {
5871
+ "description": ""
5872
+ },
5873
+ "keywords": [
5874
+ "database",
5875
+ "oracle",
5876
+ "sql"
5877
+ ],
5878
+ "most_popular": false
5879
+ },
5880
+ "overview": "# Oracle DB\n\nPlugin: go.d.plugin\nModule: oracledb\n\n## Overview\n\nThis collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics.\n\n\nIt establishes a connection to the Oracle DB instance via a TCP or UNIX socket and extracts metrics from the following database tables:\n\n- `v$sysmetric`\n- `v$sysstat`\n- `v$waitclassmetric`\n- `v$system_wait_class`\n- `dba_data_files`\n- `dba_free_space`\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector can automatically detect Oracle DB instances running on:\n\n- Localhost, listening on port 1521\n- Within Docker containers\n\n> **Note**: Oracle DB requires a username and password. While Netdata can automatically discover Oracle DB instances and create data collection jobs, these jobs will fail unless you provide the correct credentials.\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
5881
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Create a read only user for netdata\n\nFollow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach\n\nConnect to your Oracle database with an administrative user and execute:\n\n```bash\nCREATE USER netdata IDENTIFIED BY <PASSWORD>;\n\nGRANT CONNECT TO netdata;\nGRANT SELECT_CATALOG_ROLE TO netdata;\n```\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/oracle.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/oracle.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| dsn | Oracle server DSN (Data Source Name). Format is `oracle://username:password@host:port/service?param1=value1&...¶mN=valueN`. | | yes |\n| timeout | Query timeout in seconds. | 1 | no |\n\n{% /details %}\n#### Examples\n\n##### TCP socket\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n dsn: oracle://netdata:secret@127.0.0.1:1521/XE\n\n```\n{% /details %}\n##### TLS connection (TCPS)\n\nAn example configuration for TLS connection.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n dsn: 'oracle://netdata:secret@127.0.0.1:1521/XE?ssl=true&ssl verify=true'\n\n```\n{% /details %}\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nLocal and remote instances.\n\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n dsn: oracle://netdata:secret@127.0.0.1:1521/XE\n\n - name: remote\n dsn: oracle://netdata:secret@203.0.113.0:1521/XE\n\n```\n{% /details %}\n",
5882
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `oracledb` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m oracledb\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `oracledb` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep oracledb\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep oracledb /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep oracledb\n```\n\n",
5883
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
5884
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Oracle DB instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| oracledb.sessions | session | sessions |\n| oracledb.average_active_sessions | active | sessions |\n| oracledb.sessions_utilization | session_limit | percent |\n| oracledb.current_logons | logons | logons |\n| oracledb.logons | logons | logons/s |\n| oracledb.database_wait_time_ratio | db_wait_time | percent |\n| oracledb.sql_service_response_time | sql_resp_time | seconds |\n| oracledb.enqueue_timeouts | enqueue | timeouts/s |\n| oracledb.disk_io | read, written | bytes/s |\n| oracledb.disk_iops | read, write | operations/s |\n| oracledb.sorts | memory, disk | sorts/s |\n| oracledb.table_scans | short_table, long_table | scans/s |\n| oracledb.cache_hit_ratio | buffer, cursor, library, row | percent |\n| oracledb.global_cache_blocks | corrupted, lost | blocks/s |\n| oracledb.activity | parse, execute, user_commits, user_rollbacks | events/s |\n\n### Per tablespace\n\nThese metrics refer to the Tablespace.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| tablespace | Tablespace name. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| oracledb.tablespace_utilization | utilization | percent |\n| oracledb.tablespace_usage | avail, used | bytes |\n\n### Per wait class\n\nThese metrics refer to the [Wait Class](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html).\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| wait_class | [Wait Class name](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html). |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| oracledb.wait_class_wait_time | wait_time | milliseconds |\n\n",
5885
+ "integration_type": "collector",
5886
+ "id": "go.d.plugin-oracledb-Oracle_DB",
5887
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/oracledb/metadata.yaml",
5888
+ "related_resources": ""
5889
+ },
5890
{
5891
"meta": {
5892
"id": "collector-go.d.plugin-pgbouncer",
integrations/integrations.json
+38
@@ -5847,6 +5847,44 @@
5847
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/openvpn_status_log/metadata.yaml",
5848
"related_resources": ""
5849
},
5850
+ {
5851
+ "meta": {
5852
+ "id": "collector-go.d.plugin-oracledb",
5853
+ "plugin_name": "go.d.plugin",
5854
+ "module_name": "oracledb",
5855
+ "monitored_instance": {
5856
+ "name": "Oracle DB",
5857
+ "link": "https://www.oracle.com/database/",
5858
+ "categories": [
5859
+ "data-collection.database-servers"
5860
+ ],
5861
+ "icon_filename": "oracle.svg"
5862
+ },
5863
+ "related_resources": {
5864
+ "integrations": {
5865
+ "list": []
5866
+ }
5867
+ },
5868
+ "info_provided_to_referring_integrations": {
5869
+ "description": ""
5870
+ },
5871
+ "keywords": [
5872
+ "database",
5873
+ "oracle",
5874
+ "sql"
5875
+ ],
5876
+ "most_popular": false
5877
+ },
5878
+ "overview": "# Oracle DB\n\nPlugin: go.d.plugin\nModule: oracledb\n\n## Overview\n\nThis collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics.\n\n\nIt establishes a connection to the Oracle DB instance via a TCP or UNIX socket and extracts metrics from the following database tables:\n\n- `v$sysmetric`\n- `v$sysstat`\n- `v$waitclassmetric`\n- `v$system_wait_class`\n- `dba_data_files`\n- `dba_free_space`\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector can automatically detect Oracle DB instances running on:\n\n- Localhost, listening on port 1521\n- Within Docker containers\n\n> **Note**: Oracle DB requires a username and password. While Netdata can automatically discover Oracle DB instances and create data collection jobs, these jobs will fail unless you provide the correct credentials.\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
5879
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Create a read only user for netdata\n\nFollow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach\n\nConnect to your Oracle database with an administrative user and execute:\n\n```bash\nCREATE USER netdata IDENTIFIED BY <PASSWORD>;\n\nGRANT CONNECT TO netdata;\nGRANT SELECT_CATALOG_ROLE TO netdata;\n```\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/oracle.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/oracle.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| dsn | Oracle server DSN (Data Source Name). Format is `oracle://username:password@host:port/service?param1=value1&...¶mN=valueN`. | | yes |\n| timeout | Query timeout in seconds. | 1 | no |\n\n#### Examples\n\n##### TCP socket\n\nAn example configuration.\n\n```yaml\njobs:\n - name: local\n dsn: oracle://netdata:secret@127.0.0.1:1521/XE\n\n```\n##### TLS connection (TCPS)\n\nAn example configuration for TLS connection.\n\n```yaml\njobs:\n - name: local\n dsn: 'oracle://netdata:secret@127.0.0.1:1521/XE?ssl=true&ssl verify=true'\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nLocal and remote instances.\n\n\n```yaml\njobs:\n - name: local\n dsn: oracle://netdata:secret@127.0.0.1:1521/XE\n\n - name: remote\n dsn: oracle://netdata:secret@203.0.113.0:1521/XE\n\n```\n",
5880
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `oracledb` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m oracledb\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `oracledb` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep oracledb\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep oracledb /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep oracledb\n```\n\n",
5881
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
5882
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Oracle DB instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| oracledb.sessions | session | sessions |\n| oracledb.average_active_sessions | active | sessions |\n| oracledb.sessions_utilization | session_limit | percent |\n| oracledb.current_logons | logons | logons |\n| oracledb.logons | logons | logons/s |\n| oracledb.database_wait_time_ratio | db_wait_time | percent |\n| oracledb.sql_service_response_time | sql_resp_time | seconds |\n| oracledb.enqueue_timeouts | enqueue | timeouts/s |\n| oracledb.disk_io | read, written | bytes/s |\n| oracledb.disk_iops | read, write | operations/s |\n| oracledb.sorts | memory, disk | sorts/s |\n| oracledb.table_scans | short_table, long_table | scans/s |\n| oracledb.cache_hit_ratio | buffer, cursor, library, row | percent |\n| oracledb.global_cache_blocks | corrupted, lost | blocks/s |\n| oracledb.activity | parse, execute, user_commits, user_rollbacks | events/s |\n\n### Per tablespace\n\nThese metrics refer to the Tablespace.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| tablespace | Tablespace name. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| oracledb.tablespace_utilization | utilization | percent |\n| oracledb.tablespace_usage | avail, used | bytes |\n\n### Per wait class\n\nThese metrics refer to the [Wait Class](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html).\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| wait_class | [Wait Class name](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html). |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| oracledb.wait_class_wait_time | wait_time | milliseconds |\n\n",
5883
+ "integration_type": "collector",
5884
+ "id": "go.d.plugin-oracledb-Oracle_DB",
5885
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/oracledb/metadata.yaml",
5886
+ "related_resources": ""
5887
+ },
5888
{
5889
"meta": {
5890
"id": "collector-go.d.plugin-pgbouncer",
src/collectors/COLLECTORS.md
+2
@@ -249,6 +249,8 @@ If you don't see the app/service you'd like to monitor in this list:
249
250
- [Oracle DB (community)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/oracle_db_community.md)
251
252
+- [Oracle DB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/oracledb/integrations/oracle_db.md)
253
+
254
- [Patroni](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/patroni.md)
255
256
- [Percona MySQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/mysql/integrations/percona_mysql.md)
src/go/plugin/go.d/modules/oracledb/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/oracle_db.md
\ No newline at end of file
src/go/plugin/go.d/modules/oracledb/integrations/oracle_db.md
new
+299
@@ -0,0 +1,299 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/oracledb/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/oracledb/metadata.yaml"
4
+sidebar_label: "Oracle DB"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Databases"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# Oracle DB
12
+
13
+
14
+<img src="https://netdata.cloud/img/oracle.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: oracledb
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics.
25
+
26
+
27
+It establishes a connection to the Oracle DB instance via a TCP or UNIX socket and extracts metrics from the following database tables:
28
+
29
+- `v$sysmetric`
30
+- `v$sysstat`
31
+- `v$waitclassmetric`
32
+- `v$system_wait_class`
33
+- `dba_data_files`
34
+- `dba_free_space`
35
+
36
+
37
+This collector is supported on all platforms.
38
+
39
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
40
+
41
+
42
+### Default Behavior
43
+
44
+#### Auto-Detection
45
+
46
+The collector can automatically detect Oracle DB instances running on:
47
+
48
+- Localhost, listening on port 1521
49
+- Within Docker containers
50
+
51
+> **Note**: Oracle DB requires a username and password. While Netdata can automatically discover Oracle DB instances and create data collection jobs, these jobs will fail unless you provide the correct credentials.
52
+
53
+
54
+#### Limits
55
+
56
+The default configuration for this integration does not impose any limits on data collection.
57
+
58
+#### Performance Impact
59
+
60
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
61
+
62
+
63
+## Metrics
64
+
65
+Metrics grouped by *scope*.
66
+
67
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
68
+
69
+
70
+
71
+### Per Oracle DB instance
72
+
73
+These metrics refer to the entire monitored application.
74
+
75
+This scope has no labels.
76
+
77
+Metrics:
78
+
79
+| Metric | Dimensions | Unit |
80
+|:------|:----------|:----|
81
+| oracledb.sessions | session | sessions |
82
+| oracledb.average_active_sessions | active | sessions |
83
+| oracledb.sessions_utilization | session_limit | percent |
84
+| oracledb.current_logons | logons | logons |
85
+| oracledb.logons | logons | logons/s |
86
+| oracledb.database_wait_time_ratio | db_wait_time | percent |
87
+| oracledb.sql_service_response_time | sql_resp_time | seconds |
88
+| oracledb.enqueue_timeouts | enqueue | timeouts/s |
89
+| oracledb.disk_io | read, written | bytes/s |
90
+| oracledb.disk_iops | read, write | operations/s |
91
+| oracledb.sorts | memory, disk | sorts/s |
92
+| oracledb.table_scans | short_table, long_table | scans/s |
93
+| oracledb.cache_hit_ratio | buffer, cursor, library, row | percent |
94
+| oracledb.global_cache_blocks | corrupted, lost | blocks/s |
95
+| oracledb.activity | parse, execute, user_commits, user_rollbacks | events/s |
96
+
97
+### Per tablespace
98
+
99
+These metrics refer to the Tablespace.
100
+
101
+Labels:
102
+
103
+| Label | Description |
104
+|:-----------|:----------------|
105
+| tablespace | Tablespace name. |
106
+
107
+Metrics:
108
+
109
+| Metric | Dimensions | Unit |
110
+|:------|:----------|:----|
111
+| oracledb.tablespace_utilization | utilization | percent |
112
+| oracledb.tablespace_usage | avail, used | bytes |
113
+
114
+### Per wait class
115
+
116
+These metrics refer to the [Wait Class](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html).
117
+
118
+Labels:
119
+
120
+| Label | Description |
121
+|:-----------|:----------------|
122
+| wait_class | [Wait Class name](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html). |
123
+
124
+Metrics:
125
+
126
+| Metric | Dimensions | Unit |
127
+|:------|:----------|:----|
128
+| oracledb.wait_class_wait_time | wait_time | milliseconds |
129
+
130
+
131
+
132
+## Alerts
133
+
134
+There are no alerts configured by default for this integration.
135
+
136
+
137
+## Setup
138
+
139
+### Prerequisites
140
+
141
+#### Create a read only user for netdata
142
+
143
+Follow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach
144
+
145
+Connect to your Oracle database with an administrative user and execute:
146
+
147
+```bash
148
+CREATE USER netdata IDENTIFIED BY <PASSWORD>;
149
+
150
+GRANT CONNECT TO netdata;
151
+GRANT SELECT_CATALOG_ROLE TO netdata;
152
+```
153
+
154
+
155
+
156
+### Configuration
157
+
158
+#### File
159
+
160
+The configuration file name for this integration is `go.d/oracle.conf`.
161
+
162
+
163
+You can edit the configuration file using the `edit-config` script from the
164
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
165
+
166
+```bash
167
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
168
+sudo ./edit-config go.d/oracle.conf
169
+```
170
+#### Options
171
+
172
+The following options can be defined globally: update_every, autodetection_retry.
173
+
174
+
175
+<details open><summary>Config options</summary>
176
+
177
+| Name | Description | Default | Required |
178
+|:----|:-----------|:-------|:--------:|
179
+| update_every | Data collection frequency. | 1 | no |
180
+| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
181
+| dsn | Oracle server DSN (Data Source Name). Format is `oracle://username:password@host:port/service?param1=value1&...¶mN=valueN`. | | yes |
182
+| timeout | Query timeout in seconds. | 1 | no |
183
+
184
+</details>
185
+
186
+#### Examples
187
+
188
+##### TCP socket
189
+
190
+An example configuration.
191
+
192
+<details open><summary>Config</summary>
193
+
194
+```yaml
195
+jobs:
196
+ - name: local
197
+ dsn: oracle://netdata:secret@127.0.0.1:1521/XE
198
+
199
+```
200
+</details>
201
+
202
+##### TLS connection (TCPS)
203
+
204
+An example configuration for TLS connection.
205
+
206
+<details open><summary>Config</summary>
207
+
208
+```yaml
209
+jobs:
210
+ - name: local
211
+ dsn: 'oracle://netdata:secret@127.0.0.1:1521/XE?ssl=true&ssl verify=true'
212
+
213
+```
214
+</details>
215
+
216
+##### Multi-instance
217
+
218
+> **Note**: When you define multiple jobs, their names must be unique.
219
+
220
+Local and remote instances.
221
+
222
+
223
+<details open><summary>Config</summary>
224
+
225
+```yaml
226
+jobs:
227
+ - name: local
228
+ dsn: oracle://netdata:secret@127.0.0.1:1521/XE
229
+
230
+ - name: remote
231
+ dsn: oracle://netdata:secret@203.0.113.0:1521/XE
232
+
233
+```
234
+</details>
235
+
236
+
237
+
238
+## Troubleshooting
239
+
240
+### Debug Mode
241
+
242
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
243
+
244
+To troubleshoot issues with the `oracledb` collector, run the `go.d.plugin` with the debug option enabled. The output
245
+should give you clues as to why the collector isn't working.
246
+
247
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
248
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
249
+
250
+ ```bash
251
+ cd /usr/libexec/netdata/plugins.d/
252
+ ```
253
+
254
+- Switch to the `netdata` user.
255
+
256
+ ```bash
257
+ sudo -u netdata -s
258
+ ```
259
+
260
+- Run the `go.d.plugin` to debug the collector:
261
+
262
+ ```bash
263
+ ./go.d.plugin -d -m oracledb
264
+ ```
265
+
266
+### Getting Logs
267
+
268
+If you're encountering problems with the `oracledb` collector, follow these steps to retrieve logs and identify potential issues:
269
+
270
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
271
+- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
272
+
273
+#### System with systemd
274
+
275
+Use the following command to view logs generated since the last Netdata service restart:
276
+
277
+```bash
278
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep oracledb
279
+```
280
+
281
+#### System without systemd
282
+
283
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
284
+
285
+```bash
286
+grep oracledb /var/log/netdata/collector.log
287
+```
288
+
289
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
290
+
291
+#### Docker Container
292
+
293
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
294
+
295
+```bash
296
+docker logs netdata 2>&1 | grep oracledb
297
+```
298
+
299
+