Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions packages/oracle/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Connectivity to Oracle can be facilitated in two ways: by using official Oracle
To get connected with the Oracle Database, you must set the following environment variables: `ORACLE_SID`, `ORACLE_BASE`, `ORACLE_HOME`.

For example, let’s consider Oracle Database 21c installation using RPM manually by following the [Oracle Installation instructions](https://docs.oracle.com/en/database/oracle/oracle-database/21/ladbi/running-rpm-packages-to-install-oracle-database.html). The environment variables should be set as follows:

- `ORACLE_SID=ORCLCDB`
- `ORACLE_BASE=/opt/oracle/oradata`
- `ORACLE_HOME=/opt/oracle/product/21c/dbhome_1`
Expand Down Expand Up @@ -59,9 +59,9 @@ Make sure that you have administrative privileges to modify the Elastic Agent sy
`systemctl status elastic-agent.service`
Take note of the path to the `elastic-agent.service` file, which is typically located in the systemd service directory. Example path: `/etc/systemd/system/elastic-agent.service`

2. Open the `elastic-agent.service` file in your preferred text editor, find the `EnvironmentFile` key (commonly found at `/etc/sysconfig/elastic-agent`), and verify its contents, as these configurations are essential for the elastic-agent's runtime environment initialization. If the EnvironmentFile is absent, create it and set the necessary permissions to ensure the elastic-agent has full access.
2. Open the `elastic-agent.service` file in your preferred text editor, find the `EnvironmentFile` key (commonly found at `/etc/sysconfig/elastic-agent`), and verify its contents, as these configurations are essential for the elastic-agent's runtime environment initialization. If the EnvironmentFile is absent, create it and set the necessary permissions to ensure the elastic-agent has full access.

3. Add the `LD_LIBRARY_PATH` environment variable to the configured `EnvironmentFile`. Set it to the directory where libraries (`libclntsh.so`) are located. For example, if your libraries are in the `/opt/oracle/instantclient_21_1 directory`, add the following line to the `EnvironmentFile` (i.e. `/etc/systemd/system/elastic-agent.service`)
3. Add the `LD_LIBRARY_PATH` environment variable to the configured `EnvironmentFile`. Set it to the directory where libraries (`libclntsh.so`) are located. For example, if your libraries are in the `/opt/oracle/instantclient_21_1 directory`, add the following line to the `EnvironmentFile` (for example, `/etc/systemd/system/elastic-agent.service`)

`LD_LIBRARY_PATH=/opt/oracle/instantclient_21_1`

Expand All @@ -77,7 +77,7 @@ Make sure that you replace `/opt/oracle/instantclient_21_1` with the actual path

#### Enable Listener

The Oracle listener is a service that runs on the database host and receives requests from Oracle clients. Make sure that [Listener](https://docs.oracle.com/cd/B19306_01/network.102/b14213/lsnrctl.htm) is running by using this command:
The Oracle listener is a service that runs on the database host and receives requests from Oracle clients. Make sure that [Listener](https://docs.oracle.com/cd/B19306_01/network.102/b14213/lsnrctl.htm) is running by using this command:

`lsnrctl STATUS`

Expand Down Expand Up @@ -138,12 +138,13 @@ Tablespace metrics describes the tablespace usage metrics of all types of tables
Tablespace metrics also describes [extended space](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/DBA_TABLESPACE_USAGE_METRICS.html#:~:text=unexpired%20undo%20segments.-,TABLESPACE_SIZE,-NUMBER) of all type of tablepaces.

To collect the Tablespace metrics, Oracle integration relies on a specific set of views. Make sure that the user configured within the Oracle DSN configuration has `READ` access permissions to the following views:

- `SYS.DBA_DATA_FILES`
- `SYS.DBA_TEMP_FILES`
- `DBA_FREE_SPACE`
- `DBA_TABLESPACE_USAGE_METRICS`
- `DBA_TABLESPACES`
- `DBA_TEMP_FREE_SPACE`

**ECS Field Reference**

Expand All @@ -153,7 +154,7 @@ Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ec

{{event "tablespace"}}

### Sysmetrics
### Sysmetrics

The system metrics value captured for the most current time interval for the long duration (60-seconds) are listed in the following table.

Expand All @@ -169,7 +170,7 @@ Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ec

{{event "sysmetric"}}

### Memory Metrics
### Memory Metrics

A Program Global Area (PGA) is a memory region that contains data and control information for a server process. It is nonshared memory created by Oracle Database when a server process is started. Access to the PGA is exclusive to the server process. Metrics concerning Program Global Area (PGA) memory are mentioned below.

Expand All @@ -186,7 +187,7 @@ Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ec

{{event "memory"}}

### System Statistics Metrics
### System Statistics Metrics

The System Global Area (SGA) is a group of shared memory structures that contain data and control information for one Oracle Database instance. Metrics concerning System Global Area (SGA) memory are mentioned below.

Expand Down
5 changes: 5 additions & 0 deletions packages/oracle/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.31.3"
changes:
- description: Update the Oracle Integration documentation regarding tablespace permissions.
type: enhancement
link: https://github.com/elastic/integrations/pull/18965
- version: "1.31.2"
changes:
- description: Stabilize system tests by requiring multiple consecutive successful probes before declaring the Oracle listener ready.
Expand Down
17 changes: 9 additions & 8 deletions packages/oracle/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Connectivity to Oracle can be facilitated in two ways: by using official Oracle
To get connected with the Oracle Database, you must set the following environment variables: `ORACLE_SID`, `ORACLE_BASE`, `ORACLE_HOME`.

For example, let’s consider Oracle Database 21c installation using RPM manually by following the [Oracle Installation instructions](https://docs.oracle.com/en/database/oracle/oracle-database/21/ladbi/running-rpm-packages-to-install-oracle-database.html). The environment variables should be set as follows:

- `ORACLE_SID=ORCLCDB`
- `ORACLE_BASE=/opt/oracle/oradata`
- `ORACLE_HOME=/opt/oracle/product/21c/dbhome_1`
Expand Down Expand Up @@ -59,9 +59,9 @@ Make sure that you have administrative privileges to modify the Elastic Agent sy
`systemctl status elastic-agent.service`
Take note of the path to the `elastic-agent.service` file, which is typically located in the systemd service directory. Example path: `/etc/systemd/system/elastic-agent.service`

2. Open the `elastic-agent.service` file in your preferred text editor, find the `EnvironmentFile` key (commonly found at `/etc/sysconfig/elastic-agent`), and verify its contents, as these configurations are essential for the elastic-agent's runtime environment initialization. If the EnvironmentFile is absent, create it and set the necessary permissions to ensure the elastic-agent has full access.
2. Open the `elastic-agent.service` file in your preferred text editor, find the `EnvironmentFile` key (commonly found at `/etc/sysconfig/elastic-agent`), and verify its contents, as these configurations are essential for the elastic-agent's runtime environment initialization. If the EnvironmentFile is absent, create it and set the necessary permissions to ensure the elastic-agent has full access.

3. Add the `LD_LIBRARY_PATH` environment variable to the configured `EnvironmentFile`. Set it to the directory where libraries (`libclntsh.so`) are located. For example, if your libraries are in the `/opt/oracle/instantclient_21_1 directory`, add the following line to the `EnvironmentFile` (i.e. `/etc/systemd/system/elastic-agent.service`)
3. Add the `LD_LIBRARY_PATH` environment variable to the configured `EnvironmentFile`. Set it to the directory where libraries (`libclntsh.so`) are located. For example, if your libraries are in the `/opt/oracle/instantclient_21_1 directory`, add the following line to the `EnvironmentFile` (for example, `/etc/systemd/system/elastic-agent.service`)

`LD_LIBRARY_PATH=/opt/oracle/instantclient_21_1`

Expand All @@ -77,7 +77,7 @@ Make sure that you replace `/opt/oracle/instantclient_21_1` with the actual path

#### Enable Listener

The Oracle listener is a service that runs on the database host and receives requests from Oracle clients. Make sure that [Listener](https://docs.oracle.com/cd/B19306_01/network.102/b14213/lsnrctl.htm) is running by using this command:
The Oracle listener is a service that runs on the database host and receives requests from Oracle clients. Make sure that [Listener](https://docs.oracle.com/cd/B19306_01/network.102/b14213/lsnrctl.htm) is running by using this command:

`lsnrctl STATUS`

Expand Down Expand Up @@ -305,12 +305,13 @@ Tablespace metrics describes the tablespace usage metrics of all types of tables
Tablespace metrics also describes [extended space](https://docs.oracle.com/en/database/oracle/oracle-database/19/refrn/DBA_TABLESPACE_USAGE_METRICS.html#:~:text=unexpired%20undo%20segments.-,TABLESPACE_SIZE,-NUMBER) of all type of tablepaces.

To collect the Tablespace metrics, Oracle integration relies on a specific set of views. Make sure that the user configured within the Oracle DSN configuration has `READ` access permissions to the following views:

- `SYS.DBA_DATA_FILES`
- `SYS.DBA_TEMP_FILES`
- `DBA_FREE_SPACE`
- `DBA_TABLESPACE_USAGE_METRICS`
- `DBA_TABLESPACES`
- `DBA_TEMP_FREE_SPACE`

**ECS Field Reference**

Expand Down Expand Up @@ -433,7 +434,7 @@ An example event for `tablespace` looks as following:
}
```

### Sysmetrics
### Sysmetrics

The system metrics value captured for the most current time interval for the long duration (60-seconds) are listed in the following table.

Expand Down Expand Up @@ -878,7 +879,7 @@ An example event for `sysmetric` looks as following:
}
```

### Memory Metrics
### Memory Metrics

A Program Global Area (PGA) is a memory region that contains data and control information for a server process. It is nonshared memory created by Oracle Database when a server process is started. Access to the PGA is exclusive to the server process. Metrics concerning Program Global Area (PGA) memory are mentioned below.

Expand Down Expand Up @@ -1028,7 +1029,7 @@ An example event for `memory` looks as following:
}
```

### System Statistics Metrics
### System Statistics Metrics

The System Global Area (SGA) is a group of shared memory structures that contain data and control information for one Oracle Database instance. Metrics concerning System Global Area (SGA) memory are mentioned below.

Expand Down
2 changes: 1 addition & 1 deletion packages/oracle/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: "3.0.2"
name: oracle
title: "Oracle"
version: "1.31.2"
version: "1.31.3"
description: Collect Oracle Audit Log, Performance metrics, Tablespace metrics, Sysmetrics metrics, System statistics metrics, memory metrics from Oracle database.
type: integration
categories:
Expand Down
Loading