@credenceanalytics/diagnostic-oracle

Independent module to generate diagnostic reports from Oracle Database.

Installation

npm install -s @credenceanalytics/diagnostic-oracle

Usages

const { OracleReport } = require('@credenceanalytics/diagnostic-oracle')
const report = new OracleReport({"user": "", "password": "", "connectString": "127.0.0.1:1521/SAMPLEDS"})

API

generateReport

Returns promise that is resolved with json data or empty object.

const jsondata = await report.generateReport()

O/P:

{"DATABASE_STORAGE": [], "TABLESPACE": [], "LONG_RUNNING": [], "BLOCKED_SESSION": [], "FAILED_JOB": [], "UNUSABLE_INDEX": [], "INVALID_OBJECT": [], "SPACE_USAGE": [], "STALE_INDEX": [], "AUTOMATIC_STORAGE_MANAGEMENT": [], "DATABASE_ALERTS_AND_INCIDENTS": [], "DATABASE_RESOURCE_USAGE": [], "DATABASE_CONFIGURATION_SETTINGS": [], "BUFFER_CACHE_PARAMETER": [], "LARGE_DATA_SIZE": [], "BUFFER_PARAMETERS": [], "PGA_PARAMETER": [], "SHARED_POOL_PARAMETERS": [], "SGA_MEMORY_ALLOCATION": [], "TEMPORARY_TABLESPACE": [], "GROWTH_TRENDS": [], "DATABASE_PERFORMANCE_METRICS": [], "OPTIMIZER_PARAMETERS": [], "DATA_GUARD_STATUS": [] }

NOTE: See Diagnostic Information section for more details.

writeReport

Generate and write json data in given file path. Fully absolute path of file is required as parameter. Returns promise that is resolved with undefined.

const jsondata = await report.writeReport("/data.json")

Diagnostic Information

1. DATABASE_STORAGE Database details
2. TABLESPACE Check table space usage
3. LONG_RUNNING Check for long-running queries
4. BLOCKED_SESSION Check for blocked sessions
5. FAILED_JOB Check for failed jobs
6. UNUSABLE_INDEX Check for un usable index
7. INVALID_OBJECT Identify invalid objects
8. SPACE_USAGE Check ASM disk group space usage
9. STALE_INDEX Identify stale indexes
10. AUTOMATIC_STORAGE_MANAGEMENT Check Automatic Storage Management (ASM) health
11. DATABASE_ALERTS_AND_INCIDENTS Check database alerts and incidents
12. DATABASE_RESOURCE_USAGE Check database resource usage
13. DATABASE_CONFIGURATION_SETTINGS Check database configuration settings
14. BUFFER_CACHE_PARAMETER Check buffer cache parameters
15. LARGE_DATA_SIZE Identify tables for archiving due to large data size
16. BUFFER_PARAMETERS Read log buffer parameters
17. PGA_PARAMETER PGA parameters
18. SHARED_POOL_PARAMETERS Shared pool parameters
19. SGA_MEMORY_ALLOCATION Identify inadequate SGA memory allocation
20. TEMPORARY_TABLESPACE Identify low temporary table space
21. GROWTH_TRENDS Check database growth trends
22. DATABASE_PERFORMANCE_METRICS Check database performance metrics
23. OPTIMIZER_PARAMETERS Optimizer Parameters
24. DATA_GUARD_STATUS Check Data Guard status (if applicable)