Monitoring

The following functions are only available to a root customer user.



getMonitoringGraph()

Get monitoring graph. This call supports trusted mode.


Parameters:

  • type - what graph to get. String. Required. Allowed values are:
    • bandwidth_in_use
    • throughput
    • bandwidth_in_use_perenv
    • throughput_perenv
    • cpu_load
    • disk_load
    • call_processing_time
    • call_processing_time_total (only for root env)
    • calls_in_progress
    • calls_in_progress_total (only for root env)
    • calls_per_second
    • calls_per_second_total (only for root env)
    • acd_asr
    • acd_asr_total (only for root env)
    • netmem_alloc (only for root env)
    • netmem_activity (only for root env)
    • rtp_sessions_total (only for root env)
    • rtp_health_total (only for root env)
    • rtp_aduration_total (only for root env)
    • rtp_throughput_total (only for root env)
    • dbsize
    • dbsize_total (only for root env)
    • dbsize_slave
    • dbsize_slave_total (only for root env)
  • start_date - start date of the graph, format is '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 09:57:29.000 GMT Wed Nov 18 2009). String. Optional. Default is 12 hours ago.
  • interval - graph interval in seconds. Integer. Optional. Default is 12 hours.
  • width - width of the graph in pixels. Integer. Optional. Default is 330.
  • height - height of the graph in pixels. Integer. Optional. Default is 120.
  • timezone - what timezone use on graph. String. Optional.
  • i_environment - return graph for specified environment. Integer. Optional. Can be used only in root environment.


Returns:

  • result - OK means that operation successful. String.
  • graph - base64 encoded graph in PNG format. String.
  • XMLRPC fault in case of any error.



getMonitoringGraphData()

Get monitoring graph data in CSV format. This call supports trusted mode.


First column in the exported data is always time in Unix timestamp format.


Available since Sippy 2020.


Parameters:

    The same as in getMonitoringGraph()


Returns:

  • result - OK means that operation successful. String.
  • csv_data - base64 encoded data in CSV format. String.
  • XMLRPC fault in case of any error.