Skip to content

Commit 93e060d

Browse files
committed
Doc changes to collect unified audit logs for windows env for oracle otel app
1 parent 3291bb8 commit 93e060d

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/integrations/databases/opentelemetry/oracle-opentelemetry.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ import TabItem from '@theme/TabItem';
1111

1212
<img src={useBaseUrl('img/integrations/databases/oracle.png')} alt="Thumbnail icon" width="100"/> <img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/>
1313

14-
The [Oracle](https://docs.oracle.com/database/121/CNCPT/intro.htm#CNCPT001) app is a logs and metrics based app. Preconfigured dashboards and searches provide insight into the listeners, sys/xml audit logs, alerts, performance, and security. It also gives insight around count of rollback, commits, transaction, process, session, hard parse, and DML locks.
14+
The [Oracle](https://docs.oracle.com/database/121/CNCPT/intro.htm#CNCPT001) app is a logs and metrics based app. Preconfigured dashboards and searches provide insight into the listeners, audit logs (traditional - sys/xml and unified), performance, and security. It also gives insight around count of rollback, commits, transaction, process, session, hard parse, and DML locks.
1515

1616
This app is tested with the following Oracle versions:
1717

1818
- Non-Kubernetes: Oracle Database 23 Release 23.4.0.24.05.
1919

20-
Oracle logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) and metrics are collected through [Oracledb receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/oracledbreceiver)
20+
Oracle logs like listner, alert and traditional audit logs (oracle version <= 19c) are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) whereas unified audit logs (oracle version >= 21c) are collected through [syslog](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/syslogreceiver) for linux environment and [windowseventlog](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/windowseventlogreceiver/) receiver for windows environment.
21+
22+
Metrics are collected through [Oracledb receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/oracledbreceiver)
2123

2224
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-Schematics.png' alt="Schematics" />
2325

@@ -64,15 +66,11 @@ If logging is not enabled, you can configure it by following the steps below.
6466
lsnrctl command [listener_name]
6567
lsnrctl set log_status on
6668
```
67-
- **Audit Log**. Traditional auditing is deprecated in Oracle Database 21c. If you are using version below 21c follow [this](https://docs.oracle.com/cd/E11882_01/server.112/e10575/tdpsg_auditing.htm#TDPSG50000) guide to enable Audit Logs. For version 21c and above, follow [this](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/administering-the-audit-trail.html#GUID-662AA54B-D878-4B78-94D3-733256B3F37C) to enable exporting for unified audit trail through syslog for Oracle on Linux.
68-
69-
:::note
70-
Currently this app does not support collection of unified audit trail logs collected in Oracle on Windows as Windows event logs.
71-
:::
69+
- **Audit Log**. Traditional auditing is deprecated in Oracle Database 21c. If you are using version 19c or below follow [this](https://docs.oracle.com/cd/E11882_01/server.112/e10575/tdpsg_auditing.htm#TDPSG50000) guide to enable Audit Logs. For version 21c and above, follow [this](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/administering-the-audit-trail.html#GUID-662AA54B-D878-4B78-94D3-733256B3F37C) to enable exporting for unified audit logs through syslog for Oracle on Linux and windows event logs for Oracle on Windows.
7270

7371
#### Verify local logs file directories and path
7472

75-
- **Oracle Alert Logs**. For 11g and later releases (12c, 18c, 19c). By default, Oracle logs are stored in
73+
- **Oracle Alert Logs**. For 11g and later releases (12c, 18c, 19c, 21c, 23c). By default, Oracle logs are stored in
7674
`$ORACLE_BASE/diag/rdbms/$DB_UNIQUE_NAME/$ORACLE_SID/trace/`. The default directory for log files is stored in `BACKGROUND_DUMP_DEST` parameter. You can query the value of `BACKGROUND_DUMP_DEST`, an initialization parameter, where you can find Oracle alert log by executing the command below:
7775
```sh
7876
SQL > show parameter background_dump_dest;
@@ -82,7 +80,7 @@ If logging is not enabled, you can configure it by following the steps below.
8280
[oracle@sumolab alert]$ lsnrctl status
8381
```
8482
- **Oracle Audit Logs**.
85-
- **For Oracle version below 21c**. By default, Oracle logs are stored in
83+
- **For Oracle version 19c and below**. By default, Oracle logs are stored in
8684
```
8785
$ORACLE_BASE/app/oracle/admin/orcl/adump
8886
```
@@ -92,7 +90,7 @@ If logging is not enabled, you can configure it by following the steps below.
9290
9391
The location of these logs will be required when you set up the app through the app catalog.
9492
95-
- **For Oracle version 21c and above**. Once unified audit trail is redirected to syslog, it will start getting written to destination set in `syslog.conf`.
93+
- **For Oracle version 21c and above**. Based on [Unified audit policy](https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/AUDIT-Unified-Auditing.html) configuered, audit logs exported will direclty be ingested to sumo using syslog or windows event log. For linux environment instead of redirecting audit logs to a file we need to directly redirect it to local port. In the next step, otel collector can be configured to listen to this port to send log to sumo.
9694
9795
#### Performance metrics script setup
9896
@@ -181,11 +179,13 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md';
181179
In this step, you will configure the yaml required for Oracle Collection.
182180
Below are the inputs required:
183181
184-
- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`.
185182
- **`Alert Logs`**. Path of the log file configured to capture oracle alert logs.
186183
- **`Listener Logs`**. Path of the log file configured to capture oracle listener logs .
187-
- **`Audit Logs`**. Path of the log file configured to capture oracle audit logs.
188-
- **`Performance metric script-based logs`**. Path of the log file configured to capture log generated through script.
184+
- **`Audit Logs`**.
185+
- For **Traditional Audit Logs** - Path of the log file configured to capture oracle audit logs.
186+
- For **Unified Audit Logs** - You need to select the OS where the oracle is setup - windows or linux. For Oracle on windows machine no parameter is required. Only respective event id will be ingested. For linux environment you need to give the **port** (configured in prerequisite steps for linux environment) where the syslog receiver should listen to, for sending the logs to sumo.
187+
- **`Performance metric script-based logs`**. Path of the log file configured to capture log generated through script can be configured in other logs.
188+
- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`.
189189
- **`username`**. Username for the OracleDB connection.
190190
- **`password`**. Password for the OracleDB connection. Special characters are allowed.
191191
- **`service`**. OracleDB Service that the receiver should connect to.
@@ -321,8 +321,8 @@ sumo.datasource=oracle metric=oracledb.sessions.usage deployment.environment=*
321321
## Viewing Oracle dashboards
322322

323323
:::note
324-
- **Oracle - Sys Audit Log**, **Oracle - Sys Audit Log - Logon Analysis**, **Oracle - XML Audit Log - Logon Analysis**, and **Oracle - XML Audit Log - SQL Statement Analysis** dashboards will be populated only when collecting logs for Oracle database version below 21c.
325-
- **Oracle - Unified Audit Syslogs** dashboard will populate for audit log collected for Oracle database version 21c and above.
324+
- **Oracle - Sys Audit Log**, **Oracle - Sys Audit Log - Logon Analysis**, **Oracle - XML Audit Log - Logon Analysis**, and **Oracle - XML Audit Log - SQL Statement Analysis** dashboards will be populated only when collecting logs for Oracle database version 19c and below.
325+
- **Oracle - Unified Audit Syslogs** dashboard will populate for unified audit log collected for Oracle database version 21c and above.
326326
:::
327327

328328
### Overview
@@ -549,7 +549,7 @@ Recent Jobs in the database. A table of information about recent database jobs,
549549
### Unified Audit Syslog
550550

551551
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-Unified-Audit-Syslog.png' alt="Monitor Performance by DB Script" />
552-
See information derived from the syslog audit trail, including successful and failed activities, successful and failed logon attempts. In addition to this dashboard gives insight around logon status trend, top current and database users.
552+
See information derived from the syslog audit trail, including successful and failed activities, successful and failed logon attempts. In addition to this dashboard gives insight around logon status trend, top current and database users. This dashboard work with unified audit logs exported from both windows and linux environment.
553553

554554
### Performance Details
555555

0 commit comments

Comments
 (0)