deephaven.PerformanceTools

Tools for users to analyze the performance of the Deephaven system and Deephaven queries.

Note: Some functions return a dictionary of tables and plots. All of the values in the dictionary can be added to the local namespace for easy analysis. For example:

locals().update(persistentQueryStatusMonitor())
metricsCountsGet()

Gets Deephaven performance counter metrics.

Returns

Deephaven performance counter metrics.

metricsCountsPrint()

Prints Deephaven performance counter metrics.

metricsCountsReset()

Resets Deephaven performance counter metrics.

performanceInfo(db, workerName=None, date=None)

Returns a dictionary of tables summarizing the performance of this query.

Parameters

  • db – database.

  • workerName – worker name. Defaults to the current worker.

  • date – date to analyze performance on. Defaults to the current date.

Returns

dictionary of tables summarizing the performance of this query.

performanceOverview(db, workerName=None, date=None, useIntraday=True, serverHost=None, workerHostName=None)

Returns a dictionary of tables containing detailed performance statistics for a query.

Parameters

  • db – database.

  • workerName – worker name.

  • date – date to analyze performance on. Defaults to the current date.

  • useIntraday – true to use performance data stored in intraday tables and false to use performance data stored in historical tables.

  • serverHost – server host.

  • workerHostName – worker host name.

Returns

dictionary of tables containing detailed performance statistics.

performanceOverviewByName(db, queryName, queryOwner, date=None, useIntraday=True, workerHostName=None, asOfTime=None)

Returns a dictionary of tables containing detailed performance statistics for a query. The query is identfied by the query name and the query owner.

Parameters

  • db – database.

  • queryName – query name.

  • queryOwner – query owner.

  • date – date to analyze performance on. Defaults to the current date.

  • useIntraday – true to use performance data stored in intraday tables and false to use performance data stored in historical tables.

  • workerHostName – worker host name.

  • asOfTime – analyze performance statistics at or before this time.

Returns

dictionary of tables containing performance statistics.

persistentQueryStatusMonitor(db, startDate=None, endDate=None)

Returns a dictionary of tables containing data and performance statistics for all persistent queries. This enables you to see if your queries are running and provides various metrics related to their performance.

Parameters

  • db – database.

  • startDate – start of the date range to analyze. The date format is YYYY-MM-DD. Defaults to the current date.

  • endDate – end of the date range to analyze. The date format is YYYY-MM-DD. Defaults to the current date.

Returns

dictionary of tables containing data and performance statistics for all persistent queries.