Monitor Oracle GoldenGate Statistics using StatsD

StatsD is an open-source network daemon that listens for statistics, like counters and timers, sent over TCP and sends aggregates to one or more pluggable backend services. The StatsD daemon expects metrics formatted using a specific notation.

Oracle GoldenGate Microservice Architecture sends metrics to the Telegraf service which can store data in a Time series database (TSDB).

Oracle GoldenGate generates metrics in StatsD format and transmits them directly to a network daemon that supports ingestion of StatsD-formatted metrics.

The following diagram shows the Oracle GoldenGate side and the enterprise side where the StatsD server is hosted. The performance metrics data is transformed by the Oracle GoldenGate container application and it is written to the StatsD server.

StatsD Server aggregates performance metrics data sent by the Oracle GoldenGate Application in the StatsD format.

StatsD can be enabled using two ways:

Using the OGGCA utility, you can enable StatsD for the Service Manager and deployment. See Enable StatsD using OGGCA.
Using REST API calls after the a deployment is already set up. See Enable StatsD with REST API Service Endpoints

Enable StatsD using OGGCA

StatsD can be enabled using the OGGCA utility, while configuring the Service Manager and deployments. When you run the OGGCA utility, the option to enable StatsD is available in the Service Manager Deployment screen and in the User Deployment screen, as shown in the following images:

OGGCA Service Manager deployment screen with the StatsD option enabled

You can use the same host for setting up StatsD for the Service Manager and deployment. The following image shows the option to enable StatsD in the User Deployment screen.

The option to enable StatsD in the User Deployment screen in OGGCA.

You can set up a Telegraf host on the same machine as the Oracle GoldenGate installation or you can set up a remote server to host Telegraf and receive the Oracle GoldenGate metrics from StatsD.

For details about using OGGCA, see Add a Deployment.

Enable StatsD with REST API Service Endpoints

If you did not enable StatsD service while setting up the deployment and Service Manager using OGGCA, then use the following steps to enable StatsD using REST API service calls.

Stop the deployment:

curl -k -u username:password \
-d '{"status": "stopped","enabled": false}' \
-X PATCH https://hostname:port/services/v2/deployments/deployment_name

Enable StatsD:

curl -svu username:password \
-X PATCH http://hostname:port/services/v2/deployments/deployment_name \
--data '{
       "metrics": 
                     {
                           "enabled":true, 
                            "servers": 
                                   [
                                               {      
                                                      "type":"pmsrvr", 
                                                        "protocol":"uds"
                                                }, 
                                                 {      
                                                       "type":"statsd", 
                                                        "host":"<statsd_host>"
                                                }
                                  ]
                     }
             }'

Start the deployment:

curl -k -u username:password \
-d '{"status": "running","enabled": true}' \
-X PATCH https://hostname:port/services/v2/deployments/deployment_name

Also see Update a Deployment.

StatsD Metrics Catalog

This section describes the metrics published by an Oracle GoldenGate deployment using the StatsD protocol. All Oracle GoldenGate StatsD metrics are reported as gauges.

Batch SQL Statistics

Name	Value
Documentation	Retrieve an existing Integrated Replicat Batch SQL Statistics
Process Type(s)	Replicat
Endpoint	`/services/v2/mpoints/{item}/batchSqlStatistics`
JSON Schema	`mpoints:batchSqlStatistics`
Base Name	`batch-sql-stats`
Internal Name	`MPL_BATCHSQL_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
total-batch-operations	integer	Total Batch Operations
total-batches	integer	Total Batches
total-batch-executions	integer	Total Batch Executions
sql-queues	integer	SQL Queues
total-batches-in-error	integer	Total Batches in Error
total-normal-mode-operations	integer	Total Normal Mode Operations
total-primary-key-collisions	integer	Total Primary Key Collisions
total-foreign-key-collisions	integer	Total Foreign Key Collisions
total-unique-key-collisions	integer	Total Unique Key Collisions
total-operation-flushes	integer	Total Operation Flushes
total-plu-flushes	integer	Total PLU Flushes
number-of-batch-thread-groups	integer	Number of Batch Thread Groups
total-commits integer Total Commits	integer	Total Commits
total-flushes	integer	Total Flushes
total-rollbacks	integer	Total Rollbacks
last-timestamp	integer	Last Operation Timestamp
total-elapsed-time	integer	Total Elapsed Batch Time
total-insert-time	integer	Total Insert Time
total-update-time	integer	Total Update Time
total-delete-time	integer	Total Delete Time

Bounded Recovery Status

Name	Value
Documentation	Retrieve an existing Bounded Recovery Status
Process Type(s)	Extract
Endpoint	`/services/v2/mpoints/{item}/brStatus`
JSON Schema	`mpoints:brStatus`
Base Name	`br-status`
Internal Name	`MPL_BR_STATUS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
br-current-status	The status of the BR
force-checkpoint-time	Force Checkpoint time

Metric	Data Type	Description
last-checkpoint-number	integer	Last checkpoint time
checkpoint-intervalseconds	integer	The time interval between two checkpoints
total-num-objectspersisted	integer	Number of objects to be persisted at the BR checkpoint
total-state-bytespersisted	integer	State size of all objects to be persisted at the BR checkpoint
total-data-bytespersisted	integer	Data size of all objects to be persisted at the BR checkpoint
outstanding-numobjects	integer	Number of objects still remaining to be persisted at the BR checkpoint
outstanding-statebytes	integer	State size of all objects still remaining to be persisted at the BR checkpoint
outstanding-databytes	integer	Data size of all objects still remaining to be persisted at the BR checkpoint

Cache Manager Statistics

Name	Value
Documentation	Retrieve an existing Cache Manager Statistics
Process Type(s)	Extract, Replicat
Endpoint	`/services/v2/mpoints/{item}/cacheStatistics`
JSON Schema	`mpoints:cacheStatistics`
Base Name	`cache-statistics`
Internal Name	`MPL_CACHE_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
total-objects-in-cache	integer	Objects in Cache
total-objects	integer	Total Cached Objects
total-objects-active	integer	Total Active Objects
total-objects-committed	integer	Total Committed Objects
max-active-objects	integer	Maximum number of Active Objects
times-buffer-overflowed	integer	Times Cache Buffer Overflowed
times-get-next-from-file	integer	Number of Get Next From File Operations
times-get-last-from-file	integer	Number of Get Last From File Operations
times-small-buff-forced-out	integer	Number of Times a Small Buffer was Forced Out
times-retrieved	integer	Number of Retrieval Operations
total-number-of-q-hits	integer	Number of Cache Hits
total-number-of-q-misses	integer	Number of Cache Misses
total-number-of-q-puts	integer	Number of Cache Puts
total-number-of-q-tries	integer	Number of Cache Tries
total-number-of-q-entries	integer	Number of Queue Tries
max-number-of-q-entries	integer	Maximum number of Queue Tries
total-munmap	integer	Number of UnMap Operations
total-cnnbl-attempts	integer	Number of Cannibalize Attempts
total-cnnbl-success	integer	Number of Successful Cannibalize Attempts
total-cnnbl-mbufs	integer	Number of Buffer Cannibalize Attempts
total-file-cache-requests	integer	Number of File Cache Requests
total-file-cache-entries	integer	Number of File Cache Entries
total-file-cache-placed	integer	Number of File Objects Placed in Cache
max-qlength	integer	Maximum Queue Length
max-processed	integer	Maximum number of operations processed
times-wait-signaled	integer	Number of times a Cache Operation was Wait Signaled
times-file-cache-not-needed	integer	Number of times a File Cache was not needed
times-requestor-needed-fc	integer	Number of times a Requestor Needed a File Cache
total-objects-in-file-cache	integer	Total Number of Objects in the File Cache
total-file-cache-bytes-todisk	integer	Size of the File Cache on Disk
times-cache-flushed	integer	Number of times the Cache was flushed
max-memory-usage	integer	Maximum Memory Usage for the Cache
average-memory-usage	integer	Average Memory Usage for the Cache

Distribution Service Network Statistics

Name	Value
Documentation	Retrieve an existing Distribution Service Network Statistics
Process Type(s)	Distribution Service
Endpoint	`/services/v2/mpoints/{item}/distsrvrNetworkStats`
JSON Schema	`mpoints:distsrvrNetworkStats`
Base Name	`distributionServer-network-stats`
Internal Name	`MPL_DS_NET_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
path-name	The name of the path


total-receive-time	integer	Receive Wait Time
total-send-time	integer	Send Wait Time
total-bytes-sent	integer	Total Number of Bytes Sent
total-bytes-received	integer	Total Number of Bytes Received
total-messages-received	integer	Total Number of Messages Received
total-messages-sent	integer	Total Number of Messages Sent

Distribution Service Path Statistics

Name	Value
Documentation	Retrieve an existing Distribution Service Path Statistics
Process Type(s)	Distribution Service
Endpoint	`/services/v2/mpoints/{item}/distsrvrPathStats`
JSON Schema	`mpoints:distsrvrPathStats`
Base Name	`distributionServer-path-stats`
Internal Name	`MPL_DS_PATH_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
path-name	The name of the path

Metric	Data Type	Description
lcrs-received	integer	Number of LCRs Received
lcrs-sent	integer	Number of LCRs Sent
total-ddls	integer	Total Number of DDLs
total-procedures	integer	Total Number of Procedures
total-inserts	integer	Total Number of Inserts
total-updates	integer	Total Number of Updates
total-upserts	integer	Total Number of Upserts
total-deletes	integer	Total Number of Deletes
total-unsupported	integer	Total Number of Unsupported
total-others	integer	Total Number of Other Commands

Distribution Service Table Statistics

Name	Value
Documentation	Retrieve an existing Distribution Service Table Statistics
Process Type(s)	Distribution Service
Endpoint	`/services/v2/mpoints/{item}/distsrvrTableStats`
JSON Schema	`mpoints:distsrvrTableStats`
Base Name	`distributionServer-table-stats`
Internal Name	`MPL_DS_TABLE_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
path-name	The name of the path
table-name	N/A

Metric	Data Type	Description
lcrs-received	integer	N/A
lcrs-sent	integer	N/A
total-inserts	integer	N/A
total-updates	integer	N/A
total-upserts	integer	N/A
total-truncates	integer	N/A
total-deletes	integer	N/A
total-unsupported	integer	N/A
total-others	integer	N/A

Checkpoint Position Information Statistics

Name	Value
Documentation	Retrieve an existing Checkpoint Position Information
Process Type(s)	Extract, Replicat
Endpoint	`/services/v2/mpoints/{item}/positionEr`
JSON Schema	`mpoints:positionEr`
Base Name	`position-er`
Internal Name	`MPL_ER_POSITION`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
low-watermark-lag	integer	Lag of the low watermark (milliseconds)
high-watermark-lag	integer	Lag of the high watermark (milliseconds)
last-operation-lag	integer	Lag of last operation (milliseconds)
end-of-file	boolean	End of file indicator
trail-times-at-eof	integer	Number of Times Read Hit End of File

Input Trail File Statistics

Name	Value
Documentation	Retrieve an existing Input Trail File Statistics
Process Type(s)	Replicat, Distribution Service
Endpoint	`/services/v2/mpoints/{item}/trailInput`
JSON Schema	`mpoints:trailInput`
Base Name	`trail-input`
Internal Name	`MPL_ER_TRAIL_IN`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
trail-name	The base name of the trail
trail-path	The path for storing the trail

Metric	Data Type	Description
io-read-count	integer	Number of I/O Read Operations
io-read-bytes	integer	Number of I/O Read Bytes Transfered
trail-read-errors	integer	Number of I/O Read Errors
trail-times-at-eof	integer	Number of Times Read Hit End of File
trail-lob-bytes	integer	Number of LOB bytes read in trail file
trail-read-time	integer	Time spent in read of trail file
trail-rba	integer	Current RBA
trail-seq	integer	Current Sequence

Output Trail File Statistics

Name	Value
Documentation	Retrieve an existing Output Trail File Statistics
Process Type(s)	Extract
Endpoint	`/services/v2/mpoints/{item}/trailOutput`
JSON Schema	`mpoints:trailOutput`
Base Name	`trail-output`
Internal Name	`MPL_ER_TRAIL_OUT`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
trail-name	The base name of the trail
trail-path	The path for storing the trail

Metric	Data Type	Description
port-number	integer	The TCP/IP port for the remote trail
port-type	integer	The type of port connection
io-write-count	integer	Number of I/O Write Operations
io-write-bytes	integer	Number of I/O Write Bytes Transfered
trail-write-time	integer	Time spent in write of trail file
trail-lob-bytes	integer	Number of LOB bytes write in trail file
trail-buffer-flushes	integer	Number of trail file buffer flushes
trail-buffer-flush-time	integer	Time spent flushing trail file buffers
trail-bytes-flushed	integer	Number of bytes flushed from trail file buffers
trail-rba	integer	Current RBA
trail-seq	integer	Current Sequence
trail-max-bytes	integer	Maximum number of bytes for a Trail file

Extract Database Statistics

Name	Value
Documentation	Retrieve an existing Extract Database Statistics
Process Type(s)	Extract
Endpoint	`/services/v2/mpoints/{item}/statisticsExtract`
JSON Schema	`mpoints:statisticsExtract`
Base Name	`statistics-extract`
Internal Name	`MPL_EX_COUNTS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
mapped-total-inserts	integer	Number of INSERT operations performed
mapped-total-updates	integer	Number of UPDATE operations performed
mapped-total-deletes	integer	Number of DELETE operations performed
mapped-total-upserts	integer	Number of UPSERT operations performed
mapped-total-unsupported	integer	Number of UNSUPPORTED operations performed
mapped-total-truncates	integer	Number of TRUNCATE operations performed
total-executed-ddls	integer	Number of DDL operations performed
total-executed-procedures	integer	Number of Procedures operations performed
total-discards	integer	Number of operations discarded
total-ignores	integer	Number of errors ignored
total-conversion-errors	integer	Number of character conversion errors
total-conversion-truncates	integer	Number of character conversion truncations
total-row-fetch-attempts	integer	Number of attempts to fetch from DBMS
total-row-fetch-failures	integer	Number of failed fetch attempts
total-metadata-records	integer	Number of Metadata records written to trail

Network Statistics

Name	Value
Documentation	Retrieve an existing Network Statistics
Process Type(s)	Extract
Endpoint	`/services/v2/mpoints/{item}/networkStatistics`
JSON Schema	`mpoints:networkStatistics`
Base Name	`network-stats`
Internal Name	`MPL_NET_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
host-name	The name of the host

Metric	Data Type	Description
port-number	integer	Port Number
socket-open-time	integer	N/A
inbound-bytes	integer	Inbound Bytes Received
inbound-messages	integer	Inbound Messages Received
outbound-bytes	integer	Outbound Bytes Sent
outbound-messages	integer	Outbound Messages Sent
send-wait-time	integer	Send Wait Time
receive-wait-time	integer	Receive Wait Time
send-count	integer	Send Count
receive-count	integer	Receive Count
compression-wc-time	integer	Compression Wallclock Time
compression-cpu-time	integer	Compression CPU Time
decompression-wc-time	integer	Decompression Wallclock Time
decompression-cpu-time	integer	Decompression CPU Time
encryption-wc-time	integer	Encryption Wallclock Time
encryption-cpu-time	integer	Encryption CPU Time
encryption-bytes	integer	Encryption Bytes
decryption-wc-time	integer	Decryption Wallclock Time
decryption-cpu-time	integer	Decryption CPU Time
decryption-bytes	integer	Decryption Bytes
compresses_bytes_in	integer	Compress Bytes In
uncompresses_bytes_in	integer	Uncompress Bytes In
compresses_bytes_out	integer	Compress Bytes Out
uncompresses_bytes_out	integer	Uncompress Bytes Out

Process Performance Statistics

Name	Value
Documentation	Retrieve an existing Process Performance Resource Utilization Information
Process Type(s)	All
Endpoint	`/services/v2/mpoints/{item}/processPerformance`
JSON Schema	`mpoints:processPerformance`
Base Name	`process-performance`
Internal Name	`MPL_PROC_PERF`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
process-start-time	integer	Process Start Time
process-id	integer	The operating system process id
thread-count	integer	Number of Threads
handle-count	integer	Number of Handles
cpu-time	integer	Process CPU Time (in microseconds)
kernel-time	integer	Process Kernel Mode Time (in microseconds)
user-time	integer	Process User Mode Time (in microseconds)
io-read-count	integer	Number of I/O Read Operations
io-write-count	integer	Number of I/O Write Operations
io-other-count	integer	Number of I/O Other Operations
io-read-bytes	integer	Number of I/O Read Bytes Transfered
io-write-bytes	integer	Number of I/O Write Bytes Transfered
io-other-bytes	integer	Number of I/O Other Bytes Transfered
page-faults	integer	Number of Page Faults for the Process
working-set-size	integer	Process Working Set Size in bytes
peak-working-set-size	integer	Peak Process Working Set Size in bytes
private-bytes	integer	Process Private Size in bytes

Queue Statistics

Name	Value
Documentation	Retrieve an existing Queue Statistics
Process Type(s)	Extract
Endpoint	`/services/v2/mpoints/{item}/queueStatistics`
JSON Schema	`mpoints:queueStatistics`
Base Name	`queue-stats`
Internal Name	`MPL_QUEUE_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
queue-name	The name of the queue

Metric	Data Type	Description
queue-items	integer	Items in the Queue
queue-reads	integer	Queue Reads
queue-read-waits	integer	Queue Reads resulting in a wait
queue-reads-signaled	integer	Queue Read Waits that were signaled
queue-writes	integer	Queue Writes
queue-write-waits	integer	Queue Writes resulting in a wait
queue-writes-signaled	integer	Queue Write Waits that were signaled
queue-max-size	integer	Maximum size of the Queue
queue-current-size	integer	Current size of the Queue
thread-id	integer	Owning Thread id

Replicat Database Statistics

Name	Value
Documentation	Retrieve an existing Replicat Database Statistics
Process Type(s)	Replicat
Endpoint	`/services/v2/mpoints/{item}/statisticsReplicat`
JSON Schema	`mpoints:statisticsReplicat`
Base Name	`statistics-replicat`
Internal Name	`MPL_RP_COUNTS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
mapped-total-inserts	integer	Number of INSERT operations performed
mapped-total-updates	integer	Number of UPDATE operations performed
mapped-total-deletes	integer	Number of DELETE operations performed
mapped-total-upserts	integer	Number of UPSERT operations performed
mapped-totalunsupported	integer	Number of UNSUPPORTED operations performed
mapped-totaltruncates	integer	Number of TRUNCATE operations performed
total-executed-ddls	integer	Number of DDL operations performed
total-executedprocedures	integer	Number of Procedures operations performed
total-discards	integer	Number of operations discarded
total-ignores	integer	Number of errors ignored
total-conversion-errors	integer	Number of character conversion errors
total-conversiontruncates	integer	Number of character conversion truncations
total-conflictsdetected	integer	Number of database conflicts
total-conflicts-resolved	integer	Number of database conflicts resolved per user settings
total-conflicts-failed	integer	Number of database conflicts that could not be automatically resolved

Parallel Replicat Statistics

Name	Value
Documentation	Retrieve an existing Parallel Replicat Statistics
Process Type(s)	Replicat
Endpoint	`/services/v2/mpoints/{item}/parallelReplicat`
JSON Schema	`mpoints:parallelReplicat`
Base Name	`parallel-replicat-stats`
Internal Name	`MPL_RP_PARALLEL`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process

Metric	Data Type	Description
total-transactions	integer	Total Transactions Processed
split-transactions	integer	Split Transactions
split-avg-chunks	integer	Split transactions average splits
split-avg-rows	integer	Split transactions average rows
serialize-transactions	integer	Transactions serialized
large-transactions	integer	Total Number of Large Transactions
large-avg-rows	integer	Large Transactions average rows
large-avg-chunks	integer	Large Transactions average number of chunks
missing-dep-cols	integer	Missing dependency columns
non-native-support	integer	Transactions with non-native support
max-scheduling-const	integer	Transactions with number of constraints greater than the maximum supported
metadata-changes	integer	Number of Metadata Barriers
ddl-operation-barriers	integer	Number of DDL Fallbacks
sequence-operation-barriers	integer	Number of Sequence Fallbacks
proc-ops	integer	N/A
event-actions	integer	Number of Event Fallbacks
stored-procedures	integer	Number of Stored Procedure Fallbacks
synchronous	integer	Transactions serialized due to SYNCHRONOUS option
fk-parent-row-deletes	integer	Dependencies due to parent row delete operations
table-level-dependencies	integer	Table-level dependencies
virtual-column-dependencies	integer	Dependencies due to virtual columns
fallbacks-transactions	integer	Total Transactions Processed
active-appliers	integer	Number of active Appliers

Receiver Service Statistics

Name	Value
Documentation	Retrieve an existing Receiver Service Statistics
Process Type(s)	Receiver Service
Endpoint	`/services/v2/mpoints/{item}/recvsrvrStats`
JSON Schema	`mpoints:recvsrvrStats`
Base Name	`receiver-service-stats`
Internal Name	`MPL_RS_STATS`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
path-name	The name of the path
target-file-name	Target File Name
last-file	Last File Received

Metric	Data Type	Description
total-bytes-written	integer	Total File Bytes Written
total-commands	integer	Total Number of Commands
total-sends	integer	Total Number of Sends
total-receives	integer	Total Number of Receives
total-bytes-sent	integer	Total Number of Bytes Sent
total-bytes-received	integer	Total Number of Bytes Received
total-messages-sent	integer	Total Number of Messages Sent
total-messages-received	integer	Total Number of Messages Received
total-send-wait-time	integer	Total Send Wait Time
total-receive-wait-time	integer	Total Receive Wait Time
send-buffer-size	integer	Size of the Send Buffer
receive-buffer-size	integer	Size of the Receive Buffer
message-buffer-size	integer	Size of the Message Buffer
flush-size-threshold	integer	Threshold size for flushing the Buffer
flush-time-threshold	integer	Threshold time for flushing the Buffer
is-alive	boolean	The path is connected to the Distribution Server

Extract Database Statistics by Table

Name	Value
Documentation	Retrieve an existing Extract Database Statistics by Table
Process Type(s)	Extract
Endpoint	`/services/v2/mpoints/{item}/statisticsTableExtract`
JSON Schema	`mpoints:statisticsTableExtract`
Base Name	`statistics-table-extract`
Internal Name	`MPL_TABLE_COUNTS_EX`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
table-name	The name of the table

Metric	Data Type	Description
mapped-total-inserts	integer	Number of INSERT operations performed
mapped-total-updates	integer	Number of UPDATE operations performed
mapped-total-deletes	integer	Number of DELETE operations performed
mapped-total-truncates	integer	Number of TRUNCATE operations performed
total-ignores	integer	Number of errors ignored
total-discards	integer	Number of operations discarded
total-row-fetch-attempts	integer	Number of attempts to fetch from DBMS
total-row-fetch-failures	integer	Number of failed fetch attempts

Replicat Database Statistics by Table

Name	Value
Documentation	Retrieve an existing Replicat Database Statistics by Table
Process Type(s)	Replicat
Endpoint	`/services/v2/mpoints/{item}/statisticsTableReplicat`
JSON Schema	`mpoints:statisticsTableReplicat`
Base Name	`statistics-table-replicat`
Internal Name	`MPL_TABLE_COUNTS_RP`

Tag	Description
deploymentName	The name of the OGG Microservices deployment
deploymentId	The unique identity of the OGG Microservices deployment
processType	The type of process
processName	The name of the process
table-name	The name of the table
target-table-name	The name of the target table

Metric	Data Type	Description
mapped-total-inserts	integer	Number of INSERT operations performed
mapped-total-updates	integer	Number of UPDATE operations performed
mapped-total-deletes	integer	Number of DELETE operations performed
mapped-total-upserts	integer	Number of UPSERT operations performed
mapped-total-truncates	integer	Number of TRUNCATE operations performed
total-ignores	integer	Number of errors ignored
total-discards	integer	Number of operations discarded
total-conflicts-detected	integer	Total Apply Conflicts
total-conflicts-resolved	integer	Total Conflicts Automatically Resolved
total-conflicts-failed	integer	Total Conflicts that Failed Automatic Resolution
total-insert-row-exists	integer	Number of database conflicts of the type insert row exists
total-update-row-exists	integer	Number of database conflicts of the type update row exists
total-update-row-missing	integer	Number of database conflicts of the type update row missing
total-delete-row-exists	integer	Number of database conflicts of the type delete row exists
total-delete-row-missing	integer	Number of database conflicts of the type delete row missing

Disable StatsD using OGGCA

To disable the StatsD service for an existing deployment, run the OGGCA configuration wizard and perform the following steps:

Deselect the StatsD option from the Service Manager Deployment screen.
Click Next and finish the steps in OGGCA wizard.

For details about using OGGCA, see Add a Deployment.

Disable StatsD with REST API Service Endpoints

To disable the StatsD service in an existing deployment using REST API service calls, perform the following steps:

Stop the deployment:

curl -k -u username:password \
-d '{"status": "stopped","enabled": true}' \
-X PATCH https://hostname:port/services/v2/deployments/deployment_name

Disable StatsD:

curl -svu username:password \
-X PATCH http://hostname:port/services/v2/deployments/deployment_name \
--data '{
       "metrics": 
                     {
                           "enabled":false, 
                            "servers": 
                                   [
                                               {      
                                                      "type":"pmsrvr", 
                                                        "protocol":"uds"
                                                }, 
                                                 {      
                                                       "type":"statsd", 
                                                        "host":"statsd_host"
                                                }
                                  ]
                     }
             }'

Start the deployment:

curl -k -u username:password \
-d '{"status": "running","enabled": true}' \
-X PATCH https://hostname:port/services/v2/deployments/deployment_name

Also see Update a Deployment.