Suuport ShTracer template

duetector/collectors/models.py

@@ -79,6 +79,7 @@ def from_namedtuple(tracer, data: NamedTuple) -> Tracking:  # type: ignore
             # Is instance of tracer
             tracer_name = getattr(tracer, "name", tracer.__class__.__name__)
 
+        tracer_name = tracer_name.lower()
         args = {
             "tracer": tracer_name,
             "extended": {},

duetector/managers/tracer.py

@@ -4,7 +4,7 @@
 import pluggy
 
 import duetector.tracers.register
-from duetector.config import Configuable
+from duetector.config import Config, Configuable
 from duetector.extension.tracer import project_name
 from duetector.log import logger
 from duetector.managers.base import Manager
@@ -24,21 +24,79 @@ def init_tracer(config) -> Optional[Tracer]:
 
 
 class TracerTemplate(Configuable):
+    """
+    Using template to generate tracers.
+
+    Tracers are initialized from config, and can be ``disabled`` by config.
+    Tracer type is defined by ``_avaliable_tracer_type``.
+
+
+    Example:
+
+    .. code-block:: toml
+
+    [tracer.template.sh]
+    pstracer = { "comm" = ["ps", "-aux"], config = { "enable_cache" = false } }
+    """
+
     _avaliable_tracer_type = {
         "sh": ShellTracer,
     }
+    """
+    Available tracer type.
+    """
 
     default_config = {
         "disabled": False,
         **{k: dict() for k in _avaliable_tracer_type.keys()},
     }
+    """
+    Default config for ``TracerTemplate``.
+    """
+
+    @property
+    def disabled(self) -> bool:
+        """
+        Whether the template is disabled.
+        """
+        return self.config.disabled
 
     def __init__(self, config: Optional[Dict[str, Any]] = None, *args, **kwargs):
         super().__init__(config, *args, **kwargs)
-        self._avaliable_tracer: Dict[type, Dict[str, Any]] = {}
+
+    def _get_wrap_tracer(
+        self, tracer_type: Union[str, type], tracer_name: str, kwargs: Config
+    ) -> Tracer:
+        """
+        Get a wrapper class for tracer type.
+        """
+        if isinstance(tracer_type, str):
+            tracer_type = self._avaliable_tracer_type[tracer_type]
+
+        class WrapTracer(tracer_type):
+            config_scope = None
+
+        tracer_config = kwargs.pop("config", {})
+        WrapTracer.__name__ = WrapTracer.name = tracer_name
+        for k, v in kwargs.items():
+            setattr(WrapTracer, k, v)
+
+        return WrapTracer(tracer_config)
 
     def init(self) -> List[Tracer]:
-        return []
+        """
+        Initialize all tracers from config.
+        """
+        if self.disabled:
+            logger.info("TracerTemplate disabled.")
+            return []
+
+        objs = []
+        for k, tracer_type in self._avaliable_tracer_type.items():
+            for tracer_name, kwargs in self.config._config_dict[k].items():
+                objs.append(self._get_wrap_tracer(tracer_type, tracer_name, kwargs))
+
+        return objs
 
 
 class TracerManager(Manager):

duetector/monitors/sh_monitor.py

@@ -1,4 +1,5 @@
 import subprocess
+from datetime import datetime
 from typing import Any, Callable, Dict, List, NamedTuple, Optional
 
 from duetector.collectors.base import Collector
@@ -50,7 +51,7 @@ def _():
                 tracer.set_cache(output)
 
             callback = self.callbacks[tracer]
-            callback(tracer.data_t(output=output))
+            callback(tracer.data_t(output=output, dt=datetime.now()))
 
         return _
 

duetector/tracers/base.py

@@ -240,7 +240,7 @@ class ShellTracer(Tracer):
     """
     shell command
     """
-    data_t = namedtuple("ShellOutput", ["output"])
+    data_t = namedtuple("ShellOutput", ["output", "dt"])
     """
     data type for this tracer
     """

tests/test_bcc_monitor.py

@@ -114,8 +114,8 @@ def test_bcc_monitor(bcc_monitor: MockMonitor):
     bcc_monitor.poll_all()
     bcc_monitor.shutdown()
     assert bcc_monitor.summary()
-    bcc_monitor.summary()["MockMonitor"]["DBCollector"]["BccMockTracer"]["last"] == Tracking(
-        tracer="BccMockTracer",
+    bcc_monitor.summary()["MockMonitor"]["DBCollector"]["bccmocktracer"]["last"] == Tracking(
+        tracer="bccmocktracer",
         pid=9999,
         uid=9999,
         gid=9999,

tests/test_tracer_template.py

@@ -0,0 +1,45 @@
+import pytest
+
+from duetector.managers.tracer import ShellTracer, TracerTemplate
+
+
+def test_disabled_property():
+    tracer_template = TracerTemplate({"disabled": True})
+    assert tracer_template.disabled == True
+
+    tracer_template = TracerTemplate({"disabled": False})
+    assert tracer_template.disabled == False
+
+
+def test_init():
+    tracer_template = TracerTemplate({"disabled": True})
+    assert tracer_template.init() == []
+
+    tracer_template = TracerTemplate(
+        {
+            "disabled": False,
+            "sh": {
+                "tracer_name": {
+                    "comm": ["ps", "-aux"],
+                    "config": {"enable_cache": False},
+                }
+            },
+        }
+    )
+    tracers = tracer_template.init()
+    assert len(tracers) == 1
+    assert isinstance(tracers[0], ShellTracer)
+
+
+def test_get_wrap_tracer():
+    tracer_template = TracerTemplate()
+    tracer = tracer_template._get_wrap_tracer(
+        "sh", "tracer_name", {"comm": ["ps", "-aux"], "config": {"enable_cache": False}}
+    )
+    assert isinstance(tracer, ShellTracer)
+    assert tracer.config._config_dict == {"disabled": False, "enable_cache": False}
+    assert tracer.comm == ["ps", "-aux"]
+
+
+if __name__ == "__main__":
+    pytest.main(["-s", "-vv", __file__])