.. title:: FtraceCollector

lisa.trace.FtraceCollector
==========================


.. autoclass:: lisa.trace::FtraceCollector
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Classes
   
   .. list-table::
      :align: left
   
      * - :class:`~lisa.trace.FtraceCollector.CONF_CLASS`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.FtraceCollector.CONF_CLASS
         
         
            Configuration class of :class:`FtraceCollector`.
   
   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.trace.FtraceCollector.INIT_KWARGS_KEY_MAP`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Dictionary of ``__init__`` parameter names to configuration key path.
      * - :attr:`~lisa.trace.FtraceCollector.NAME`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
         
         
            Name of the collector class.
      * - :attr:`~lisa.trace.FtraceCollector.TOOLS`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.CollectorBase
         
         
            Sequence of tools to install on the target when using the collector.
   
   
   .. 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.trace.FtraceCollector.__enter__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.FtraceCollector
      * - :meth:`~lisa.trace.FtraceCollector.__exit__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.FtraceCollector
      * - :meth:`~lisa.trace.FtraceCollector.from_conf`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.FtraceCollector
         
         
            Build an :class:`FtraceCollector` from a :class:`FtraceConf`.
      * - :meth:`~lisa.trace.FtraceCollector.from_user_conf`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.FtraceCollector
         
         
            Build an :class:`FtraceCollector` from two :class:`FtraceConf`.
      * - :meth:`~lisa.trace.FtraceCollector.get_data`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.FtraceCollector
         
         
            Similar to :meth:`devlib.collector.CollectorBase.get_data` but takes the path directly as a parameter in order to disallow representing an invalid state where no path has been set.
      * - :attr:`~lisa.trace.CollectorBase.__getattr__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.DelegateToAttr.<locals>._DelegatedToAttr
         
         
            Delegate attribute lookup to a private attribute.
      * - :meth:`~lisa.conf.Configurable.check_init_param` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Take the same parameters as ``__init__``, and check their types according to what is specified in the configuration class.
      * - :meth:`~lisa.conf.Configurable.conf_to_init_kwargs` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.conf
            :class: lisa.conf.Configurable
         
         
            Turn a configuration object into a dictionary suitable for passing to ``__init__`` as ``**kwargs``.
      * - :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.utils.Loggable.log_locals` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Debugging aid: log the local variables of the calling function.
   


Classes
-------


.. autoclass:: lisa.trace::FtraceCollector.CONF_CLASS



Attributes
----------


.. autoattribute:: lisa.trace::FtraceCollector.INIT_KWARGS_KEY_MAP



.. autoattribute:: lisa.trace::FtraceCollector.NAME



.. autoattribute:: lisa.trace::FtraceCollector.TOOLS



Properties
----------


.. autoproperty:: lisa.trace::FtraceCollector.logger



Methods
-------


.. automethod:: lisa.trace::FtraceCollector.__enter__



.. automethod:: lisa.trace::FtraceCollector.__exit__



.. automethod:: lisa.trace::FtraceCollector.from_conf



.. automethod:: lisa.trace::FtraceCollector.from_user_conf



.. automethod:: lisa.trace::FtraceCollector.get_data



.. automethod:: lisa.trace::FtraceCollector.__getattr__



.. automethod:: lisa.trace::FtraceCollector.check_init_param



.. automethod:: lisa.trace::FtraceCollector.conf_to_init_kwargs



.. automethod:: lisa.trace::FtraceCollector.get_logger



.. automethod:: lisa.trace::FtraceCollector.log_locals