Performance Analyzer API

    Performance Analyzer uses a single HTTP method and URI for most requests:

    For a full list of metrics, see Metrics reference. Performance Analyzer updates its data every five seconds. If you create a custom client, we recommend using that same interval for calls to the API.

    Sample request

    Sample response

    1. {
    2.   "keHlhQbbTpm1BYicficEQg": {
    3.     "timestamp": 1554940530000,
    4.     "data": {
    5.       "fields": [{
    6.           "name": "ShardID",
    7.           "type": "VARCHAR"
    8.         },
    9.         {
    10.           "name": "Latency",
    11.           "type": "DOUBLE"
    12.         },
    13.         {
    14.           "name": "CPU_Utilization",
    15.           "type": "DOUBLE"
    16.         }
    17.       ],
    18.       "records": [
    19.         [
    20.           null,
    21.           null,
    22.           0.012552206029147535
    23.         ],
    24.         [
    25.           "1",
    26.           4.8,
    27.           0.0009780939762972104
    28.         ]
    29.       ]
    30.     }
    31.   },
    32.   "bHdpbMJZTs-TKtZro2SmYA": {
    33.     "timestamp": 1554940530000,
    34.     "data": {
    35.       "fields": [{
    36.           "name": "ShardID",
    37.           "type": "VARCHAR"
    38.         },
    39.         {
    40.           "name": "Latency",
    41.           "type": "DOUBLE"
    42.         },
    43.         {
    44.           "name": "CPU_Utilization",
    45.         }
    46.       ],
    48.         [
    49.           null,
    50.           18.2,
    51.           0.011966493817311527
    52.         ],
    53.         [
    54.           "1",
    55.           14.8,
    56.           0.0007670829370071493
    57.         ]
    58.       ]
    59.     }
    60.   }
    61. }

    Performance Analyzer has one additional URI that returns the unit for each metric.

    Sample request

    Sample response

    1. {
    2.   "Disk_Utilization": "%",
    3.   "Cache_Request_Hit": "count",
    4.   "TermVectors_Memory": "B",
    5.   "Segments_Memory": "B",
    6.   "HTTP_RequestDocs": "count",
    7.   "Net_TCP_Lost": "segments/flow",
    8.   "Refresh_Time": "ms",
    9.   "GC_Collection_Event": "count",
    10.   "Merge_Time": "ms",
    11.   "Sched_CtxRate": "count/s",
    12.   "Cache_Request_Size": "B",
    13.   "ThreadPool_QueueSize": "count",
    14.   "Sched_Runtime": "s/ctxswitch",
    15.   "Disk_ServiceRate": "MB/s",
    16.   "Heap_AllocRate": "B/s",
    17.   "Heap_Max": "B",
    18.   "Sched_Waittime": "s/ctxswitch",
    19.   "ShardBulkDocs": "count",
    20.   "Thread_Blocked_Time": "s/event",
    21.   "VersionMap_Memory": "B",
    22.   "Master_Task_Queue_Time": "ms",
    23.   "Merge_CurrentEvent": "count",
    24.   "Indexing_Buffer": "B",
    25.   "Bitset_Memory": "B",
    26.   "Norms_Memory": "B",
    27.   "Net_PacketDropRate4": "packets/s",
    28.   "Heap_Committed": "B",
    29.   "Net_PacketDropRate6": "packets/s",
    30.   "Thread_Blocked_Event": "count",
    31.   "GC_Collection_Time": "ms",
    32.   "Cache_Query_Miss": "count",
    34.   "Net_PacketRate6": "packets/s",
    35.   "Cache_Query_Hit": "count",
    36.   "IO_ReadSyscallRate": "count/s",
    37.   "Net_PacketRate4": "packets/s",
    38.   "Cache_Request_Miss": "count",
    39.   "CB_ConfiguredSize": "B",
    40.   "CB_TrippedEvents": "count",
    41.   "ThreadPool_RejectedReqs": "count",
    42.   "Disk_WaitTime": "ms",
    43.   "Net_TCP_TxQ": "segments/flow",
    44.   "Master_Task_Run_Time": "ms",
    45.   "IO_WriteSyscallRate": "count/s",
    46.   "IO_WriteThroughput": "B/s",
    47.   "Flush_Event": "count",
    48.   "Net_TCP_RxQ": "segments/flow",
    49.   "Refresh_Event": "count",
    50.   "Points_Memory": "B",
    51.   "Flush_Time": "ms",
    52.   "Heap_Init": "B",
    53.   "CPU_Utilization": "cores",
    54.   "HTTP_TotalRequests": "count",
    55.   "ThreadPool_ActiveThreads": "count",
    56.   "Cache_Query_Size": "B",
    57.   "Paging_MinfltRate": "count/s",
    58.   "Merge_Event": "count",
    59.   "Net_TCP_SendCWND": "B/flow",
    60.   "Cache_Request_Eviction": "count",
    61.   "Segments_Total": "count",
    62.   "Terms_Memory": "B",
    63.   "DocValues_Memory": "B",
    64.   "Heap_Used": "B",
    65.   "Cache_FieldData_Eviction": "count",
    66.   "IO_TotalSyscallRate": "count/s",
    67.   "CB_EstimatedSize": "B",
    68.   "Net_Throughput": "B/s",
    69.   "Paging_RSS": "pages",
    70.   "Indexing_ThrottleTime": "ms",
    71.   "StoredFields_Memory": "B",
    72.   "IndexWriter_Memory": "B",
    73.   "Master_PendingQueueSize": "count",
    74.   "Net_TCP_SSThresh": "B/flow",
    75.   "Cache_FieldData_Size": "B",
    76.   "Paging_MajfltRate": "count/s",
    77.   "ThreadPool_TotalThreads": "count",
    78.   "IO_ReadThroughput": "B/s",
    79.   "ShardEvents": "count",
    80.   "Net_TCP_NumFlows": "count"