Get Runtime Statistics
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/statistics/runtime
Returns runtime statistics of the specified database.
Request
-
applicationName(required): string
Application name.
-
databaseName(required): string
Database name.
Response
- application/json
- application/xml
200 Response
OK
Database runtime statistics returned successfully.
object
-
cacheHitRatio:
number(double)
Ratio of the number of requests answered from aggregate storage cache as opposed to from the hard disk. May not be accurate when parallel data load or parallel calculation operations are in use.
-
currentCacheSize:
number(double)
The current size of the aggregate storage cache. See also currentCacheSizeLimit.
-
currentCacheSizeLimit:
number(double)
The maximum size (in kilobytes) to which the aggregate storage cache may grow.
-
diskSpaceAllocatedForData:
number(double)
For an aggregate storage cube, total space used by all disk files in the default tablespace.
-
diskSpaceUsedByData:
number(double)
For an aggregate storage cube, total space actually in use within the disk files in the default tablespace (some space within files may be free).
-
hitRatioOnDataCache:
number(double)
-
hitRatioOnDataFileCache:
number(double)
-
hitRatioOnIndexCache:
number(double)
-
numberOfDataBlockReads:
number(double)
-
numberOfDataBlockWrites:
number(double)
-
numberOfIndexPageReads:
number(double)
-
numberOfIndexPageWrites:
number(double)
-
pageReadsSinceLastStartup:
number(double)
For an aggregate storage cube, number of data pages read from disk since the last time the application was started.
-
pageSize:
number(double)
For an aggregate storage cube, size of the data page in kilobytes.
-
pageWritesSinceLastStartup:
number(double)
For an aggregate storage cube, number of data pages written to disk since the last time the application was started.
-
temporaryDiskSpaceAllocated:
number(double)
For an aggregate storage cube, total space used by all disk files in the temp tablespace.
-
temporaryDiskSpaceUsed:
number(double)
For an aggregate storage cube, total space actually in use within the disk files in the temp tablespace (some space within files may be free).
400 Response
Bad Request
Failed to get database runtime statistics. The application or database name may be incorrect.
500 Response
Internal Server Error.
Examples
The following example shows how to get runtime statistics for a cube.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat
.
Script with cURL Command
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/statistics/runtime" -H "accept: application/json" -u %User%:%Password%
Example of Response Body
{
"runtime": {
"cacheHitRatio": 0,
"currentCacheSize": 0,
"currentCacheSizeLimit": 0,
"pageReadsSinceLastStartup": 0,
"pageWritesSinceLastStartup": 0,
"pageSize": 0,
"diskSpaceAllocatedForData": 0,
"diskSpaceUsedByData": 0,
"temporaryDiskSpaceAllocated": 0,
"temporaryDiskSpaceUsed": 0,
"hitRatioOnIndexCache": 0,
"hitRatioOnDataCache": 0,
"numberOfIndexPageReads": 0,
"numberOfIndexPageWrites": 0,
"numberOfDataBlockReads": 0,
"numberOfDataBlockWrites": 0,
"hitRatioOnDataFileCache": 0
}
}