{"id":19871935,"url":"https://github.com/saltstack-formulas/collectd-formula","last_synced_at":"2025-04-05T12:05:45.090Z","repository":{"id":19817134,"uuid":"23077805","full_name":"saltstack-formulas/collectd-formula","owner":"saltstack-formulas","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-06T23:07:32.000Z","size":492,"stargazers_count":20,"open_issues_count":16,"forks_count":85,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-03-29T11:07:45.293Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html","language":"SaltStack","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack-formulas.png","metadata":{"files":{"readme":"docs/README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-08-18T16:09:47.000Z","updated_at":"2022-01-06T08:03:18.000Z","dependencies_parsed_at":"2023-10-03T14:15:37.389Z","dependency_job_id":"9713e768-ed57-4c98-8f06-729ebeddb72d","html_url":"https://github.com/saltstack-formulas/collectd-formula","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fcollectd-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fcollectd-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fcollectd-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fcollectd-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack-formulas","download_url":"https://codeload.github.com/saltstack-formulas/collectd-formula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332604,"owners_count":20921853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T16:14:01.078Z","updated_at":"2025-04-05T12:05:45.062Z","avatar_url":"https://github.com/saltstack-formulas.png","language":"SaltStack","funding_links":[],"categories":[],"sub_categories":[],"readme":"collectd-formula\n================\n\n|img_travis| |docs| |img_sr|\n\n.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/collectd-formula.svg?branch=master\n   :alt: Travis CI Build Status\n   :scale: 100%\n   :target: https://travis-ci.com/saltstack-formulas/collectd-formula\n.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest\n   :alt: Documentation Status\n   :scale: 100%\n   :target: https://collectd-formula.readthedocs.io/en/latest/?badge=latest\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n\nA SaltStack formula that installs and configures collectd. The system statistics collection daemon.\nstart on a new formula and it serves as a style guide.\n\n.. contents:: **Table of Contents**\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nContributing to this repo\n-------------------------\n\n**Commit message formatting is significant!!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\nAvailable states\n----------------\n\n.. contents::\n   :local:\n\n``collectd``\n------------\n\n*Meta-state (This is a state that includes other states)*.\n\nInstalls the collectd package, and starts the associated collectd service.\n\n``collectd.service``\n^^^^^^^^^^^^^^^^^^^^\n\nMetastate used to include service into respective plugin states, included in ``collectd`` state.\n\n``collectd.apache``\n^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the `apache plugin \u003chttps://collectd.org/wiki/index.php/Plugin:Apache\u003e`_.\nAll common parameters are supported, so pass something like ::\n\n    apache:\n      instances:\n        - name: 'human-readable-name'\n          url: 'http://localhost/server-status?auto'\n          user: 'user'\n          pass: 'your-password'\n\nOnly ``name`` and ``url`` are required.\n\n``collectd.bind``\n^^^^^^^^^^^^^^^^^\n\nEnables and configures the bind plugin.\n\n``collectd.dbi``\n^^^^^^^^^^^^^^^^\n\nEnables and configures the dbi plugin. It's used for quering databases with libdbi.\nRefer to `collectd.conf(5) \u003chttps://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_dbi\u003e`_ manpage for details\nand ``pillar.example`` to see how values should be populated.\n\nBeware this plugin may need additional packages installed on your system to run properly.\n\n``collectd.csv``\n^^^^^^^^^^^^^^^^\n\nEnables and configures the csv write plugin.\n\n``collectd.df``\n^^^^^^^^^^^^^^^\n\nEnables and configures the df plugin.\n\n``collectd.disk``\n^^^^^^^^^^^^^^^^^\n\nEnables and configures the disk plugin.\n\n``collectd.elasticsearch``\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the `elasticsearch plugin \u003chttps://github.com/ministryofjustice/elasticsearch-collectd-plugin\u003e`_\n\n``collectd.ethstat``\n^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the ethstat plugin (please note `there is a possible bug in the debian package \u003chttps://bugs.debian.org/cgi-bin/bugreport.cgi?bug=698584\u003e`_).\n\n``collectd.interface``\n^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the interface plugin.\n\n``collectd.java``\n^^^^^^^^^^^^^^^^^\n\nEnables and configures the java plugin. If enabled it will also collect tomcat catalina metrics.\n\nRequires the installation of JDK.\n\nPillar values used under `collectd.plugins.java`, an example ::\n\n\n    collectd:\n      plugins:\n        java:\n          host: localhost\n          port: 39999\n          user: 'someuser' (optional)\n          group: 'someuser' (optional)\n          lib: '/some/file' (optional)\n          tomcat: true (optional)\n\n\n``collectd.logfile``\n^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the logfile plugin.\n\n``collectd.modules``\n^^^^^^^^^^^^^^^^^^^^\n\nThis state helps distributing collectd external modules written in various languages\n(see `python \u003chttps://collectd.org/wiki/index.php/Plugin:Python\u003e`_ or\n`perl \u003chttps://collectd.org/wiki/index.php/Plugin:Perl\u003e`_ for example).\n\nSample usage:\n\n* Include ``collectd.modules`` in your topfile.\n* Create collectd/modules/files folder in your states.\n* Put modules you need in that folder.\n* Modules will be put in ``collectd.moduledirconfig`` folder.\n\n\n``collectd.mysql``\n^^^^^^^^^^^^^^^^^^\n\nEnables and configures the mysql plugin. Needs refinement.\n\n``collectd.network``\n^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the network plugin.\n\n``collectd.ntpd``\n^^^^^^^^^^^^^^^^^\n\nEnables and configures the ntpd plugin.\n\n``collectd.packages``\n^^^^^^^^^^^^^^^^^^^^^\n\nThis state is used to install OS packages collectd plugins depend on.\n\n``collectd.postgresql``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the postgresql plugin. Needs refinement.\n\n``collectd.processes``\n^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the processes plugin\n\n``collectd.protocols``\n^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the protocols plugin\n\n``collectd.powerdns``\n^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the powerdns plugin.\n\n``collectd.rabbitmq``\n^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the rabbitmq plugin.\n\n``collectd.redis``\n^^^^^^^^^^^^^^^^^^\n\nEnables and configures the redis plugin.\n\n``collectd.syslog``\n^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the syslog plugin.\n\n``collectd.tail``\n^^^^^^^^^^^^^^^^^\n\nEnables and configures the tail plugin.\n\n``collectd.tcpconns``\n^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the tcpconns plugin.\n\n``collectd.types``\n^^^^^^^^^^^^^^^^^^\n\nManages a TypesDB file stored at `plugindirconfig`/types.db.\n\n``collectd.curl_json``\n^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the curl_json plugin.\n\n``collectd.curl_xml``\n^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the curl_xml plugin.\n\n``collectd.python``\n^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the python plugin, which allows executiong arbitrary python scripts.\n\n``collectd.vmem``\n^^^^^^^^^^^^^^^^^\n\nEnables and configures the vmem plugin.\n\n``collectd.librato``\n^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures write_http plugin for reporting to Librato\n\n``collectd.zookeeper``\n^^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the zookeeper plugin.\n\n``collectd.unixsock``\n^^^^^^^^^^^^^^^^^^^^^\n\nEnables and configures the unixsock plugin.\n\nUsage\n-----\n\nCustom state file\n^^^^^^^^^^^^^^^^^\n\nCreate a custom state file (for example ``collectd-custom.sls``) that includes the plugins you want and the base state. ::\n\n    include:\n      - collectd\n      - collectd.disk\n      - collectd.syslog\n\nThen in your topfile: ::\n\n    'servername':\n      - collectd-custom\n\nDirectly in topfile\n^^^^^^^^^^^^^^^^^^^\n\nOr if you don't mind having long lists in your topfile, just add whatever plugins you want and the base state. ::\n\n    'servername':\n      - collectd\n      - collectd.disk\n      - collectd.syslog\n\nCombined\n^^^^^^^^\n\nOr you can combine both - default plugins in custom state and specific in topfile. ::\n\n    'apache-server':\n      - collectd-custom\n      - collectd.apache\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fcollectd-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack-formulas%2Fcollectd-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fcollectd-formula/lists"}