Skip to content

Commit 7c8ce2c

Browse files
Updated RDS doc for oracle dashboard
1 parent 25ceed9 commit 7c8ce2c

File tree

5 files changed

+81
-1
lines changed

5 files changed

+81
-1
lines changed

docs/integrations/amazon-aws/rds.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1010

1111
[Amazon Relational Database Service (Amazon RDS)](https://aws.amazon.com/rds/) is a managed database service, optimized to run in the cloud. The RDS Amazon Web Service (AWS) simplifies the setup, operation, and scaling of relational database instances for use in applications throughout your infrastructure.
1212

13-
The Sumo Logic Amazon RDS app dashboards provide visibility into the performance and operations of your Amazon Relational Database Service (RDS). Preconfigured dashboards allow you to monitor critical metrics of your RDS instance(s) or cluster(s) including CPU, memory, storage, network transmits and receive throughput, read and write operations, database connection count, disk queue depth, and more. CloudTrail Audit dashboards help you monitor activities performed on your RDS infrastructure. MySQL Logs dashboards helps you monitor database errors, slow queries, audit sql queries and generic activities. PostgreSQL logs dashboard help you to monitor database errors, slow queries, database security, and query execution timings. MSSQL Logs dashboards helps you monitor error logs and basic infrastructure details.
13+
The Sumo Logic Amazon RDS app dashboards provide visibility into the performance and operations of your Amazon Relational Database Service (RDS). Preconfigured dashboards allow you to monitor critical metrics of your RDS instance(s) or cluster(s) including CPU, memory, storage, network transmits and receive throughput, read and write operations, database connection count, disk queue depth, and more. CloudTrail Audit dashboards help you monitor activities performed on your RDS infrastructure. MySQL Logs dashboards helps you monitor database errors, slow queries, audit sql queries and generic activities. PostgreSQL logs dashboard help you to monitor database errors, slow queries, database security, and query execution timings. MSSQL Logs dashboards helps you monitor error logs and basic infrastructure details. Oracle CloudTrail and CloudWatch Logs dashboards provide monitoring for error logs and essential infrastructure details.
1414

1515
## Log and metrics types
1616

@@ -20,6 +20,7 @@ The Amazon RDS app uses the following logs and metrics:
2020
* [Publishing RDS CloudWatch Logs, RDS Database logs for Aurora MySQL, RDS MySQL, MariaDB](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.MySQLDB.PublishtoCloudWatchLogs.html).
2121
* [Publishing RDS CloudWatch logs, RDS Database logs for Aurora PostgreSQL, RDS PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.PostgreSQL.html#USER_LogAccess.Concepts.PostgreSQL.PublishtoCloudWatchLogs)
2222
* [Publishing RDS CloudWatch logs, RDS Database logs for RDS MSSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.SQLServer.html#USER_LogAccess.SQLServer.PublishtoCloudWatchLogs)
23+
* [Publishing RDS CloudWatch logs, RDS Database logs for RDS Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.Oracle.html#USER_LogAccess.Oracle.PublishtoCloudWatchLogs)
2324
### Sample CloudTrail log message
2425

2526
<details>
@@ -270,6 +271,36 @@ account=* region=* namespace=aws/rds dbidentifier=* _sourceHost=/aws/rds/*Error
270271
| sort by _timeslice
271272
```
272273
274+
```sql title="Engine and It's DB Instance (Oracle CloudTrail log based)"
275+
account=* region=* namespace=aws/rds "\"eventSource\":\"rds.amazonaws.com\"" !errorCode
276+
| json "eventTime", "eventName", "eventSource", "awsRegion", "userAgent", "recipientAccountId", "userIdentity", "requestParameters", "responseElements", "errorCode", "errorMessage", "requestID", "sourceIPAddress" as eventTime, event_name, event_source, Region, user_agent, accountId1, userIdentity, requestParameters, responseElements, error_code, error_message, requestID, src_ip nodrop
277+
| where event_source = "rds.amazonaws.com"
278+
| json "requestParameters.engine", "responseElements.engine" as engine1, engine2 nodrop
279+
| if (!isEmpty(engine1), engine1, engine2) as engine
280+
| where !isEmpty(engine) and engine contains "oracle"
281+
| json field=userIdentity "accountId", "arn", "userName", "type" as accountId, arn, username, type nodrop
282+
| parse field=arn ":assumed-role/*" as user nodrop | parse field=arn "arn:aws:iam::*:*" as accountId, user nodrop
283+
| json field=requestParameters "dBInstanceIdentifier", "resourceName", "dBClusterIdentifier" as dBInstanceIdentifier1, resourceName, dBClusterIdentifier1 nodrop
284+
| json field=responseElements "dBInstanceIdentifier" as dBInstanceIdentifier3 nodrop
285+
| parse field=resourceName "arn:aws:rds:*:db:*" as f1, dBInstanceIdentifier2 nodrop
286+
| if (resourceName matches "arn:aws:rds:*:db:*", dBInstanceIdentifier2, if (!isEmpty(dBInstanceIdentifier1), dBInstanceIdentifier1, dBInstanceIdentifier3) ) as dBInstanceIdentifier
287+
| where !isEmpty(dBInstanceIdentifier)
288+
| count as freq by engine, dBInstanceIdentifier
289+
| sort by dBInstanceIdentifier, engine asc
290+
| fields -freq
291+
```
292+
293+
294+
```sql title="ORA Messages Over Time (Oracle CloudWatch log based)"
295+
account=* region=* namespace=aws/rds dbidentifier=* _sourceHost=/aws/rds/*alert ORA-*
296+
| json "message" nodrop | if (_raw matches "{*", message, _raw) as message
297+
| parse regex field=message "(?<oraerr>ORA-\d{5}): (?<oramsg>.*)" multi
298+
| timeslice 1s
299+
| count as eventCount by oraerr, _timeslice
300+
| transpose row _timeslice column oraerr
301+
```
302+
303+
273304
## Collecting logs and metrics for the Amazon RDS app
274305
275306
Sumo Logic supports collecting metrics using two source types:
@@ -336,6 +367,12 @@ We recommend not to set `log_statement` to any value other than none (default va
336367
- Agent
337368
- Error
338369
370+
#### Oracle
371+
- Amazon RDS [Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.Oracle.html) supports [publishing the following Oracle logs to CloudWatch](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.Concepts.Oracle.html#USER_LogAccess.Oracle.PublishtoCloudWatchLogs):
372+
- Alert logs
373+
- Audit files
374+
- Listener logs
375+
339376
Sumo Logic supports several methods for collecting logs from Amazon CloudWatch. You can choose either of them to collect logs:
340377
341378
- **AWS Kinesis Firehose for Logs**. Configure an [AWS Kinesis Firehose for Logs](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-logs-source/#create-an-aws-kinesis-firehose-for-logssource) (Recommended); or
@@ -721,3 +758,46 @@ Use this dashboard to:
721758
* Track recent terminations of SQL Server instances and monitor the creation of new databases.
722759
723760
<img src={useBaseUrl('img/integrations/amazon-aws/Amazon-RDS-MSSQL-Logs-Error-Logs-Infrastructure-Overview.png')} style={{ border: '1px solid gray' }} alt="Amazon RDS dashboard" />
761+
762+
### 20. Amazon RDS - Oracle CloudTrail Logs Analysis
763+
764+
The **Amazon RDS Oracle CloudTrail Logs Analysis** dashboard provides insights into audit events of your database instance.
765+
766+
Use this dashboard to:
767+
* Monitor Amazon Oracle RDS-related audit logs using CloudTrail Events.
768+
* Monitor locations of successful and failed Amazon Oracle RDS user activity events.
769+
* Monitor most active users working on Oracle RDS infrastructure, database engines used in the infrastructure, and various events invoked on Oracle RDS instance,
770+
771+
<img src={useBaseUrl('img/integrations/amazon-aws/Amazon-RDS-Oracle-CloudTrail-Logs-Analysis.png')} style={{ border: '1px solid gray' }} alt="Amazon RDS dashboard" />
772+
773+
### 21. Amazon RDS - Oracle Logs - Alert Logs Analysis
774+
775+
The **Amazon RDS - Oracle Logs - Alert Logs Analysis** dashboard provides details on Oracle errors, including counts of various error types, ORA messages, Oracle instance states, and other data derived from the Oracle Alert log.
776+
777+
Use this dashboard to:
778+
* Monitor Amazon Oracle RDS errors through CloudWatch Events.
779+
* Monitor ORA and TNS message events.
780+
* Monitor log switch activities, archival errors, tablespace extension issues, failures, warnings, and errors occurring on the Oracle RDS instance.
781+
782+
<img src={useBaseUrl('img/integrations/amazon-aws/Amazon-RDS-Oracle-Logs-Alert-Logs-Analysis.png')} style={{ border: '1px solid gray' }} alt="Amazon RDS dashboard" />
783+
784+
### 22. Amazon RDS - Oracle Logs - Audit Logs Analysis
785+
786+
The **Amazon RDS - Oracle Logs - Audit Logs Analysis** dashboard provides details on syslog audit trail, including successful and failed activities, and top usage by client, database user, and privileges used.
787+
788+
Use this dashboard to:
789+
* Monitor successful and failed Amazon Oracle RDS events.
790+
* Monitor top usage by client, database user, and privileges on Oracle RDS instance.
791+
792+
<img src={useBaseUrl('img/integrations/amazon-aws/Amazon-RDS-Oracle-Logs-Audit-Logs-Analysis.png')} style={{ border: '1px solid gray' }} alt="Amazon RDS dashboard" />
793+
794+
795+
### 23. Amazon RDS - Oracle Logs - Listener Troubleshooting
796+
797+
The **Amazon RDS - Oracle Logs - Listener Troubleshooting** dashboard provides insights into Oracle listener process activity, including database connections by host and application, connection failures, command execution statuses and trends, and additional data from the Oracle Listener log.
798+
799+
Use this dashboard to:
800+
* Monitor listener process activity on Oracle RDS instance.
801+
* Monitor database connections by host and application, track connection failures, analyze command execution statuses and trends, and gather insights from the Oracle Listener log.
802+
803+
<img src={useBaseUrl('img/integrations/amazon-aws/Amazon-RDS-Oracle-Logs-Listener-Troubleshooting.png')} style={{ border: '1px solid gray' }} alt="Amazon RDS dashboard" />
466 KB
Loading
238 KB
Loading
227 KB
Loading
299 KB
Loading

0 commit comments

Comments
 (0)