Collectd Module for CvmFS
=========================
Configuration
-------------
Example::
TypesDB "/usr/share/collectd/collectd_cvmfs.db"
<Plugin "python">
Import "collectd_cvmfs"
<Module "collectd_cvmfs">
Repo "alice.cern.ch" "atlas.cern.ch"
Repo "ams.cern.ch"
MountTime True
MountTimeout 10
Memory True
Attribute ndownload nioerr
Attribute usedfd
Verbose False
Interval "300"
</Module>
</Plugin>
* ``TypesDB``: types used by the plugin and shipped with the package.
* ``Repo``: cvmfs repository to monitor.
* ``MountTime``: boolean value to specify whether mount time should be reported or not.
* ``MountTimeout``: timeout in seconds while trying to mount the repositories.
* ``Memory``: boolean value to specify whether the memory footprint should be reported or not.
* ``Attribute``: attribute to monitor on the given repositories. You can get the list from of valid attributes from the type db in ``resources/collectd_cvmfs.db``.
* ``Interval``: interval in seconds to probe the CVMFS repositories.
* ``Verbose``: boolean value to produce logs more verbosed in collectd. It is false by default.
The plugin allows multiple instances for different configurations. This allows probing different repos at different intervals or probing different attributes depending on the repository.
Metrics
-------
The metrics are published in the following structure::
Plugin: cvmfs
PluginInstance: <repo>
Type: {<Attribute>|MountTime|Memory|Mountok}
# Only with Memory:
TypeInstance: [rss|vms]
Example::
lxplus123.cern.ch/cvmfs-lhcb.cern.ch/mounttime values=[0.000999927520751953]
lxplus123.cern.ch/cvmfs-lhcb.cern.ch/nioerr values=[0]
lxplus123.cern.ch/cvmfs-lhcb.cern.ch/memory-rss values=[31760384]
lxplus123.cern.ch/cvmfs-repo.domain.ch/mountok values=[1]
News
====
1.3.4
* Release date: 7-Feb-2025
* Continue with the next available repo if issue with current
1.3.3
* Release date: 15-Apr-2021
* Fix psutil call for read memory metrics #17
1.3.0
* Release date: 8-Jul-2020
* Success of mount now confirmed checking attribute fqrn
* Pip requirements corrected to require pyxattr and not xattr
1.2.0
* Release date: 25-Jul-2019
* New metric MountOK with value 0 (no) 1 (yes)
* Mounts now use scandir to avoid hanging.
1.1.0
-----
* Release date: 13-May-2019
* remove memory type definition
1.0.3
-----
* Release date: 18-Oct-2017
* Make collectd aware of explicit interval so
that it does not flush the value to soon.
* Documentation about TypesDB file.
1.0.2
-----
* Release date: 25-May-2017
* Correct name of type database.
1.0.1
-----
* Release date: 25-May-2017
* First release
Raw data
{
"_id": null,
"home_page": "https://github.com/cvmfs/collectd-cvmfs",
"name": "collectd-cvmfs",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "collectd cvmfs monitoring",
"author": "Luis Fenandez Alvarez",
"author_email": "luis.fernandez.alvarez@cern.ch",
"download_url": "https://files.pythonhosted.org/packages/2a/7a/2de313ff9205be87e3cbbf31f0ff223146606cf80d6e67710b42252f73f5/collectd_cvmfs-1.3.4.tar.gz",
"platform": null,
"description": "Collectd Module for CvmFS\n=========================\n\nConfiguration\n-------------\n\nExample::\n\n TypesDB \"/usr/share/collectd/collectd_cvmfs.db\"\n <Plugin \"python\">\n Import \"collectd_cvmfs\"\n <Module \"collectd_cvmfs\">\n Repo \"alice.cern.ch\" \"atlas.cern.ch\"\n Repo \"ams.cern.ch\"\n MountTime True\n MountTimeout 10\n Memory True\n Attribute ndownload nioerr\n Attribute usedfd\n Verbose False\n Interval \"300\"\n </Module>\n </Plugin>\n\n* ``TypesDB``: types used by the plugin and shipped with the package.\n* ``Repo``: cvmfs repository to monitor.\n* ``MountTime``: boolean value to specify whether mount time should be reported or not.\n* ``MountTimeout``: timeout in seconds while trying to mount the repositories.\n* ``Memory``: boolean value to specify whether the memory footprint should be reported or not.\n* ``Attribute``: attribute to monitor on the given repositories. You can get the list from of valid attributes from the type db in ``resources/collectd_cvmfs.db``.\n* ``Interval``: interval in seconds to probe the CVMFS repositories.\n* ``Verbose``: boolean value to produce logs more verbosed in collectd. It is false by default.\n\nThe plugin allows multiple instances for different configurations. This allows probing different repos at different intervals or probing different attributes depending on the repository.\n\nMetrics\n-------\n\nThe metrics are published in the following structure::\n\n Plugin: cvmfs\n PluginInstance: <repo>\n Type: {<Attribute>|MountTime|Memory|Mountok}\n\n # Only with Memory:\n TypeInstance: [rss|vms]\n\nExample::\n\n lxplus123.cern.ch/cvmfs-lhcb.cern.ch/mounttime values=[0.000999927520751953]\n lxplus123.cern.ch/cvmfs-lhcb.cern.ch/nioerr values=[0]\n lxplus123.cern.ch/cvmfs-lhcb.cern.ch/memory-rss values=[31760384]\n lxplus123.cern.ch/cvmfs-repo.domain.ch/mountok values=[1]\n\n\nNews\n====\n1.3.4\n* Release date: 7-Feb-2025\n* Continue with the next available repo if issue with current\n\n1.3.3\n* Release date: 15-Apr-2021\n* Fix psutil call for read memory metrics #17\n1.3.0\n* Release date: 8-Jul-2020\n* Success of mount now confirmed checking attribute fqrn\n* Pip requirements corrected to require pyxattr and not xattr\n\n1.2.0\n* Release date: 25-Jul-2019\n* New metric MountOK with value 0 (no) 1 (yes)\n* Mounts now use scandir to avoid hanging.\n\n1.1.0\n-----\n* Release date: 13-May-2019\n* remove memory type definition\n\n1.0.3\n-----\n\n* Release date: 18-Oct-2017\n* Make collectd aware of explicit interval so\n that it does not flush the value to soon.\n* Documentation about TypesDB file.\n\n1.0.2\n-----\n\n* Release date: 25-May-2017\n* Correct name of type database.\n\n1.0.1\n-----\n\n* Release date: 25-May-2017\n* First release\n\n\n",
"bugtrack_url": null,
"license": "Apache II",
"summary": "Collectd Plugin to Monitor CvmFS Clients",
"version": "1.3.4",
"project_urls": {
"Homepage": "https://github.com/cvmfs/collectd-cvmfs"
},
"split_keywords": [
"collectd",
"cvmfs",
"monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de624d131caaab152d1b26f71429be05d00ae6e14d3271430587d00ea1675245",
"md5": "61062136457222289c008b75a0ea73f8",
"sha256": "31073832cca26c0f088c07a5b49d9d34e0f1f703e403e696945c8626cbff40b9"
},
"downloads": -1,
"filename": "collectd_cvmfs-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61062136457222289c008b75a0ea73f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9348,
"upload_time": "2025-02-07T13:19:36",
"upload_time_iso_8601": "2025-02-07T13:19:36.929023Z",
"url": "https://files.pythonhosted.org/packages/de/62/4d131caaab152d1b26f71429be05d00ae6e14d3271430587d00ea1675245/collectd_cvmfs-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a7a2de313ff9205be87e3cbbf31f0ff223146606cf80d6e67710b42252f73f5",
"md5": "431b8664e391e67e8c5ce1446485526a",
"sha256": "2d6ac53a37f5efee30ed41925ae797780be7f7bb86c7fd7c3a45e7278dfd9a86"
},
"downloads": -1,
"filename": "collectd_cvmfs-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "431b8664e391e67e8c5ce1446485526a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10461,
"upload_time": "2025-02-07T13:19:38",
"upload_time_iso_8601": "2025-02-07T13:19:38.250693Z",
"url": "https://files.pythonhosted.org/packages/2a/7a/2de313ff9205be87e3cbbf31f0ff223146606cf80d6e67710b42252f73f5/collectd_cvmfs-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 13:19:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cvmfs",
"github_project": "collectd-cvmfs",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "collectd-cvmfs"
}
JSON
