.. title:: LatencyAnalysis lisa.analysis.latency.LatencyAnalysis ===================================== .. autoclass:: lisa.analysis.latency::LatencyAnalysis :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.analysis.latency.LatencyAnalysis.LATENCY_THRESHOLD_COLOR` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis * - :attr:`~lisa.analysis.latency.LatencyAnalysis.LATENCY_THRESHOLD_ZONE_COLOR` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis * - :attr:`~lisa.analysis.latency.LatencyAnalysis.name` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Name of the analysis class. .. rubric:: Properties .. list-table:: :align: left * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Convenience short-hand for ``self.get_logger()``. .. rubric:: Methods .. list-table:: :align: left * - :meth:`~lisa.analysis.latency.LatencyAnalysis.df_activations` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis DataFrame of a task's activations. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.df_latency_preemption` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis DataFrame of a task's preemption latencies. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.df_latency_wakeup` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis DataFrame of a task's wakeup latencies. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.df_runtimes` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis DataFrame of task's runtime each time the task blocks. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.plot_activations` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis Plot the :meth:`~lisa.analysis.latency.LatencyAnalysis.df_activations` of a task. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.plot_latencies` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis Plot the latencies of a task over time. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.plot_latencies_cdf` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis Plot the latencies Cumulative Distribution Function of a task. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.plot_latencies_histogram` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis Plot the latencies histogram of a task. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.plot_latency_bands` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis Draw the task wakeup/preemption latencies as colored bands. * - :meth:`~lisa.analysis.latency.LatencyAnalysis.plot_runtimes` - .. withrefctx:: :module: lisa.analysis.latency :class: lisa.analysis.latency.LatencyAnalysis Plot the :meth:`lisa.analysis.latency.LatencyAnalysis.df_runtimes` of a task. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.cache` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Decorator to enable caching of the output of dataframe getter function in the trace cache. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.call_on_trace` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Call a method of a subclass on a given trace. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.df_method` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Dataframe function decorator. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_all_events` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Returns the set of all events used by any of the methods. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_analysis_classes` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_default_plot_path` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Return the default path to use to save plots for the analysis. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_df_methods` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Provides a :class:`logging.Logger` named after ``cls``. * - :meth:`~lisa.analysis.base.AnalysisHelpers.get_plot_methods` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Debugging aid: log the local variables of the calling function. * - :meth:`~lisa.analysis.base.AnalysisHelpers.plot_method` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Plot function decorator. * - :meth:`~lisa.analysis.base.AnalysisHelpers.save_plot` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Save a holoviews element or :class:`matplotlib.figure.Figure` as an image file. Attributes ---------- .. autoattribute:: lisa.analysis.latency::LatencyAnalysis.LATENCY_THRESHOLD_COLOR .. autoattribute:: lisa.analysis.latency::LatencyAnalysis.LATENCY_THRESHOLD_ZONE_COLOR .. attribute:: LatencyAnalysis.name :canonical: lisa.analysis.latency.LatencyAnalysis.name :value: 'latency' .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Name of the analysis class. Properties ---------- .. autoproperty:: lisa.analysis.latency::LatencyAnalysis.logger Methods ------- .. automethod:: lisa.analysis.latency::LatencyAnalysis.df_activations .. automethod:: lisa.analysis.latency::LatencyAnalysis.df_latency_preemption .. automethod:: lisa.analysis.latency::LatencyAnalysis.df_latency_wakeup .. automethod:: lisa.analysis.latency::LatencyAnalysis.df_runtimes .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_activations .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_latencies .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_latencies_cdf .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_latencies_histogram .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_latency_bands .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_runtimes .. automethod:: lisa.analysis.latency::LatencyAnalysis.cache .. automethod:: lisa.analysis.latency::LatencyAnalysis.call_on_trace .. automethod:: lisa.analysis.latency::LatencyAnalysis.df_method .. automethod:: lisa.analysis.latency::LatencyAnalysis.get_all_events .. automethod:: lisa.analysis.latency::LatencyAnalysis.get_analysis_classes .. automethod:: lisa.analysis.latency::LatencyAnalysis.get_default_plot_path .. automethod:: lisa.analysis.latency::LatencyAnalysis.get_df_methods .. automethod:: lisa.analysis.latency::LatencyAnalysis.get_logger .. automethod:: lisa.analysis.latency::LatencyAnalysis.get_plot_methods .. automethod:: lisa.analysis.latency::LatencyAnalysis.log_locals .. automethod:: lisa.analysis.latency::LatencyAnalysis.plot_method .. automethod:: lisa.analysis.latency::LatencyAnalysis.save_plot