drove.io Documentation

Transcription

1 drove.io Documentation Release 0.1 Andrés J. Díaz November 20, 2014

2

3 Contents 1 Installation 3 2 Usage 5 3 Plugins 7 4 Reference drove drove.command drove.data drove.util drove.util.daemon drove Installation Usage Development Indices and tables 29 Python Module Index 31 i

4 ii

5 This is a 10 minute guide to install drove with minimal plugin configuration to monitoring a simple host. First of all be sure that you have almost python >= installed on your system. Then install pip and distribute (usually all this dependencies are installed by default in your operating system). Finally, install drove: $ sudo pip install drove Once you have drove installed, is time to run it and test that everything works fine: $ drove -v -s logconsole=true daemon -np -f (drove) reineta master¹ doc % drove -v -s logconsole=true daemon -np -f [ :18:29,916] INFO Starting drove daemon (0.2) [ :18:29,917] INFO Using configuration file: /drove/config/drove.conf [ :18:29,917] DEBUG Creating channel [ :18:29,917] DEBUG Starting plugins [ :18:29,917] WARNING No plugins installed... drove has no work to do. $ We just run drove daemon with some options, concretly -v which means be verbose, -s logconsole=true which forces drove to log output in stderr, -np which means no plugins and provokes that if there are no configured plugins, the daemon dies and -f which means foreground, which avoid drove to go to background. Now is time to instal any plugin. For example a basic CPU collector: $ drove install droveio.cpu That install the oficial droveio plugin for cpu. Now we need to activate the plugin, editing /etc/drove.conf, and adding the following lines to enable the plugin: plugin.droveio.cpu: true Then you can start your daemon in background $ drove daemon Ok, now we have a drove daemon collecting CPU data, which is cool, but we need to do something with this data. Note: If you do not understand how drove works, please read Introduction_ section before continue. We can use in this example the influxdb plugin. Influxdb is a time series database which fits well for drove mechanics. You need to install influxdb before continue. Please read the installation section in influx documentation. After install Influxdb, we need to install the influxdb drove plugin: $ drove install droveio.influxdb And configure the plugin in /etc/drove.conf: plugin.droveio.influxdb { host: " " port: "8086" database: "drove" user: "admin" password: "admin" } Then restart the drove daemon: Contents 1

6 $ pkill *drove* $ drove daemon Your drove installation is ready. Now you have a drove daemon acting as agent, collecting data from CPU using droveio.cpu plugin, and writing data in influxdb, using droveio.influxdb plugin. 2 Contents

7 CHAPTER 1 Installation You can install drove using the normal way for python packages: $ pip install drove In the future we provide also binaries for different platfmors, which probably will include a set of plugins also. 3

8 4 Chapter 1. Installation

9 CHAPTER 2 Usage TBD 5

10 6 Chapter 2. Usage

11 CHAPTER 3 Plugins TBD 7

12 8 Chapter 3. Plugins

13 CHAPTER 4 Reference Here are the module references for drove, intented to be useful for developers to extend drove.io or create new plugins. 4.1 drove drove.command drove.command.daemon class drove.command.daemon.daemoncommand(config, args, log) Bases: drove.command.command execute() drove.command.install class drove.command.install.installcommand(config, args, log) Bases: drove.command.command execute() drove.command.list class drove.command.list.listcommand(config, args, log) Bases: drove.command.command List installed plugins execute() drove.command.remove class drove.command.remove.removecommand(config, args, log) Bases: drove.command.command Remove an installed plugin execute() 9

14 drove.command.search class drove.command.search.searchcommand(config, args, log) Bases: drove.command.command Search plugins in online repository execute() print_item(item) The generic command module provides a generic way to load specific drove client commands. class drove.command.command(config, args, log) classmethod from_name(name, config, args, log) Instanciate specific command name (str) the name of the command which may match with specific command submodule. config (Config) the configuration object for drove args (argparse.namespace) the namespace contains arguments parsed by argparse. log (logging.logger) a logger provided by the application to display messages. exception drove.command.commanderror Bases: builtins.exception Models an error running a client command drove.data drove.data.event This module contains classes and definitions related with events. An event is a notification emitted by some plugin to warn about any condition. class drove.data.event.event(plugin, severity, message, nodename=none, timestamp=none) Bases: drove.data.data Models an event for drove nodename (str) the node which generate the value plugin (str) the plugin namespace which generate the value value (float or int) the value number to dispatch value_type (one of VALUE_COUNTER, VALUE_GAUGE or VALUE_TIME) the type of the value timestamp (int) the timestamp when the data is created dump() Return a dump representation of the event 10 Chapter 4. Reference

15 class drove.data.event.severity Model the severity of an event. >>> Severity.OKAY == 0 >>> Severity.WARNING == 1 >>> Severity.CRITICAL == 2 >>> Severity.MISSING == 3 CRITICAL = 2 MISSING = 3 OKAY = 0 WARNING = 1 drove.data.value This module contains classes and definitions related with values. A value is a metric which will sent to drove class drove.data.value.value(plugin, value, nodename=none, value_type= g, timestamp=none) Bases: drove.data.data Models a value for drove nodename (str) the node which generate the value plugin (str) the plugin namespace which generate the value value (float or int) the value number to dispatch value_type (one of VALUE_COUNTER, VALUE_GAUGE or VALUE_TIME) the type of the value timestamp (int) the timestamp when the data is created dump() Return a dump representation of the value The data module contains definitions of data used in drove client-server communication class drove.data.data classmethod from_dump(dump_str) Create a Data from a dump representation. The dump representation of drove object contains six fields, separated by pipe. This representation is used to send values and events over the net, and, in general, to serialize metrics and events of any kind. Formerly, the dump representation contains the following fields: Kind Must be V for values or E for events. Nodename Is the node name which generate the data. Plugin Namespace The namespace where the data must be anchor to. For value data, we have: Value The numeric value of the metric drove 11

16 Value Type The type of the metric. Can be g for gauge, c for counter or t for time. For event data, we have: Severity Is an integer which indicate the severity. Lower value implies lower severity. Message Is a descriptive message of the event (human readable), encoded in UTF-8. For both, also have: Timestamp An integer number which represents the UNIX timestamp when the data was generated. is_event() Return true if the data is an Event is_value() Return true if the data is a Value drove.util drove.util.daemon drove.util.daemon.posix Generic linux daemon base class for python 3.x. Most of this module is heavly based on the work of Lone Wolves _ class drove.util.daemon.posix.posixdaemon(handler, exit_handler=none) Bases: drove.util.daemon.daemon foreground() Run the handler in foreground restart() Restart the daemon Return type int Returns The PID of the child process which is running the handler. set_exit_handler(func) Dynamically sets the exit_handler to specified function passed as argument. start() Start the daemon Return type int Returns The PID of the child process which is running the handler. stop() Stop the daemon The data module contains definitions of data used in drove client-server communication class drove.util.daemon.daemon Generic class to model different daemonize implementations. To instance one, please use create() metod. classmethod create(handler, exit_handler=none) Crete a new Daemon object, which is dynamically selected according to running operating system. 12 Chapter 4. Reference

17 handler (callable) The handler to call to daemonize the process. exit_handler (callable) The handler to call when exit if any. drove.util.importer This module contains classes and methods to import dynamically modules from specified paths. drove.util.importer.load(module, attr_name=none, anchor= drove.util, path=[]) Load a module or an attribute from the specific module. >>> load("sys") >>> load("sys.environ") >>> load(".importer") module (str) The module name to load attr_name (str) The name of the attribute of the module to load (if any). If not present, returns the module itself. anchor (str) The anchor module to resolve relative module paths. package. path (list) a list with paths to search the module By default uses drove.util.lexer This module provides a basic lexer utility. class drove.util.lexer.lexer(basic_class=<class drove.util.lexer.lexeritem >) additemparser(keyword, item_class=none, ignore_words=[]) Add new item parser in lexer keyword (str) keyword to find for this item parser item_class (class) the class to instanciate for this keyword. parse(text, whitespace= trn, wordchars=., _-:;*><=!, commenters= #, quotes=, terminators=.;, ) Parse a text text (str) the text to be parsed whitespace (str) a list (in string form) of items to be declared as whitespaces wordchars (str) a list (in string form) of chars which are part of word for the parser. commenters (str) a list of chars used as comenter indicator. quotes (str) a list of chars used as quotes for strings. terminators (str) a list of chars used as terminators for sentences drove 13

18 class drove.util.lexer.lexeritem(*args) drove.util.log The log module provides a helper for logging. class drove.util.log.logger(name= drove.util.log, syslog=false, console=false, logfile=false, logfile_size=0, logfile_keep=0, loglevel= info, encoded_priorities={ daemon : alert }) Bases: logging.logger Create a modular logger for an application. getlogger() method instead. get_syslog_socket() Get the syslog local socket which depends of platform. drove.util.log.getdefaultlogger() Get a default console logger drove.util.log.getlogger(*args, **kwargs) Singleton to get an unique log object across any caller class or thread. Usually you don t want to use this class directly, but use drove.util.network This module contains utilities for manage some networking concepts. Attributes: getfqdn (function): A singleton function which return the current node FQDN. class drove.util.network.nodenamefactory reload() Reload the cached FQDN for this node drove.util.network.parse_addr(spec, defhost=none, defport=none, resolve=true) Parse a host:port specification and return a 2-tuple ( host, port) as understood by the Python socket functions. If resolve is true, then the host in the specification or the defhost may be a domain name, which will be resolved. If resolve is false, then the host must be a numeric IPv4 or IPv6 address. IPv6 addresses must be enclosed in square brackets. Returns tuple (address, port) Raises ValueError if spec is not well formed. >>> parse_addr_spec(" :9999") ( , 9999) If defhost or defport are given, those parts of the specification may be omitted; if so, they will be filled in with defaults. >>> parse_addr_spec( :8888, defhost= ,... defport=9999) ( , 8888) >>> parse_addr_spec( :8888, defhost= , defport=9999) ( , 8888) >>> parse_addr_spec( , defhost= , defport=9999) ( , 9999) >>> parse_addr_spec( :, defhost= , defport=9999) ( , 9999) >>> parse_addr_spec( :, defhost= , defport=9999) ( , 9999) >>> parse_addr_spec(, defhost= , defport=9999) ( , 9999) 14 Chapter 4. Reference

19 drove.util.temp This module provides utilities related with temporary files and directories which are auto-removed drove.util.temp.directory() Create temporary directory and destroy it after use >>> with directory() as d:... # do stuff drove.util.temp.variables(vars) Do something with some variable alterated >>> with variables({"sys.args": []}):... # do stuff drove.util.tester drove.util.tester.run_tests(path) Run tests find in path and return a list of TesterResult objects drove.util.timer This module provides classes and function to run timers. A timer is a periodic exection of a function without any return. class drove.util.timer.timer(interval, fun, *args, **kwargs) run() stop() static wait(number_of_threads, seconds=10) drove.channel This module contain the implementation of temporary cache, used by drove to keep data from readers and dispatch them to writers in a synchronized way. class drove.channel.channel publish(value, topic=none) Send a value to topics value (any) the value to send topic (list) a list with topics ids to send the message or if not present send to all topics. receive(topic) Get messages enqueued for one topic topic (any indexable) the topic to get messages for subscribe(topic) Create a new topic 4.1. drove 15

20 topic (any indexable) the topic id drove.config This module contains classes to parse configuration files and create python dictionary based class to handle it. class drove.config.config(config_file=none) Bases: builtins.dict get(key, default=(none, )) Return a value for a key in the config. If this key is not found and no default value is provided, raises a ConfigError exception. If default value is provided and key not found, the default value is returned. key (str) the key to search in config default (any object) the default value to return in case that key not found in config. get_childs(prefix, expand_childs=false) Get the keys which hirarchically depends of prefix passed by argument. For example: >>> x = Config() >>> x["namespace.key"] = 1 >>> x.get_childs("namespace") == [ namespace ] reload(config_file=none) Reload the config. prefix (str) a string to search keys under that prefix. expand_childs (bool) if true each grandchilds should be threated as childs. config_file if set populate config from this config file. If not use the config defined in constructor. reloadfd(fd, path) Reload the config. fd (file object) A file descriptor to read config from. This function is not designed to be call directly, but use reload() instead. path (str) A path to search relative include files if any. exception drove.config.configerror Bases: builtins.exception Models an exception reading config drove.package This module contains definitions and classes to handle plugin packages. A package is formerly a tarball file which contains a plugin in the normalize plugin packaging format. 16 Chapter 4. Reference

21 A plugin package must contain a folder plugin, with the plugin code inside (which can be a module(s) or other package(s). class drove.package.package(author, plugin, version, install_dir=[]) classmethod from_installed(kls, author, plugin, plugin_dir) classmethod from_tarball(kls, tarball, plugin_dir, upgrade=false) Create a new package from tarball file tarball (str) the filename of the tarball with the plugin plugin_dir (list of str) a list of path to install the tarball upgrade (bool) if true, upgrade the package, otherwise failed if package is already installed. classmethod from_tarballfd(kls, fd, plugin_dir, upgrade=false) classmethod from_url(kls, url, plugin_dir, upgrade=false) is_installed(dirs) Return true if the package is installed in any directory of the dirs list passed as argument. remove() exception drove.package.packageerror Bases: builtins.exception Models an error related with a malformed package drove.plugin This module provide a generic plugin implementation. class drove.plugin.plugin(config, channel) Models a generic plugin to be extended from subclasses. This class provide only a classmethod to dynamically load different plugins. Note: You need to implement the read or the write method for your plugin. These methods are not defined in generic class because if they don t exists, drove will not run any thread to execute it. The read method does not accept parameters, and will return a dictionary with the values readed. Check the cpu plugin for more information. The write method receives a dict as parameter which you need to flush wherever you want. emit(data) Emit some data from reader. data (Value) data to be emitted. classmethod load(plugin_name, config, channel) Class method to load dynamically a plugin drove 17

22 plugin_name (str) the plugin name to load, must be in the plugins directory with proper name (plugin_name plus python extension), and must have a proper named class (the plugin_name in camel case with Plugin suffix. config (Config) a connfig object with all configuration parameters. channel (Channel) a channel to intercommunicate the plugin with others. setup(config) Setup the plugin. This method could be override to do some initialization stuff here. config (Config) the configuration object with all relevant config values. start() Start a plugin to read/write stop() Stop a plugin to read/write exception drove.plugin.pluginerror Bases: builtins.exception Models an error related with plugins. class drove.plugin.pluginmanager(config, channel) loop(num=0, seconds=10) Keep the process in a loop waiting for plugin data. start_all() Start all plugins stop_all() Stop all plugins num (int) the number of plugins to wait for. By default 0 (wait for all). seconds (int) the time to sleep between two consecutives checks of current active plugins. By default drove.reloader This module contains classes and functions to help to reload plugins and configuration files on the fly. class drove.reloader.reloader(elements, interval=20, log=none) reload() Force a reload of the defined elements during reloader initialization. start() Start the reloader thread drove.script This module contains command line endpoints to run the program from shell drove.script.main() Base command line executable. 18 Chapter 4. Reference

23 4.2 drove.command drove.command.daemon class drove.command.daemon.daemoncommand(config, args, log) Bases: drove.command.command execute() drove.command.install class drove.command.install.installcommand(config, args, log) Bases: drove.command.command execute() drove.command.list class drove.command.list.listcommand(config, args, log) Bases: drove.command.command List installed plugins execute() drove.command.remove class drove.command.remove.removecommand(config, args, log) Bases: drove.command.command Remove an installed plugin execute() drove.command.search class drove.command.search.searchcommand(config, args, log) Bases: drove.command.command Search plugins in online repository execute() print_item(item) The generic command module provides a generic way to load specific drove client commands. class drove.command.command(config, args, log) classmethod from_name(name, config, args, log) Instanciate specific command name (str) the name of the command which may match with specific command submodule drove.command 19

24 config (Config) the configuration object for drove args (argparse.namespace) the namespace contains arguments parsed by argparse. log (logging.logger) a logger provided by the application to display messages. exception drove.command.commanderror Bases: builtins.exception Models an error running a client command 4.3 drove.data drove.data.event This module contains classes and definitions related with events. An event is a notification emitted by some plugin to warn about any condition. class drove.data.event.event(plugin, severity, message, nodename=none, timestamp=none) Bases: drove.data.data Models an event for drove nodename (str) the node which generate the value plugin (str) the plugin namespace which generate the value value (float or int) the value number to dispatch value_type (one of VALUE_COUNTER, VALUE_GAUGE or VALUE_TIME) the type of the value timestamp (int) the timestamp when the data is created dump() Return a dump representation of the event class drove.data.event.severity Model the severity of an event. >>> Severity.OKAY == 0 >>> Severity.WARNING == 1 >>> Severity.CRITICAL == 2 >>> Severity.MISSING == 3 CRITICAL = 2 MISSING = 3 OKAY = 0 WARNING = 1 20 Chapter 4. Reference

25 4.3.2 drove.data.value This module contains classes and definitions related with values. A value is a metric which will sent to drove class drove.data.value.value(plugin, value, nodename=none, value_type= g, timestamp=none) Bases: drove.data.data Models a value for drove nodename (str) the node which generate the value plugin (str) the plugin namespace which generate the value value (float or int) the value number to dispatch value_type (one of VALUE_COUNTER, VALUE_GAUGE or VALUE_TIME) the type of the value timestamp (int) the timestamp when the data is created dump() Return a dump representation of the value The data module contains definitions of data used in drove client-server communication class drove.data.data classmethod from_dump(dump_str) Create a Data from a dump representation. The dump representation of drove object contains six fields, separated by pipe. This representation is used to send values and events over the net, and, in general, to serialize metrics and events of any kind. Formerly, the dump representation contains the following fields: Kind Must be V for values or E for events. Nodename Is the node name which generate the data. Plugin Namespace The namespace where the data must be anchor to. For value data, we have: Value The numeric value of the metric. Value Type The type of the metric. Can be g for gauge, c for counter or t for time. For event data, we have: Severity Is an integer which indicate the severity. Lower value implies lower severity. Message Is a descriptive message of the event (human readable), encoded in UTF-8. For both, also have: Timestamp An integer number which represents the UNIX timestamp when the data was generated. is_event() Return true if the data is an Event is_value() Return true if the data is a Value 4.3. drove.data 21

26 4.4 drove.util drove.util.daemon drove.util.daemon.posix Generic linux daemon base class for python 3.x. Most of this module is heavly based on the work of Lone Wolves _ class drove.util.daemon.posix.posixdaemon(handler, exit_handler=none) Bases: drove.util.daemon.daemon foreground() Run the handler in foreground restart() Restart the daemon Return type int Returns The PID of the child process which is running the handler. set_exit_handler(func) Dynamically sets the exit_handler to specified function passed as argument. start() Start the daemon Return type int Returns The PID of the child process which is running the handler. stop() Stop the daemon The data module contains definitions of data used in drove client-server communication class drove.util.daemon.daemon Generic class to model different daemonize implementations. To instance one, please use create() metod. classmethod create(handler, exit_handler=none) Crete a new Daemon object, which is dynamically selected according to running operating system. handler (callable) The handler to call to daemonize the process. exit_handler (callable) The handler to call when exit if any drove.util.importer This module contains classes and methods to import dynamically modules from specified paths. drove.util.importer.load(module, attr_name=none, anchor= drove.util, path=[]) Load a module or an attribute from the specific module. >>> load("sys") >>> load("sys.environ") >>> load(".importer") 22 Chapter 4. Reference

27 module (str) The module name to load attr_name (str) The name of the attribute of the module to load (if any). If not present, returns the module itself. anchor (str) The anchor module to resolve relative module paths. package. path (list) a list with paths to search the module By default uses drove.util.lexer This module provides a basic lexer utility. class drove.util.lexer.lexer(basic_class=<class drove.util.lexer.lexeritem >) additemparser(keyword, item_class=none, ignore_words=[]) Add new item parser in lexer keyword (str) keyword to find for this item parser item_class (class) the class to instanciate for this keyword. parse(text, whitespace= trn, wordchars=., _-:;*><=!, commenters= #, quotes=, terminators=.;, ) Parse a text text (str) the text to be parsed whitespace (str) a list (in string form) of items to be declared as whitespaces wordchars (str) a list (in string form) of chars which are part of word for the parser. commenters (str) a list of chars used as comenter indicator. quotes (str) a list of chars used as quotes for strings. terminators (str) a list of chars used as terminators for sentences. class drove.util.lexer.lexeritem(*args) drove.util.log The log module provides a helper for logging. class drove.util.log.logger(name= drove.util.log, syslog=false, console=false, logfile=false, logfile_size=0, logfile_keep=0, loglevel= info, encoded_priorities={ daemon : alert }) Bases: logging.logger Create a modular logger for an application. getlogger() method instead. get_syslog_socket() Get the syslog local socket which depends of platform. Usually you don t want to use this class directly, but use 4.4. drove.util 23

28 drove.util.log.getdefaultlogger() Get a default console logger drove.util.log.getlogger(*args, **kwargs) Singleton to get an unique log object across any caller class or thread drove.util.network This module contains utilities for manage some networking concepts. Attributes: getfqdn (function): A singleton function which return the current node FQDN. class drove.util.network.nodenamefactory reload() Reload the cached FQDN for this node drove.util.network.parse_addr(spec, defhost=none, defport=none, resolve=true) Parse a host:port specification and return a 2-tuple ( host, port) as understood by the Python socket functions. If resolve is true, then the host in the specification or the defhost may be a domain name, which will be resolved. If resolve is false, then the host must be a numeric IPv4 or IPv6 address. IPv6 addresses must be enclosed in square brackets. Returns tuple (address, port) Raises ValueError if spec is not well formed. >>> parse_addr_spec(" :9999") ( , 9999) If defhost or defport are given, those parts of the specification may be omitted; if so, they will be filled in with defaults. >>> parse_addr_spec( :8888, defhost= ,... defport=9999) ( , 8888) >>> parse_addr_spec( :8888, defhost= , defport=9999) ( , 8888) >>> parse_addr_spec( , defhost= , defport=9999) ( , 9999) >>> parse_addr_spec( :, defhost= , defport=9999) ( , 9999) >>> parse_addr_spec( :, defhost= , defport=9999) ( , 9999) >>> parse_addr_spec(, defhost= , defport=9999) ( , 9999) drove.util.temp This module provides utilities related with temporary files and directories which are auto-removed drove.util.temp.directory() Create temporary directory and destroy it after use >>> with directory() as d:... # do stuff drove.util.temp.variables(vars) Do something with some variable alterated >>> with variables({"sys.args": []}):... # do stuff 24 Chapter 4. Reference

29 4.4.7 drove.util.tester drove.util.tester.run_tests(path) Run tests find in path and return a list of TesterResult objects drove.util.timer This module provides classes and function to run timers. A timer is a periodic exection of a function without any return. class drove.util.timer.timer(interval, fun, *args, **kwargs) run() stop() static wait(number_of_threads, seconds=10) 4.5 drove.util.daemon drove.util.daemon.posix Generic linux daemon base class for python 3.x. Most of this module is heavly based on the work of Lone Wolves _ class drove.util.daemon.posix.posixdaemon(handler, exit_handler=none) Bases: drove.util.daemon.daemon foreground() Run the handler in foreground restart() Restart the daemon Return type int Returns The PID of the child process which is running the handler. set_exit_handler(func) Dynamically sets the exit_handler to specified function passed as argument. start() Start the daemon Return type int Returns The PID of the child process which is running the handler. stop() Stop the daemon The data module contains definitions of data used in drove client-server communication class drove.util.daemon.daemon Generic class to model different daemonize implementations. To instance one, please use create() metod drove.util.daemon 25

30 classmethod create(handler, exit_handler=none) Crete a new Daemon object, which is dynamically selected according to running operating system. handler (callable) The handler to call to daemonize the process. exit_handler (callable) The handler to call when exit if any. 26 Chapter 4. Reference

31 CHAPTER 5 drove drove is a modern monitoring tool which support alerting (with escalation), auto-register nodes, statistics gathering and much more in a few lines of python code. 5.1 Installation The stable releases of drove will be uploaded to PyPi, so you can install and upgrade versions using pip: pip install drove You can use unstable versions at your risk using pip as well: pip install -e git://github.com/droveio/drove By the way: drove works better with python3, but 2.7 is also supported. 5.2 Usage You need to configure drove to enable the features that you like to use. In fact drove act as a producer-consumer daemon, which means that there are read plugins and write plugins. A reader read a metric or an event from somewhere and report it to drove (in a internal cache). A consumer write a metric (taken from the internal cache) in somewhere. Some plugins can act as reader and writer at the same time. By default drove start with a very basic readers configured. To start the daemon just type: drove -c myconfig.conf daemon You can avoid to daemonize with --no-daemon option in the command line. 5.3 Development drove is under heavy development. If you want to contribute, please us the usual github worflow: 1. Clone the repo 27

32 2. Hack! 3. Make a pull-request 4. Merged! If you don t have programming skills, just open a issue in the Github project. 28 Chapter 5. drove

33 CHAPTER 6 Indices and tables genindex modindex search 29

34 30 Chapter 6. Indices and tables

35 Python Module Index d drove, 18 drove.channel, 15 drove.command, 19 drove.command.daemon, 19 drove.command.install, 19 drove.command.list, 19 drove.command.remove, 19 drove.command.search, 19 drove.config, 16 drove.data, 21 drove.data.event, 20 drove.data.value, 21 drove.package, 16 drove.plugin, 17 drove.reloader, 18 drove.script, 18 drove.util, 25 drove.util.daemon, 25 drove.util.daemon.posix, 25 drove.util.importer, 22 drove.util.lexer, 23 drove.util.log, 23 drove.util.network, 24 drove.util.temp, 24 drove.util.tester, 25 drove.util.timer, 25 31

36 32 Python Module Index

37 Index A additemparser() (drove.util.lexer.lexer method), 13, 23 C Channel (class in drove.channel), 15 Command (class in drove.command), 10, 19 CommandError, 10, 20 Config (class in drove.config), 16 ConfigError, 16 create() (drove.util.daemon.daemon class method), 12, 22, 25 CRITICAL (drove.data.event.severity attribute), 11, 20 D Daemon (class in drove.util.daemon), 12, 22, 25 DaemonCommand (class in drove.command.daemon), 9, 19 Data (class in drove.data), 11, 21 directory() (in module drove.util.temp), 15, 24 drove (module), 18 drove.channel (module), 15 drove.command (module), 10, 19 drove.command.daemon (module), 9, 19 drove.command.install (module), 9, 19 drove.command.list (module), 9, 19 drove.command.remove (module), 9, 19 drove.command.search (module), 10, 19 drove.config (module), 16 drove.data (module), 11, 21 drove.data.event (module), 10, 20 drove.data.value (module), 11, 21 drove.package (module), 16 drove.plugin (module), 17 drove.reloader (module), 18 drove.script (module), 18 drove.util (module), 15, 25 drove.util.daemon (module), 12, 22, 25 drove.util.daemon.posix (module), 12, 22, 25 drove.util.importer (module), 13, 22 drove.util.lexer (module), 13, 23 drove.util.log (module), 14, 23 drove.util.network (module), 14, 24 drove.util.temp (module), 15, 24 drove.util.tester (module), 15, 25 drove.util.timer (module), 15, 25 dump() (drove.data.event.event method), 10, 20 dump() (drove.data.value.value method), 11, 21 E emit() (drove.plugin.plugin method), 17 Event (class in drove.data.event), 10, 20 execute() (drove.command.daemon.daemoncommand method), 9, 19 execute() (drove.command.install.installcommand method), 9, 19 execute() (drove.command.list.listcommand method), 9, 19 execute() (drove.command.remove.removecommand method), 9, 19 execute() (drove.command.search.searchcommand method), 10, 19 F foreground() (drove.util.daemon.posix.posixdaemon method), 12, 22, 25 from_dump() (drove.data.data class method), 11, 21 from_installed() (drove.package.package class method), 17 from_name() (drove.command.command class method), 10, 19 from_tarball() (drove.package.package class method), 17 from_tarballfd() (drove.package.package class method), 17 from_url() (drove.package.package class method), 17 G get() (drove.config.config method), 16 get_childs() (drove.config.config method), 16 get_syslog_socket() (drove.util.log.logger method), 14, 23 33

38 getdefaultlogger() (in module drove.util.log), 14, 23 getlogger() (in module drove.util.log), 14, 24 I InstallCommand (class in drove.command.install), 9, 19 is_event() (drove.data.data method), 12, 21 is_installed() (drove.package.package method), 17 is_value() (drove.data.data method), 12, 21 L Lexer (class in drove.util.lexer), 13, 23 LexerItem (class in drove.util.lexer), 13, 23 ListCommand (class in drove.command.list), 9, 19 load() (drove.plugin.plugin class method), 17 load() (in module drove.util.importer), 13, 22 Logger (class in drove.util.log), 14, 23 loop() (drove.plugin.pluginmanager method), 18 M main() (in module drove.script), 18 MISSING (drove.data.event.severity attribute), 11, 20 N NodenameFactory (class in drove.util.network), 14, 24 O OKAY (drove.data.event.severity attribute), 11, 20 P Package (class in drove.package), 17 PackageError, 17 parse() (drove.util.lexer.lexer method), 13, 23 parse_addr() (in module drove.util.network), 14, 24 Plugin (class in drove.plugin), 17 PluginError, 18 PluginManager (class in drove.plugin), 18 PosixDaemon (class in drove.util.daemon.posix), 12, 22, 25 print_item() (drove.command.search.searchcommand method), 10, 19 publish() (drove.channel.channel method), 15 R receive() (drove.channel.channel method), 15 reload() (drove.config.config method), 16 reload() (drove.reloader.reloader method), 18 reload() (drove.util.network.nodenamefactory method), 14, 24 Reloader (class in drove.reloader), 18 reloadfd() (drove.config.config method), 16 remove() (drove.package.package method), 17 RemoveCommand (class in drove.command.remove), 9, 19 restart() (drove.util.daemon.posix.posixdaemon method), 12, 22, 25 run() (drove.util.timer.timer method), 15, 25 run_tests() (in module drove.util.tester), 15, 25 S SearchCommand (class in drove.command.search), 10, 19 set_exit_handler() (drove.util.daemon.posix.posixdaemon method), 12, 22, 25 setup() (drove.plugin.plugin method), 18 Severity (class in drove.data.event), 10, 20 start() (drove.plugin.plugin method), 18 start() (drove.reloader.reloader method), 18 start() (drove.util.daemon.posix.posixdaemon method), 12, 22, 25 start_all() (drove.plugin.pluginmanager method), 18 stop() (drove.plugin.plugin method), 18 stop() (drove.util.daemon.posix.posixdaemon method), 12, 22, 25 stop() (drove.util.timer.timer method), 15, 25 stop_all() (drove.plugin.pluginmanager method), 18 subscribe() (drove.channel.channel method), 15 T Timer (class in drove.util.timer), 15, 25 V Value (class in drove.data.value), 11, 21 variables() (in module drove.util.temp), 15, 24 W wait() (drove.util.timer.timer static method), 15, 25 WARNING (drove.data.event.severity attribute), 11, Index