Skip to content

Commit 0209e71

Browse files
committed
Minor fixes
1 parent 2db7a56 commit 0209e71

File tree

1 file changed

+37
-42
lines changed

1 file changed

+37
-42
lines changed

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

Lines changed: 37 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,12 @@ The [Oracle](https://docs.oracle.com/database/121/CNCPT/intro.htm#CNCPT001) app
1515

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

18-
- Non-Kubernetes: Oracle Database 23 Release 23.4.0.24.05
18+
- Non-Kubernetes: Oracle Database 23 Release 23.4.0.24.05.
1919

2020
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)
2121

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

24-
## Log types
25-
26-
- Alert Logs
27-
- Listener Logs
28-
- Audit Logs
29-
3024
## Fields creation in Sumo Logic for Oracle
3125

3226
Following are the tags which that be created as part of Oracle App install if not already present. 
@@ -38,7 +32,7 @@ Following are the tags which that be created as part of Oracle App install if no
3832

3933
## Prerequisites
4034

41-
## Metrics
35+
### For metrics collection
4236
You will need to assign these permissions to the database user used to fetch metrics:
4337

4438
```
@@ -50,15 +44,16 @@ GRANT SELECT ON DBA_DATA_FILES TO <username>;
5044
GRANT SELECT ON DBA_TABLESPACE_USAGE_METRICS TO <username>;
5145
```
5246

53-
## Logs
47+
### For logs collection
48+
5449
Here are the steps required to configure log collection for Oracle running on a non-Kubernetes environment.
5550

5651
* [Enable Oracle logging](#enable-oracle-logging)
5752
* [Verify log files path](#verify-local-logs-file-directories-and-path)
5853
* [Set up Oracle performance metrics script](#performance-metrics-script-setup)
5954
* [Configure three local log file Sources](#step-2-configure-integration)
6055

61-
### Enable Oracle logging
56+
#### Enable Oracle logging
6257

6358
If logging is not enabled, you can configure it by following the steps below.
6459

@@ -70,14 +65,11 @@ If logging is not enabled, you can configure it by following the steps below.
7065
```
7166
- **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.
7267

73-
:::note
74-
Currently this app does not support collection of unified audit trail logs collected in Oracle on windows as windows event logs.
75-
Dashboards **Oracle - Sys Audit Log, Oracle - Sys Audit Log - Logon Analysis, Oracle - XML Audit Log - Logon Analysis and Oracle - XML Audit Log - SQL Statement Analysis** will be populated when collecting logs for version below 21c
68+
:::note
69+
Currently this app does not support collection of unified audit trail logs collected in Oracle on Windows as Windows event logs.
70+
:::
7671

77-
Dashboard **Oracle - Unified Audit Syslogs** will populate for audit log collected for oracle version 21c and above.
78-
:::
79-
80-
### Verify local logs file directories and path
72+
#### Verify local logs file directories and path
8173

8274
- **Oracle Alert Logs**. For 11g and later releases (12c, 18c, 19c). By default, Oracle logs are stored in
8375
`$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:
@@ -89,22 +81,19 @@ Dashboard **Oracle - Unified Audit Syslogs** will populate for audit log collect
8981
[oracle@sumolab alert]$ lsnrctl status
9082
```
9183
- **Oracle Audit Logs**.
92-
- **For Oracle version below 21c**
93-
By default, Oracle logs are stored in
94-
```
95-
$ORACLE_BASE/app/oracle/admin/orcl/adump
96-
```
97-
98-
The default directory for log files is stored as the value of `audit_file_dest`. In order to display it, run the following command: `SQL> show parameter audit`.
84+
- **For Oracle version below 21c**. By default, Oracle logs are stored in
85+
```
86+
$ORACLE_BASE/app/oracle/admin/orcl/adump
87+
```
88+
The default directory for log files is stored as the value of `audit_file_dest`. In order to display it, run the following command: `SQL> show parameter audit`.
9989
100-
Audit Logs should be in either `XML`, `EXTENDED`, or `{{OS }}` format for the app to work.
90+
Audit Logs should be in either `XML`, `EXTENDED`, or `{{OS }}` format for the app to work.
10191
102-
The location of these logs will be required when you set up the app through the app catalog.
92+
The location of these logs will be required when you set up the app through the app catalog.
10393
104-
- **For Oracle version 21c and above**
105-
Once unified audit trail is redirected to syslog it will start getting written to destination set in syslog.conf.
94+
- **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`.
10695
107-
### Performance Metrics Script Setup
96+
#### Performance Mmtrics script setup
10897
10998
To set up the performance metrics script on Linux and Windows for the Oracle app:
11099
@@ -192,10 +181,10 @@ In this step, you will configure the yaml required for Oracle Collection.
192181
Below are the inputs required:
193182
194183
- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`.
195-
- **`Alert Logs`**. Path of the log file configured to capture oracle logs needs to be given here
196-
- **`Listener Logs`**. Path of the log file configured to capture oracle logs needs to be given here
197-
- **`Audit Logs`**. Path of the log file configured to capture oracle logs needs to be given here
198-
- **`Performance metric script-based logs`**. Path of the log file configured to capture oracle logs needs to be given here
184+
- **`Alert Logs`**. Path of the log file configured to capture oracle logs.
185+
- **`Listener Logs`**. Path of the log file configured to capture oracle logs needs to be given here.
186+
- **`Audit Logs`**. Path of the log file configured to capture oracle logs needs to be given here.
187+
- **`Performance metric script-based logs`**. Path of the log file configured to capture oracle logs needs to be given here.
199188
- **`username`**. Username for the OracleDB connection.
200189
- **`password`**. Password for the OracleDB connection. Special characters are allowed.
201190
- **`service`**. OracleDB Service that the receiver should connect to.
@@ -292,17 +281,17 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md';
292281

293282
## Sample log message
294283

295-
Sample Log Message in Non-Kubernetes environment:
284+
Sample log message in Non-Kubernetes environment:
296285

297286
```sh title="Time"
298287
20-Jan-2023 11:02:56 * (CONNECT_DATA=(CID=(PROGRAM=null)(HOST=__jdbc__)(USER=null))(SERVICE_NAME=sumo.cmdb01.com)) * (ADDRESS=(PROTOCOL=TCP)(HOST=124.243.25.82)(PORT=56486)) * establish * sumo.cmdb01.com * 12514
299288

300289
TNS-12514: TNS:listener does not currently know of service requested in connect descriptor
301290
```
302291

303-
## Sample Log query
292+
## Sample log query
304293

305-
This sample Query is from the **Oracle - Overview** dashboard > **DB Connection** panel.
294+
This sample query is from the **Oracle - Overview** dashboard > **DB Connection** panel.
306295

307296
```sql title="Query String"
308297
 %"db.cluster.name"=* %"deployment.environment"=* %"sumo.datasource"=oracle establish ("SID=" or "SERVICE_NAME=")  | json "log" as _rawlog nodrop 
@@ -314,20 +303,27 @@ This sample Query is from the **Oracle - Overview** dashboard > **DB Connection*
314303
| count as %"ConnectionCount"
315304
```
316305

317-
# Sample metrics
306+
## Sample metrics
307+
318308
```json
319309
{"queryId":"A","oracledb.instance.name":"localhost:1521/FREE","_source":"oracle/oracledb","cloud.platform":"aws_ec2","_metricId":"lZCclGCpxjgi0_E4r4v5ww","host.image.id":"ami-000314be38df8042e","_sourceName":"oracle","cloud.availability_zone":"us-east-1b","host.id":"i-05ce9f3824aa73d10","host.group":"anemaoracle","os.type":"linux","sumo.datasource":"oracle","db.system":"oracle","db.node.name":"ip-10-0-29-37","cloud.account.id":"956882708938","_sourceCategory":"OTC Metric Input","deployment.environment":"anemaoracle","_contentType":"OpenTelemetry","tablespace_name":"SYSTEM","host.type":"m5.large","host.name":"ip-10-0-29-37","metric":"oracledb.tablespace_size.usage","_collectorId":"00005AF310D08C7C","_sourceId":"0000000000000000","unit":"By","db.cluster.name":"test","cloud.region":"us-east-1","cloud.provider":"aws","_sourceHost":"ip-10-0-29-37","_collector":"ip-10-0-29-37","max":1104150528,"min":1104150528,"avg":1104150528,"sum":3312451584,"latest":1104150528,"count":3}
320310
```
321-
## Sample Metrics query
322311

323-
This sample Query is from the **Oracle - Overview** dashboard > **Session Count** panel.
312+
## Sample metrics query
313+
314+
This sample query is from the **Oracle - Overview** dashboard > **Session Count** panel.
324315

325316
```sql title="Session Count"
326317
sumo.datasource=oracle metric=oracledb.sessions.usage deployment.environment=* db.cluster.name=* db.node.name=* | sum
327318
```
328319

329320
## Viewing Oracle dashboards
330321

322+
:::note
323+
- **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.
324+
- **Oracle - Unified Audit Syslogs** dashboard will populate for audit log collected for Oracle database version 21c and above.
325+
:::
326+
331327
### Overview
332328

333329
See the overview of Oracle listener process activity, including successful DB connections, TNS error information, SID and Service Name usage, and top usage, in terms of ports, database users, user hosts, client hosts, and user programs as derived from the Oracle Listener log.
@@ -549,13 +545,12 @@ Top Session Wait Time Events. A table that shows the top 10 event types associat
549545
Recent Jobs in the database. A table of information about recent database jobs, including when each job ran, low long it ran, and when it will next run.
550546

551547

552-
### Oracle - Unified Audit Syslog
548+
### Unified Audit Syslog
553549

554550
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-Unified-Audit-Syslog.png' alt="Monitor Performance by DB Script" />
555551
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.
556552

557-
558-
### Oracle - Performance Details
553+
### Performance Details
559554

560555
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-Performance-Details.png' alt="Monitor Performance by DB Script" />
561556
The Oracle - Performance Details dashboard gives insight about - count of rollback, commits, transaction, process, session.

0 commit comments

Comments
 (0)