Personal tools
Skip to content. | Skip to navigation
Introduction ------------ This package provides munin plugins for monitoring various aspects of a Zope instance. It uses `gocept.munin`_ for plugin registration. Please refer to its documentation if you want to write new plugins. Bits of the code is based on plugins found at `munin exchange`_ (many thanks to Gaute Amundsen and Arthur Lutz). Plugins ------- Currently there are 4 plugins available: * "zopethreads" - reports free Zope threads * "zopecache" - reports database cache parameters * "zodbactivity" - reports ZODB activity * "zopememory" - reports Zope memory usage (only works on Linux) How to use it ------------- * First include the package in your buildout `instance` slot:: [instance] ... eggs = ... munin.zope zcml = ... munin.zope * To create the pluging helper script you'll also need to include the following, additional section and extend your `parts` definition:: [buildout] parts = ... munin [munin] recipe = zc.recipe.egg eggs = munin.zope arguments = http_address='${instance:http-address}', user='${instance:user}' The `arguments` option is used to pass configuration values to the generated helper script, which is then used as the actual munin plugin (see below). Any settings for `ip-address`, `http-address`, `port-base` and `user` given in the `instance` section should be repeated here, separated by commas. .. |---| unicode:: U+2014 .. em dash Please be aware, that the variable names use underscores instead of dashes here |---| the following list shows all supported settings and their respective default values: * ip_address='<ip-address>' ['localhost'] * http_address=<http-address> [8080] * port_base=<port-base> [0] * user=<user-credentials> [n.a.] Either literal values or references to the `instance` part can be used here, i.e. "http_address='${instance:http-address}', user='${instance:user}'". Please note that the resulting line will be verbosely copied into the generated `bin/munin` script, so the extra quoting is required. * When monitoring more than one Zope instance, i.e. in a ZEO setup, separate helper scripts need to be generated. In order to do so the `scripts` option of `zc.recipe.egg` can be used like so:: [buildout] parts = ... munin1 munin2 [munin1] recipe = zc.recipe.egg eggs = munin.zope scripts = munin=munin1 arguments = http_address='${instance1:http-address}', user='${instance1:user}' [munin2] recipe = zc.recipe.egg eggs = munin.zope scripts = munin=munin2 arguments = http_address='${instance2:http-address}', user='${instance2:user}' The necessary symlinks can then be created with each of the scripts in turn (see below). Please note, that in this case you should explicitly provide at least a differing `prefix` argument. * Now you should be able to call the plugins as follow:: http://localhost:8080/@@munin.zope.plugins/zopethreads Where `zopethreads` is you plugin name. Please note that for security reasons the view requires the `View management screens` permission. * Next you need to make symlinks from the helper script inside your buildout's `bin/` to the munin plugin directory. The helper script itself can assist you with this:: $ bin/munin install /opt/munin/etc/plugins [<prefix>] [<suffix>] This will install the necessary symlinks in the given directory using either the provided prefix and suffix or else the hostname and current directory to assemble their names (see below). Alternatively, you may also install the desired symlinks yourself:: $ cd /opt/munin/etc/plugins $ ln -s ~/zope/bin/munin company_zodbactivity_site1 Here `/opt/munin/etc/plugins` is your munin directory, `~/zope/` is the root directory of your buildout, `zodb_activity` the name of the plugin you want to enable, `company` a placeholder for an arbitrary prefix and `site1` the name which will be shown in munin. * Finally configure the plugin in munin (this step can be skipped if you have correctly set up the `arguments` option as described in step 2 above):: $ cd /opt/munin/etc/plugin-conf.d/ $ vi munin.zope.conf ... [company_*_site1] ... env.AUTH myuser:myuser ... env.URL http://localhost:8080/@@munin.zope.plugins/%s Here `myuser:myuser` are your Zope user credentials and `localhost:8080` your site url. Please check `munin`_ for more information about plugin configuration.
Logwatch is a customizable, pluggable log-monitoring system. It will go through your logs for a given period of time and make a report in the areas that you wish with the detail that you wish. Easy to use - works right out of the package on many systems.
A Ruby parser written in pure Ruby.
Sphinx directives for showing license information.
A Sphinx extension for rendering tables written in markdown.
sphinx-math-dollar is a Sphinx extension to let you write LaTeX math using $$.
sphinx-mdinclude Sphinx extension for including or writing pages in Markdown format. sphinx-mdinclude is a simple Sphinx extension that enables including Markdown documents from within reStructuredText. It provides the .. mdinclude:: directive, and automatically converts the content of Markdown documents to reStructuredText format. sphinx-mdinclude is a fork of m2r and m2r2, focused only on providing a Sphinx extension. Features Basic markdown and some extensions (see below) inline/block-level raw html fenced-code block tables footnotes ([^1]) Inline- and Block-level rst markups single- and multi-line directives (.. directive::) inline-roles (:code:`print(1)` ...) ref-link (see `ref`_) footnotes ([#fn]_) math extension inspired by recommonmark Sphinx extension add markdown support for sphinx mdinclude directive to include markdown from md or rst files option to parse relative links into ref and doc directives (md_parse_relative_links) Restrictions In the rst's directive
**Complete documentation**: sphinxcontrib-needs got renamed to sphinx-needs. This affects also the URLs for documentation and repository:* Docs: * Repo: Introduction Sphinx-Needs allows the definition, linking and filtering of class- like need-objects, which are by default:* requirements * specifications * implementations * test cases.This list can be easily customized via configuration (for...
Create a custom 404 page with absolute URLs hardcoded
A sphinx extension for creating document components optimized for HTML+CSS. - The panels directive creates panels of content in a grid layout, utilizing both the Bootstrap 4 grid system, and cards layout. - The link-button directive creates a click-able button, linking to a URL or reference, and can also be used to make an entire panel click-able. - The dropdown directive creates toggle-able content. - The tabbed directive creates tabbed content. - opticon and fa (fontawesome) roles allow for inline icons to be added.