Mentions légales du service

Skip to content
Snippets Groups Projects
Verified Commit 5684b00b authored by SIMONIN Matthieu's avatar SIMONIN Matthieu
Browse files

svc/dstat: doc

parent a894b1a0
No related branches found
No related tags found
No related merge requests found
......@@ -23,6 +23,18 @@ Docker Service Class
:undoc-members:
:show-inheritance:
Dstat (monitoring)
==================
Dstat Service Class
--------------------
.. automodule:: enoslib.service.dstat.dstat
:members:
:undoc-members:
:show-inheritance:
Locust (Load generation)
========================
......
......@@ -26,10 +26,13 @@ class Dstat(Service):
quick way to deploy a simple monitoring stack based on dstat on your nodes.
It's opinionated out of the box but allow for some convenient customizations.
dstat metrics are dumped into a csv file by default (-o option) and
retrieved when backuping.
Args:
nodes: the nodes to install dstat on
options: options to pass to dstat
options: options to pass to dstat.
priors : priors to apply
......@@ -62,7 +65,8 @@ class Dstat(Service):
def destroy(self):
"""Destroy the dtsat monitoring stack.
This destroys all the container and associated volumes.
This kills the dstat processes on the nodes.
Metric files survive to destroy.
"""
"""Stop locust."""
with play_on(roles=self._roles) as p:
......@@ -73,9 +77,11 @@ class Dstat(Service):
kill_cmd.append('cut -f 2 -d" "`')
p.shell("|".join(kill_cmd) + "|| true")
def backup(self, backup_dir=None):
def backup(self, backup_dir: str = None):
"""Backup the dstat monitoring stack.
This fetches all the remote dstat csv files under the backup_dir.
Args:
backup_dir (str): path of the backup directory to use.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment