I often need to retrieve report files or logs from GoldenGate deployments, and I wanted to find ways of automating this. Hence this blog, about retrieving all available logs with GoldenGate REST API.<\/p>\n\n\n\n
I previously wrote about the GoldenGate log files<\/a>. Some of them ( With With The list of log files can be retrieved through You can also use the The From the Service Manager (port Once you find an The report files are accessible with The same endpoints\/methods exist for replicats.<\/p>\n\n\n\n If a diagnostics collection exists, it is a resource named When several collections exist, the previous ones are kept as The same pair exists for a replicat: To summarize, for each file:<\/p>\n\n\n\n I often need to retrieve report files or logs from GoldenGate deployments, and I wanted to find ways of automating this. Hence this blog, about retrieving all available logs with GoldenGate REST API. I previously wrote about the GoldenGate log files. Some of them (extract.log, replicat.log and others) are in fact just filters of other […]<\/p>\n","protected":false},"author":152,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[229,3787,59],"tags":[515,979,4289,328,890,3730,1089,3198,1521,4255],"type_dbi":[4196,3801,4291,3740,3859,3881,3768,4290,3800,4261],"class_list":["post-48080","post","type-post","status-publish","format-standard","hentry","category-database-administration-monitoring","category-goldengate","category-oracle","tag-administration","tag-api","tag-ggserr-log-2","tag-goldengate","tag-log","tag-ogg","tag-python","tag-report","tag-rest","tag-rest-api-2","type-administration","type-api","type-ggserr-log-3","type-goldengate","type-log","type-ogg","type-python","type-report","type-rest","type-rest-api-3"],"acf":[],"yoast_head":"\nextract.log<\/code>, replicat.log<\/code> and others) are in fact just filters of other logs (ggserr.log<\/code> or restapi.log<\/code>). These reconstructed logs do not have a REST API endpoint. For the others, let\u2019s see how to retrieve them, using the GoldenGate Python client I released earlier<\/a>.<\/p>\n\n\n\nAuthenticating to the REST API<\/h2>\n\n\n\n
oggrestapi.py<\/code>, authentication is handled once at client creation. When using auto_discovery<\/code>, you won\u2019t have to bother thinking about the port.<\/p>\n\n\n\nfrom oggrestapi import OGGRestAPI\n\nogg_client = OGGRestAPI(\n url=\"https:\/\/vmogg:7809\",\n username=\"ogg\",\n deployment=\"ogg_test_01\",\n auto_discovery=True,\n)<\/code><\/pre>\n\n\n\nauto_discovery<\/code>, the client picks the right service port for each call. If you make direct curl<\/code>\/requests<\/code> calls instead, you have to choose the service yourself:<\/p>\n\n\n\n\n
ServiceManager.log<\/code> and the deployment service logs (adminsrvr.log<\/code>, distsrvr.log<\/code>, etc.)<\/li>\n\n\n\nggserr.log<\/code>. You can also retrieve adminsrvr.log<\/code> from here.<\/li>\n<\/ul>\n\n\n\nGET \/services\/v2\/logs<\/code>. Each individual log is obtained through GET \/services\/v2\/logs\/{log}<\/code>, on the port of the service you connect to. default<\/code> is the service log: against adminsrvr<\/code> (port 7810<\/code>), default<\/code> is adminsrvr.log<\/code>. To retrieve the content of the file, you need to send the Accept: text\/plain<\/code> header, or use the content<\/code> toggle in oggrestapi.py<\/code>.<\/p>\n\n\n\n# \/services\/v2\/logs - List all logs\n>>> ogg_client.list_logs(ogg_service=\"adminsrvr\")\n[{'name': 'default'}, {'name': 'restapi'}, {'name': 'stdout'}, {'name': 'debug'}, {'name': 'events'}]\n\n# \/services\/v2\/logs\/default - Get adminsrvr.log metadata\n>>> ogg_client.get_log(log=\"default\", ogg_service=\"adminsrvr\")\n{'$schema': 'ogg:log', 'enabled': True, 'dataExists': True}\n\n# \/services\/v2\/logs\/default (Accept: text\/plain) - Get adminsrvr.log content\n>>> ogg_client.get_log(log=\"default\", ogg_service=\"adminsrvr\", content=True)\n\"...\\n2026-09-26T17:21:30.612+0000 INFO | Registering containers <nul> (Thread 7)\\n2026-09-26T17:21:31.820+0000 INFO | Configuration file 'EXT.prm' changed (Thread 7)\\n2026-09-26T17:21:31.881+0000 INFO | Starting extract 'EXT' (EXTRACT:EXT)\\n2026-09-26T17:21:31.915+0000 INFO | Task 'EXTRACT:EXT' started with process id 39143 (EXTRACT:EXT)\\n\"<\/code><\/pre>\n\n\n\nget_service_log<\/code> directly, when using a reverse proxy or connecting to the Service Manager:<\/p>\n\n\n\n# \/services\/v2\/deployments\/ogg_test_01\/services\/distsrvr\/logs\/default (Accept: text\/plain) - Service Manager endpoint\n# \/services\/ServiceManager\/v2\/deployments\/ogg_test_01\/services\/distsrvr\/logs\/default (Accept: text\/plain) - reverse proxy endpoint\n>>> ogg_client.get_service_log(deployment=\"ogg_test_01\", service=\"distsrvr\", content=True)\n\"...\\n2026-09-26T17:33:46.183+0000 INFO | remove path Command Received for path PATHX (PATHX)\\n2026-09-26T17:33:46.183+0000 WARN | Path stopped. (PATHX)\\n\"<\/code><\/pre>\n\n\n\ndebug<\/code> log is only relevant when you enable debug logging on a specific service. events<\/code> is the critical events log (same content as ER-events.log<\/code>), reachable directly as GET \/services\/v2\/logs\/events<\/code> too, wrapped as list_log_events()<\/code> :<\/p>\n\n\n\n# \/services\/v2\/logs\/events (Accept: text\/plain)\n>>> ogg_client.list_log_events(content=True)\n\"...Oracle GoldenGate Capture for Oracle, EXT.prm: Checkpoint marked as from graceful shutdown, but records found after checkpoint in trail pdb1\/e1. Expected EOF Seqno 0, RBA 0. Found Seqno 7, RBA 8884.\\n\"<\/code><\/pre>\n\n\n\nService Manager logs<\/h2>\n\n\n\n
7809<\/code> in my lab), default<\/code> is the ServiceManager.log<\/code>:<\/p>\n\n\n\n# \/services\/v2\/logs\/default (Accept: text\/plain)\n>>> ogg_client.get_service_manager_log()\n\"...2026-09-26T15:46:20.138+0000 INFO | CSRFTokenProtection: ENABLED.\\n Cross-Site Request Forgery checks using CSRF-Tokens will be performed. (Thread 12)\\n\"<\/code><\/pre>\n\n\n\nget_service_manager_log()<\/code> defaults to content=True<\/code>, since fetching the metadata for this one specific log is not relevant (this log is always enabled).<\/p>\n\n\n\nggserr.log<\/code><\/h2>\n\n\n\nggserr.log<\/code>, the deployment-wide message log, is not one of the names any \/logs<\/code> collection returns. It is provided by a separate Administration Service endpoint at \/services\/v2\/messages<\/code>. A messages<\/code> key returns the log lines.<\/p>\n\n\n\n# \/services\/v2\/messages\n>>> lines = ogg_client.list_messages()[\"messages\"]\n>>> len(lines)\n53035<\/code><\/pre>\n\n\n\nOGG-<\/code> message code in these lines, another endpoint (GET \/services\/v2\/oggerr\/{message}<\/code>) returns its explanation:<\/p>\n\n\n\n>>> ogg_client.get_ogg_error_info(message=\"OGG-30375\", ogg_service=\"adminsrvr\")\n{'$schema': 'ogg:messageExplanation', 'severity': 'ERROR', 'title': 'There was a problem updating the Administration Service resources.', 'cause': 'An internal error occurred when trying to update the service resources. Possible causes include a corrupted or incorrect resources repository.', 'action': 'Check the error log for other messages adjacent to this one that might help you resolve the problem. If you cannot resolve the problem, contact Oracle Support.'}<\/code><\/pre>\n\n\n\nadminclient.log<\/code>: no REST endpoint<\/h2>\n\n\n\nadminclient.log<\/code> is the client\u2019s connection log. It is located in the client installation at $OGG_HOME\/var\/log\/adminclient.log<\/code>, not in any deployment, and no service can read it.<\/p>\n\n\n\nReport files (
.rpt<\/code>)<\/h2>\n\n\n\nlist_extract_reports<\/code> and get_extract_report<\/code>:<\/p>\n\n\n\n# \/services\/v2\/extracts\/EXT\/info\/reports\n>>> ogg_client.list_extract_reports(extract=\"EXT\")\n[{'name': 'EXT.dsc'}, {'name': 'EXT.rpt'}]\n\n# \/services\/v2\/extracts\/EXT\/info\/reports\/EXT.rpt\n>>> ogg_client.get_extract_report(extract=\"EXT\", report=\"EXT.rpt\")\n{'lines': ['', '***********************************************************************', ' Oracle GoldenGate Capture for Oracle', ...], '$schema': 'ogg:report'}<\/code><\/pre>\n\n\n\nget_current_extract_report()<\/code> skips the .dsc<\/code>, resolves the current .rpt<\/code> for you, and returns None<\/code> if the extract has no report listed :<\/p>\n\n\n\n# \/services\/v2\/extracts\/EXT\/info\/reports\n# \/services\/v2\/extracts\/EXT\/info\/reports\/EXT.rpt\n>>> ogg_client.get_current_extract_report(extract=\"EXT\")\n{'lines': ['', '***********************************************************************', ' Oracle GoldenGate Capture for Oracle', ...], '$schema': 'ogg:report'}<\/code><\/pre>\n\n\n\nDiagnostics<\/h2>\n\n\n\n
{process}.diagnostics<\/code>, listed under the same info<\/code> path as reports. It has a status while it runs, and the start and finish times once done :<\/p>\n\n\n\n# \/services\/v2\/extracts\/EXT\/info\/diagnostics - while running\n>>> ogg_client.list_extract_diagnostics(extract=\"EXT\")\n[{'name': 'EXT.diagnostics', 'status': 'running', 'started': '2026-09-26T17:23:21Z'}]\n\n# \/services\/v2\/extracts\/EXT\/info\/diagnostics - when done\n>>> ogg_client.list_extract_diagnostics(extract=\"EXT\")\n[{'name': 'EXT.diagnostics', 'status': 'stopped', 'started': '2026-09-26T17:23:21Z', 'finished': '2026-09-26T17:33:22Z'}]<\/code><\/pre>\n\n\n\nEXT.diagnostics.1<\/code> (and so on), and the newest keeps the base name. An extract that never had a collection returns an empty list. It returns a JSON, but unlike reports and configuration files, it is a structured document with one entry per sample:<\/p>\n\n\n\n# \/services\/v2\/extracts\/EXT\/info\/diagnostics\/EXT.diagnostics\n>>> diag = ogg_client.get_extract_diagnostic(extract=\"EXT\", diagnostic=\"EXT.diagnostics\")\n>>> list(diag)\n['$schema', 'started', 'finished', 'collectionFrequency', 'collectionDuration', 'status', 'samples']\n>>> diag[\"samples\"][0][\"processSamples\"][0][\"process\"]\n{'type': 'capture', 'state': {'status': 'waiting', 'detail': 'WAITING FOR TRANSACTION'}, 'bytesMined': 2264, 'bytesSent': 1524, 'messagesCaptured': 5, 'lag': 0}<\/code><\/pre>\n\n\n\nlist_replicat_diagnostics()<\/code> \/ get_replicat_diagnostic()<\/code>.<\/p>\n\n\n\nConfiguration files<\/h2>\n\n\n\n
GLOBALS<\/code>, parameter files, and the rest of what a deployment keeps under its config directory come from \/services\/v2\/config\/files<\/code>. That directory is $OGG_CONF_HOME<\/code>, or $OGG_DEPLOYMENT_HOME\/etc\/conf<\/code>. They return their content directly:<\/p>\n\n\n\n# \/services\/v2\/config\/files\n>>> ogg_client.list_configuration_files(ogg_service=\"adminsrvr\")\n[{'name': 'EXT1.prm'}, {'name': 'EXT2.prm'}, {'name': 'REP1.prm'}, ...]\n\n# \/services\/v2\/config\/files\/EXT1.prm\n>>> ogg_client.get_configuration_file(file=\"EXT1.prm\", ogg_service=\"adminsrvr\")\n{'lines': ['EXTRACT EXT1', 'USERIDALIAS pdb1 DOMAIN OracleGoldenGate', 'EXTTRAIL qa\/xa', 'TABLE APP_PDB1.TEST;'], '$schema': 'ogg:config'}<\/code><\/pre>\n\n\n\nFile<\/th> API endpoint<\/th> oggrestapi.Service logs ( adminsrvr.\/services\/v2\/logs\/default<\/code> with Accept: text\/plain<\/code><\/td>get_log('default', content=True)<\/code> \/ get_service_log('default', content=True)<\/code><\/td><\/tr>Service Manager logs ( ServiceManager.restapi.Same resource, against the Service Manager\u2019s port<\/td> get_service_manager_log()<\/code><\/td><\/tr>ggserr.\/services\/v2\/messages<\/code><\/td>list_messages()<\/code><\/td><\/tr>adminclient.None, it is a client-side file under <OGG_HOME>\/var\/log<\/code><\/td>None (filesystem only)<\/td><\/tr> extract.replicat.None, they are filtered views of ggserr.None (filtered view)<\/td><\/tr> Reports ( .\/services\/v2\/extracts\/{extract}\/info\/reports[\/{report}]<\/code> (or replicats<\/code>), content returned directly<\/td>list_extract_reports()<\/code> \/ get_extract_report()<\/code>, or get_current_extract_report()<\/code> \/ get_current_replicat_report()<\/code><\/td><\/tr>Diagnostics<\/td> \/services\/v2\/extracts\/{extract}\/info\/diagnostics[\/{diagnostic}]<\/code><\/td>list_extract_diagnostics()<\/code> \/ get_extract_diagnostic()<\/code><\/td><\/tr>Configuration files<\/td> \/services\/v2\/config\/files\/{file}<\/code> (content returned directly)<\/td>list_configuration_files()<\/code> \/ get_configuration_file()<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"