{"id":19585927,"url":"https://github.com/cacti/plugin_thold","last_synced_at":"2025-04-27T11:35:12.876Z","repository":{"id":36153180,"uuid":"40457216","full_name":"Cacti/plugin_thold","owner":"Cacti","description":"Thold Plugin for Cacti","archived":false,"fork":false,"pushed_at":"2024-04-26T13:15:11.000Z","size":10894,"stargazers_count":60,"open_issues_count":15,"forks_count":61,"subscribers_count":30,"default_branch":"develop","last_synced_at":"2024-05-01T11:00:36.914Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cacti.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-08-10T01:34:38.000Z","updated_at":"2024-06-06T14:23:11.129Z","dependencies_parsed_at":"2024-06-06T14:23:10.255Z","dependency_job_id":"40d17eaf-7e4a-4935-9806-2a3c9cdbc0f2","html_url":"https://github.com/Cacti/plugin_thold","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cacti%2Fplugin_thold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cacti%2Fplugin_thold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cacti%2Fplugin_thold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cacti%2Fplugin_thold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cacti","download_url":"https://codeload.github.com/Cacti/plugin_thold/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224069493,"owners_count":17250456,"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-11T07:57:48.118Z","updated_at":"2024-11-11T07:57:48.605Z","avatar_url":"https://github.com/Cacti.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# thold\n\nThe Cacti thold plugin is designed to be a fault management system driven by\nCacti's Graph information.  It provides the facility to inspect data in a Cacti\nGraph and the underlying RRDfile, and generate alerts for management and\noperations personnel.  It provides Email, Syslog, and SNMP Trap or Inform\nescalations.  In addition, it also can notify personnel of Cacti Device status\nchanges through Email, Syslog, and either SNMP Trap or Inform.\n\nNOTE: The Thold plugin that is in GitHub is ONLY compatible with Cacti 1.0.0 and\nabove!\n\n## Installation\n\nTo install the plugin, simply copy the plugin_thold directory to Cacti's plugins\ndirectory and rename it to simply 'thold'.  Once this is complete, go to Cacti's\nPlugin Management section, and Install and Enable the plugin.  Once this is\ncomplete, you can grant users permission to view and create Thresholds.\n\nOnce you have installed thold, you should verify that Email support is\nfunctioning in Cacti by going to Cacti's Console and under Configuration select\nSettings, and from there the 'Mail/Reporting/DNS'.  From there, you can test\nyour mail settings to validate that users will receive notifications via email.\n\nAfter you have completed that, you should go to the 'Thresholds' Settings tab,\nand become familiar with its settings.  From there, you can provide overall\ncontrol of thold, and set defaults for things like Email bodies, weekend\nexemptions, alert log retention, logging, etc.\n\nAs with much of Cacti, settings should be documented in line with the actual\nsetting.  If you find that any of these settings are ambiguous, please create a\npull request with your proposed changes.\n\n## Usage\n\nThe Cacti 1.0 version of thold is designed to work with Device Templates.\nTherefore, when you configure a Device Template, you can add default Threshold\nTemplates to that Device Template and when a Device in Cacti is created with\nthat Device Template, all the required Thresholds will be created automatically.\nOf course, creating stand-alone Thresholds is still supported.\n\nAlso new in thold version 1.0 is the ability to create multiple Thresholds per\nData Source.  So, you can have a Baseline Threshold say measuring the rate of\nchange of a file system, while at the same having a Hi/Low and Time Based\nthresholds to notify you of free space low type of events.\n\nMost standalone Thresholds are created from the Graph Management interface in\nCacti.  This process starts with first creating a Threshold Template for the\nspecific Graph Template in question, and then from Graph Management selecting\nthe Graphs that you wish to apply this Template to.  Then, from the Cacti\nActions drop down, select 'Create Threshold from Template' and simply select\nyour desired Threshold Template.  Though this method continues to work today, we\nbelieve that with the support of associating Threshold Templates with Device\nTemplates, that this method will become less popular over time.\n\nWhen creating your first Threshold using thold, you need to be first understand\nthe Threshold Type.  They include: High / Low, Time Based, and Baseline\nDeviation.  The High / Low are the easiest to understand.  If the measured value\nfalls either above or below the High / Low values, for the Min Trigger Duration\nspecified in the High / Low section, it will trigger an alert.  In the Time\nBased Threshold type, the measured value must go above or below the High / Low\nvalues so many times in the measurement window, or the 'Time Period Length'.\nLastly, the Baseline Deviation provides a floating window in the 'Time reference\nin the past' to measure change.  If the change in the measured value either goes\nup or down by a certain value in that time period, an alert will be triggered.\n\nThe Re-Alert Cycle is how often you wish to re-inform either via Email, Syslog,\nor SNMP Trap or Inform if the Threshold has not resolved itself before then.\n\nThold has multiple Data Manipulation types, including: Exact Value, CDEF,\nPercentage, and RPN Expression.  The simplest form is the Exact Value data\nmanipulation where thold simply takes the raw value collected from Cacti's Data\nCollector, and applies rules to it.  In the case of COUNTER type data, thold\nwill convert that to a relative value automatically.  The CDEF data manipulation\nallows you to use some, but not all Cacti CDEF's and apply them to Graph Data.\nThe CDEF's that work, have to leverage one or more of the special types included\nin Cacti's CDEF implementation like 'CURRENT_DATASOURCE' to be relative.  The\nPercentage Data Manipulation requires you to select the 'primary' Data Source as\nthe Numerator, and then when selecting 'Percentage', you will be able to select\nthe Denominator of the percentage calculation.  The most involved Data\nManipulation is the RPN Expression type.  This Data Manipulation type allows you\nto use RPN Expressions to determine the value to be evaluated.  It can include\nother Data Sources in the Cacti graph in addition to the selected Data Source.\nIt follows closely RRDtool's RPN logic, and most RRDtool RPN functions are\nsupported.\n\nIf you plan on using the Threshold Daemon to increase the scalability of your\nthresholds, note that you must modify and install the thold_daemon.service file\ninto your systemd configuration, and then start and test the service.  If you\nfail to perform these steps, thold will appear to not work as expected.\n\nLastly, please note that several forks of the thold plugin are available from\ndifferent sources.  These forks of thold are not necessarily compatible with the\ncurrent version of Cacti's thold plugin.  Please be aware of this when\ninstalling thold for the first time.\n\n## Authors\n\nThe thold plugin has been in development for well over a decade with increasing\nfunctionality and stability over that time.  There have been several\ncontributors to thold over the years.  Chief among them are Jimmy Conner, Larry\nAdams, and Andreas Braun.  We hope that version 1.0 and beyond are the most\nstable and robust versions of thold ever published.  We are always looking for\nnew ideas.  So, this won't be the last release of thold, you can rest assured of\nthat.\n\n-----------------------------------------------\nCopyright (c) 2004-2024 - The Cacti Group, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcacti%2Fplugin_thold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcacti%2Fplugin_thold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcacti%2Fplugin_thold/lists"}