Browse Source

Regenerate integrations.js (#18671)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot 5 months ago
parent
commit
88ac56fc1d

File diff suppressed because it is too large
+ 29 - 0
integrations/integrations.js


File diff suppressed because it is too large
+ 29 - 0
integrations/integrations.json


+ 2 - 0
src/collectors/COLLECTORS.md

@@ -249,6 +249,8 @@ If you don't see the app/service you'd like to monitor in this list:
 
 - [Oracle DB (community)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/oracle_db_community.md)
 
+- [Oracle DB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/oracledb/integrations/oracle_db.md)
+
 - [Patroni](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/patroni.md)
 
 - [Percona MySQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/mysql/integrations/percona_mysql.md)

+ 1 - 0
src/go/plugin/go.d/modules/oracledb/README.md

@@ -0,0 +1 @@
+integrations/oracle_db.md

+ 299 - 0
src/go/plugin/go.d/modules/oracledb/integrations/oracle_db.md

@@ -0,0 +1,299 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/oracledb/README.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/oracledb/metadata.yaml"
+sidebar_label: "Oracle DB"
+learn_status: "Published"
+learn_rel_path: "Collecting Metrics/Databases"
+most_popular: False
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
+endmeta-->
+
+# Oracle DB
+
+
+<img src="https://netdata.cloud/img/oracle.svg" width="150"/>
+
+
+Plugin: go.d.plugin
+Module: oracledb
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Overview
+
+This collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics.
+
+
+It establishes a connection to the Oracle DB instance via a TCP or UNIX socket and extracts metrics from the following database tables:
+
+- `v$sysmetric`
+- `v$sysstat`
+- `v$waitclassmetric`
+- `v$system_wait_class`
+- `dba_data_files`
+- `dba_free_space`
+
+
+This collector is supported on all platforms.
+
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
+
+
+### Default Behavior
+
+#### Auto-Detection
+
+The collector can automatically detect Oracle DB instances running on:
+
+- Localhost, listening on port 1521
+- Within Docker containers
+
+> **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.
+
+
+#### Limits
+
+The default configuration for this integration does not impose any limits on data collection.
+
+#### Performance Impact
+
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
+
+
+## Metrics
+
+Metrics grouped by *scope*.
+
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
+
+
+
+### Per Oracle DB instance
+
+These metrics refer to the entire monitored application.
+
+This scope has no labels.
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| oracledb.sessions | session | sessions |
+| oracledb.average_active_sessions | active | sessions |
+| oracledb.sessions_utilization | session_limit | percent |
+| oracledb.current_logons | logons | logons |
+| oracledb.logons | logons | logons/s |
+| oracledb.database_wait_time_ratio | db_wait_time | percent |
+| oracledb.sql_service_response_time | sql_resp_time | seconds |
+| oracledb.enqueue_timeouts | enqueue | timeouts/s |
+| oracledb.disk_io | read, written | bytes/s |
+| oracledb.disk_iops | read, write | operations/s |
+| oracledb.sorts | memory, disk | sorts/s |
+| oracledb.table_scans | short_table, long_table | scans/s |
+| oracledb.cache_hit_ratio | buffer, cursor, library, row | percent |
+| oracledb.global_cache_blocks | corrupted, lost | blocks/s |
+| oracledb.activity | parse, execute, user_commits, user_rollbacks | events/s |
+
+### Per tablespace
+
+These metrics refer to the Tablespace.
+
+Labels:
+
+| Label      | Description     |
+|:-----------|:----------------|
+| tablespace | Tablespace name. |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| oracledb.tablespace_utilization | utilization | percent |
+| oracledb.tablespace_usage | avail, used | bytes |
+
+### Per wait class
+
+These metrics refer to the [Wait Class](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html).
+
+Labels:
+
+| Label      | Description     |
+|:-----------|:----------------|
+| wait_class | [Wait Class name](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/classes-of-wait-events.html). |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| oracledb.wait_class_wait_time | wait_time | milliseconds |
+
+
+
+## Alerts
+
+There are no alerts configured by default for this integration.
+
+
+## Setup
+
+### Prerequisites
+
+#### Create a read only user for netdata
+
+Follow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach
+
+Connect to your Oracle database with an administrative user and execute:
+
+```bash
+CREATE USER netdata IDENTIFIED BY <PASSWORD>;
+
+GRANT CONNECT TO netdata;
+GRANT SELECT_CATALOG_ROLE TO netdata;
+```
+
+
+
+### Configuration
+
+#### File
+
+The configuration file name for this integration is `go.d/oracle.conf`.
+
+
+You can edit the configuration file using the `edit-config` script from the
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
+
+```bash
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
+sudo ./edit-config go.d/oracle.conf
+```
+#### Options
+
+The following options can be defined globally: update_every, autodetection_retry.
+
+
+<details open><summary>Config options</summary>
+
+| Name | Description | Default | Required |
+|:----|:-----------|:-------|:--------:|
+| update_every | Data collection frequency. | 1 | no |
+| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
+| dsn | Oracle server DSN (Data Source Name). Format is `oracle://username:password@host:port/service?param1=value1&...&paramN=valueN`. |  | yes |
+| timeout | Query timeout in seconds. | 1 | no |
+
+</details>
+
+#### Examples
+
+##### TCP socket
+
+An example configuration.
+
+<details open><summary>Config</summary>
+
+```yaml
+jobs:
+  - name: local
+    dsn: oracle://netdata:secret@127.0.0.1:1521/XE
+
+```
+</details>
+
+##### TLS connection (TCPS)
+
+An example configuration for TLS connection.
+
+<details open><summary>Config</summary>
+
+```yaml
+jobs:
+  - name: local
+    dsn: 'oracle://netdata:secret@127.0.0.1:1521/XE?ssl=true&ssl verify=true'
+
+```
+</details>
+
+##### Multi-instance
+
+> **Note**: When you define multiple jobs, their names must be unique.
+
+Local and remote instances.
+
+
+<details open><summary>Config</summary>
+
+```yaml
+jobs:
+  - name: local
+    dsn: oracle://netdata:secret@127.0.0.1:1521/XE
+
+  - name: remote
+    dsn: oracle://netdata:secret@203.0.113.0:1521/XE
+
+```
+</details>
+
+
+
+## Troubleshooting
+
+### Debug Mode
+
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
+
+To troubleshoot issues with the `oracledb` collector, run the `go.d.plugin` with the debug option enabled. The output
+should give you clues as to why the collector isn't working.
+
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
+  your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
+
+  ```bash
+  cd /usr/libexec/netdata/plugins.d/
+  ```
+
+- Switch to the `netdata` user.
+
+  ```bash
+  sudo -u netdata -s
+  ```
+
+- Run the `go.d.plugin` to debug the collector:
+
+  ```bash
+  ./go.d.plugin -d -m oracledb
+  ```
+
+### Getting Logs
+
+If you're encountering problems with the `oracledb` collector, follow these steps to retrieve logs and identify potential issues:
+
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
+- **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.
+
+#### System with systemd
+
+Use the following command to view logs generated since the last Netdata service restart:
+
+```bash
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep oracledb
+```
+
+#### System without systemd
+
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
+
+```bash
+grep oracledb /var/log/netdata/collector.log
+```
+
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
+
+#### Docker Container
+
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
+
+```bash
+docker logs netdata 2>&1 | grep oracledb
+```
+
+

Some files were not shown because too many files changed in this diff