Retrieving Detailed Diagnosis of a Measure

More often than not, administrators may want additional information on a key performance measure. Such additional information is provided as part of detailed diagnosis by eG Enterprise. Using eG REST API, administrators may be able to retrieve the detailed diagnosis of a measure without logging into the eG console. The table below specifies the URL and the parameters that should be used to retrieve the detailed diagnosis of a measure.

URL: http://<eG manager IP:port>/api/eg/analytics/getDiagnosisData

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Header

managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

{

"timeline":"1 hour",

"server":"Microsoft Windows:win112:NULL",

"test":"Network",

"measure":"packet loss",

"descriptor":""

}

Example to retrieve Detailed Diagnosis for a descriptor of a measure:

{

"timeline":"1 hour",

"server":"Windows_server:win112:NULL",

"test":"Disk Activity",

"descriptor":"Disk0 C:",

"measure":"Disk busy"

}

Body

Default:

{

"timeline"="Timeline for retrieving the measure data (in hours/days/weeks)",

"server"="Component Type:Component name:Port/Null",

"test"="Test name",

"measure"="Measure name",

"descriptor"="Descriptor name"

}

For an Oracle Database server, the Key values should be specified as follows:

{

"timeline"="Timeline for retrieving the measure data (in hours/days/weeks)",

"server"="Component Type:Component name:Port:SID",

test="Test name",

measure="Measure name"

}

Note:

The "descriptor" key value is mandatory for non-descriptor based tests too. In such case, the key value should be blank as shown in the example.

Success Response
Type Code Content

JSON

200

[

{

"PROCESS ID": "4196",

"APPLICATION NAME": "Symantec Service Framework",

"PROCESSNAME": "C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.2.5587.2100.105\\Bin\\ccSvcHst.exe /s Symantec Endpoint Protection /m C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.2.5587.2100.105\\Bin\\sms.dll /prefetch:1",

"IO RATE(KB/SEC)": "59.44",

"IO READ RATE(KB/SEC)": "59.44",

"IO READ OPS RATE(OPS/SEC)": "2.99",

"IO WRITE RATE(KB/SEC)": "0",

"IO WRITE OPS RATE(OPS/SEC)": "0",

"FILE NAME": "-",

"FILE IO READ RATE(KB/SEC)": "-",

"FILE IO WRITE RATE(KB/SEC)": "-",

"TOTAL FILE IO RATE(KB/SEC)": "-",

"RESPONSE TIME(SECS)": "-"

},

.

.

.

}

]

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Unauthorized user"}

JSON

500 Server Error

{"code": 500,"error": " Server Error "}

Figure 1 : Retrieving detailed diagnosis of a measure using Postman REST Client

Retrieving Detailed diagnosis of a Measure using cURL

To retrieve the detailed diagnosis of a measure using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getDiagnosisData" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>" -H"Content-Type:application/json" --data-raw "{\"timeline\":\"Timeline for retrieving the detailed diagnosis data (in hours/days/weeks)\",\"server\":\"Component Type:Component name:Port\",\"test\":\"Test name\",\"measure\":\"Measure name\",\"descriptor\":\"Descriptor name\"}"

Figure 2 shows an example of retrieving the detailed diagnosis of a measure using cURL.

Figure 2 : Retrieving Detailed diagnosis of a measure using cURL