Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetLogs

int ctMemphisGetLogs( pRCESJson request, ppRCESJson result )

Description:

Retrieve Log/Trace records from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisGetLogs/

HTTP Verb: POST

Parameters:

  • request [IN] - Get Logs request in JSON format. For example:

{

"beginTime": "2015-11-05T10:00:00", // optional, start time to be used on

Log retrieval

"endTime": "2015-11-05T11:00:00", // optional, if it is not passed, uses

the current time

"maxDetailLevel": 4, // optional, if not passed, return the

message up to detail 2.

1 is errors only,

2 has basic info,

3 has basic trace and

4 has all detailed trace.

"maxSevLevel": 5, // optional, if not passed, return the message

up to severity 4.

0 is critical,

1 to 3 are error severity levels,

4 info message and

5 is detailed trace.

"showDBEngine": false, // optional, default is true, but if false,

filter out the DBEngine messages

"showReplStudio": true, // optional, default is true, but if false,

filter out the Replication Studio messages

"showReplAgent": true, // optional, default is true, but if false,

filter out the ctreplagent messages

"showWebServer": true, // optional, default is true, but if false,

filter out the Web Server messages

"dbEngine": 1, // optional, if passed, it will return only

messages for the specific DBEngine

(agent embedded to this DBEngine as well).

"FunctionNameFilter": "RCES", // optional, if passed, it will filter the

messages only for the matching function name.

It will use the partial name match for

filtering

"errorCode": 0, // optional, if passed, it will filter the

messages only for the matching error code

"latest": 100, // optional, is passed, it will return only
the N most recent log messages, the "paging"
and "begin/end Time" options will be ignored
with this option is passed in. Also, the log
entries will be returned in reverse order

"paging": true, // optional, see Note 1 - Paging Parameters

"limit": 100, // optional, see Note 1 - Paging Parameters

"start": 200 // optional, see Note 1 - Paging Parameters

}

  • result [OUT] - Result in JSON format. For example:

{

"replPlanLogList": [

{

"time": "2015-11-05T10:00:02",

"type": "Trace", // can be "Info", "Warning",

"Error", "Exception" or "Trace"

"agent": "Replication Studio", // can be "DBEngine",

"Replication Studio",

"Replication Agent" and

"Web Server"

"dbEngine": 1,

"agentName": "FAIRCOM1@ENRICOVISCO0F37",

"functionName": "RCESDBEngine::ctCheckDBEngine",

"detailLevel": 2,

"severity": 5,

"errorCode": 0,

"message": "Request Check DBEngine [FAIRCOM1] - start"

},

{

"time": "2015-11-05T10:00:02",

"type": "Trace", // can be "Info", "Warning",

"Error", "Exception" or "Trace"

"agent": "Replication Studio", // can be "DBEngine",

"Replication Studio",

"Replication Agent" and

"Web Server"

"dbEngine": 1,

"agentName": "FAIRCOM1@ENRICOVISCO0F37",

"functionName": "RCESActionExecFS::CheckDBEngine",

"detailLevel": 2,

"severity": 5,

"errorCode": 0,

"message": "Process Check DBEngine - Volume ID [0], Working Dir

[C:/temp/run2/srv1] and Local Dir [(null)] - start"

},

{

"time": "2015-11-05T10:01:02",

"type": "Trace", // can be "Info", "Warning",

"Error", "Exception" or "Trace"

"agent": "Replication Studio", // can be "DBEngine",

"Replication Studio",

"Replication Agent" and

"Web Server"

"dbEngine": 1,

"agentName": "FAIRCOM1@ENRICOVISCO0F37",

"functionName": "RCESActionExecFS::CheckDBEngine",

"detailLevel": 2,

"severity": 5,

"errorCode": 0,

"message": "Process Check DBEngine - Volume ID [0], Working Dir

[C:/temp/run2/srv1] and Local Dir [(null)] - completed"

},

{

"time": "2015-11-05T10:01:02",

"type": "Trace", // can be "Info", "Warning",

"Error", "Exception" or "Trace"

"agent": "Replication Studio", // can be "DBEngine",

"Replication Studio",

"Replication Agent" and

"Web Server"

"dbEngine": 1,

"agentName": "FAIRCOM1@ENRICOVISCO0F37",

"functionName": "RCESDBEngine::ctCheckDBEngine",

"detailLevel": 2,

"severity": 5,

"errorCode": 0,

"message": "Request Check DBEngine [FAIRCOM1] - completed"

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 4 // total number of Log entries for the query - see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex