diff --git a/CHANGELOG.md b/CHANGELOG.md index 18246b42..fa1d1229 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,12 @@ ## ChangeLog +[All published release notes](https://github.com/Cacti/plugin_syslog/blob/develop/docs/RELEASE_HISTORY.md) + +[Version 5.0 release notes and upgrade guidance](https://github.com/Cacti/plugin_syslog/blob/develop/docs/RELEASE_NOTES_5.0.md) · [Contributors and change history](https://github.com/Cacti/plugin_syslog/blob/develop/docs/COMMITS_5.0.md) + --- develop --- +* docs: Refresh README release/source compatibility, installation guidance and source-checked behavior; add published release notes and 5.0 upgrade guidance * bug: Keep log column resizing within the results area on both log tabs, preserve message ellipsis, and use an accessible Font Awesome export button * feature: Standardize both schema and partition CLI help with Cacti-style version banners and options, separate maintenance warnings, and replace the unreleased millisecond converter with --convert-ms * feature: Add a data-preserving partition rebuild CLI with optional --convert-ms, verified 10,000-row copies, interrupted-copy recovery, and database-size, extra-disk-space and several-hour maintenance warnings diff --git a/README.md b/README.md index a1ab9d82..cd9ff206 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,8 @@ # syslog -The syslog plugin is a Cacti plugin that has been around for more than a decade. -It was inspired by the 'aloe' and 'h.aloe' plugins originally developed by the -Cacti users sidewinder and Harlequin in the early 2000's. As you will be able -to see from the ChangeLog, it has undergone several changes throughout the -years, and remains, even today when you have enterprise offering from both -Elastic and Splunk, remains a relevant plugin for small to medium sized -companies. - -It provides a simple Syslog event search an Alert generation and notification -interface that can generate both HTML and SMS messages for operations personnel -who wish to receive notifications inside of a data or network operations center. - -When combined by the Linux SNMPTT package, it can be converted into an SNMP Trap -and Inform receiver and notification engine as the SNMPTT tool will receive SNMP -Traps and Informs and convert them into Syslog messages on your log server. -These syslog messages can then be consumed by the syslog plugin. So, this tool -is quite handy. +Syslog collects and searches log messages inside Cacti, applies alert and removal +rules, and sends notifications or runs configured commands when rules match. +It can also consume SNMP traps and informs forwarded as Syslog messages by SNMPTT. Incoming program names have leading and trailing parentheses and square brackets removed before reference lookup and rule processing. Interior punctuation is @@ -42,6 +28,30 @@ without scanning or updating historical message rows. Existing historical flags are not converted into active breaches. See [threshold recovery](docs/THRESHOLD_RECOVERY.md) for lifecycle and deployment details. +## Versions and compatibility + +This README describes the `develop` source branch. + +| Code | Plugin version | Minimum Cacti declared in `INFO` | +| --- | --- | --- | +| [Source branch](https://github.com/Cacti/plugin_syslog/blob/develop/INFO) | 5.0 | 1.2.23 | +| [Published v4.2](https://github.com/Cacti/plugin_syslog/releases/tag/v4.2) | 4.2 | 1.2.23 | + +Use the published release’s assets and tagged documentation when installing that +package. Branch code can include later changes, even when its version number +matches the release. Cacti’s own PHP and database requirements also apply. + +Install this plugin in **`/plugins/syslog`**, using the directory +name `syslog` rather than `plugin_syslog`. + +See [CHANGELOG.md](https://github.com/Cacti/plugin_syslog/blob/develop/CHANGELOG.md) for the version history. + +[All published release notes](https://github.com/Cacti/plugin_syslog/blob/develop/docs/RELEASE_HISTORY.md) + +[Version 5.0 release notes and upgrade guidance](https://github.com/Cacti/plugin_syslog/blob/develop/docs/RELEASE_NOTES_5.0.md) · [Contributors and change history](https://github.com/Cacti/plugin_syslog/blob/develop/docs/COMMITS_5.0.md) + +[Setup module ownership](https://github.com/Cacti/plugin_syslog/blob/develop/docs/setup-modules.md) describes how `setup.php` and the `includes/` modules divide the plugin code. + ## Core Features * Message filtering @@ -337,10 +347,11 @@ item yet. The plugin declares `compat = 1.2.23` in `INFO`, so it needs Cacti 1.2.23 or later, and PHP 8.0 or later. Every non-test PHP file passes `php -l` on PHP 8.0 -and 8.1. The Linux integration workflow runs PHP 8.2, 8.3, and 8.4 against the -Cacti `1.2.x` branch on MariaDB 11.8, including installation, plugin enablement, -polling, and sample Syslog processing. Other PHP, Cacti, and database versions -are not exercised by CI. +and 8.1. The [Linux integration workflow](https://github.com/Cacti/plugin_syslog/blob/develop/.github/workflows/plugin-ci-workflow.yml) +runs PHP 8.2 through 8.5 against Cacti `1.2.x` on MariaDB 11.8, including +installation, plugin enablement, polling, and sample Syslog processing. PHP 8.6 +is a non-blocking experimental job. Use the PHP version required by your Cacti +release even when the plugin's syntax supports an older interpreter. This plugin does not ship its own `composer.json`. Composer validation and dependency installation in CI use the manifest supplied by the checked-out @@ -416,8 +427,8 @@ run against Cacti's own Composer-managed vendor tree, plus a disposable Docker/Playwright end-to-end harness. GitHub CI runs a single integration-test workflow that checks out the Cacti `1.2.x` branch, runs the Pest suite, the regression scripts, and the changed-line coverage check, and exercises the -syslog poller end-to-end on the PHP 8.2-8.4 matrix on Linux. The -Docker E2E runner refuses unsafe temporary-directory paths before performing +syslog poller end-to-end on Linux. PHP 8.2 through 8.5 are the regular matrix; +PHP 8.6 is experimental. The Docker E2E runner refuses unsafe temporary-directory paths before performing recursive cleanup. ## Installation @@ -451,10 +462,11 @@ Upgrade Advisor when it finds existing syslog tables. Its upgrade type is change how a legacy non-partitioned `syslog` table is converted. An existing partitioned install keeps its messages, rules, and hosts with each choice. -Note: You must rename config.php.dist in the syslog plugin directory to -config.php and make changes there for the location of the database, user, -password, and host. This is especially important if you are using a remote -logging database server. +Before installing, copy `config.php.dist` to `config.php` and configure the +database connection. Preserve this file during upgrades. A collector with an +independent Syslog database uses `config_local.php.dist` as the template for +`config_local.php`; when both configuration files exist, `config_local.php` +takes precedence. To upgrade an existing install, replacing the files is not enough: follow [Important: Upgrading the Plugin](#important-upgrading-the-plugin), which @@ -529,40 +541,24 @@ $template cacti_syslog,"INSERT INTO syslog_incoming(facility_id, priority_id, pr *.* >localhost,my_database,my_user,my_password;cacti_syslog ``` -For version below 2.0 it should be: - -```console -$ModLoad imudp -$UDPServerRun 514 -$ModLoad ommysql - -$template cacti_syslog,"INSERT INTO syslog_incoming(facility_id, priority_id, program, logtime, host, message) -values (%syslogfacility%, %syslogpriority%, '%programname%', '%timegenerated:::date-mysql%', '%HOSTNAME%', TRIM('%msg%'))", SQL +The template above targets the current `logtime` schema. Examples for +pre-2.5 releases used a different incoming schema and must not be copied into a +current install. See the README at the matching tag for a legacy migration. -. >localhost,my_database,my_user,my_password;cacti_syslog -``` - -For version 2.4 and above it should be: +Install your distribution's rsyslog MySQL output module, replace the database +and credential placeholders, then validate and restart rsyslog: ```console -module(load="ommysql") -action(type="ommysql" server="localhost" serverport="3306" -db="syslogDB" uid="userID" pwd="passwdID") - -$template cacti_syslog,"INSERT INTO syslog_incoming(facility_id, priority_id, program, logtime, host, message) -values (%syslogfacility%, %syslogpriority%, '%programname%', '%timegenerated:::date-mysql%', '%HOSTNAME%', TRIM('%msg%'))", SQL -``` - -For CentOS/RHEL systems you will all need to install the rsyslog-mysql package - -``` -yum install rsyslog-mysql +rsyslogd -N1 systemctl restart rsyslog ``` -If you are upgrading to version 2.5 from an earlier version, make sure that you -update this template format and restart rsyslog. You may loose some syslog -data, but doing this in a timely fashion, will minimize data loss. +Do not load a module or listener twice if another configuration file already +loads it. A modern `ommysql` action must explicitly select the Cacti template; +its default template does not target `syslog_incoming`. See the +[rsyslog module reference](https://docs.rsyslog.com/doc/configuration/modules/ommysql.html) +for current configuration options. Protect the configuration file because it +contains database credentials. Senders that only have an IPv6 address are supported. With hostname resolution enabled the plugin accepts an IPv4 or IPv6 address as it is, and stores an IPv6 @@ -574,7 +570,7 @@ address. Ensure you restart rsyslog after these changes are completed. Other logging servers such as Syslog-NG are also supported with this plugin. Please see some additional documentation here: [Cacti Documentation -Site](https://docs.cacti.net/plugin:syslog.config) +Site](https://github.com/Cacti/documentation/blob/develop/Plugin-Syslog.md) We are using the pure integer values that rsyslog provides to both the priority and facility in this version syslog, which makes the data collection must less @@ -585,35 +581,25 @@ To setup log forwarding from your network switches and routers, and from your various Linux, UNIX, and other operating system devices, please see their respective documentation. -Finally, it's important, especially in more recent versions of MySQL and MariaDB -to set a correct SQL Mode. These more recent SQL's prevent certain previously -allowable syntax such as an empty data and certain group by limitations in the -SQL itself. Therefore, you need to ensure that the SQL mode of the database is -correct. To do this, first start by editing either `/etc/my.cnf` or -`/etc/my.cnf.d/server.cnf` and inserting the SQL mode variable into the database -configuration. For example: - -```ini -[mysqld] -sql_mode=NO_ENGINE_SUBSTITUTION,NO_AUTO_CREATE_USER -``` +### Database SQL mode and grouping -### Special Note for the Grouping feature -Syslog now supports the ability to group similar messages from a specific host together -for easy summarization for larger systems you may need to expand the default mariadb group_concat_max_len -The default is 1MB you may need to raise it much higher depending on your needs - -After this change, you should log into the mysql server and run the following -command: +Older instructions set `sql_mode=NO_ENGINE_SUBSTITUTION,NO_AUTO_CREATE_USER`. +Do not copy that setting into a current MySQL configuration: +[MySQL removed `NO_AUTO_CREATE_USER` in 8.0](https://dev.mysql.com/doc/refman/8.0/en/upgrading-from-previous-series.html). +Inspect the actual modes when diagnosing a schema or migration failure: -```console -mysql> show global variables like 'sql_mode'; +```sql +SELECT @@GLOBAL.sql_mode, @@SESSION.sql_mode; ``` -And ensure that it matches the setting that you placed in the database -configuration. If it does not, please search for the configuration that is -making this SQL mode other than what you required. More recent versions of -MySQL and MariaDB will source multiple database configuration files. +Follow the migration guidance for your database and plugin release rather than +changing the server-wide modes for all applications. + +### Special Note for the Grouping feature + +Syslog can group similar messages from a host. For large groups, inspect +`group_concat_max_len` and raise it only as required by the query output and +available memory; its default depends on the database product and version. ## Tables diff --git a/docs/COMMITS_5.0.md b/docs/COMMITS_5.0.md new file mode 100644 index 00000000..63040ecf --- /dev/null +++ b/docs/COMMITS_5.0.md @@ -0,0 +1,25 @@ +# Syslog 5.0 contributors and change history + +[Release notes](RELEASE_NOTES_5.0.md) · [Compare changes](https://github.com/Cacti/plugin_syslog/compare/v4.2...2489d3d73555ac8b914e5768da55f1f15621b97c) + +Unreleased snapshot: `v4.2..2489d3d73555ac8b914e5768da55f1f15621b97c`. Refresh this comparison before publishing 5.0. + +## Contributors + +Thank you to the contributors whose work is recorded in this range: + +[@aqr199](https://github.com/aqr199), [@arno-st](https://github.com/arno-st), [@bmfmancini](https://github.com/bmfmancini), [@cigamit](https://github.com/cigamit), [@EkaterinePapava](https://github.com/EkaterinePapava), [@hljtql](https://github.com/hljtql), [@ka1lie](https://github.com/ka1lie), [@Linegod](https://github.com/Linegod), [@mixneko](https://github.com/mixneko), [@nakayama1869](https://github.com/nakayama1869), [@somethingwithproof](https://github.com/somethingwithproof), [@TheWitness](https://github.com/TheWitness), [@weblate](https://github.com/weblate), [@xmacan](https://github.com/xmacan), [@yeager](https://github.com/yeager). + +Additional recorded author names are retained in the complete comparison when GitHub does not associate them with an account. + +[Browse the paginated commit history](https://github.com/Cacti/plugin_syslog/commits/2489d3d73555ac8b914e5768da55f1f15621b97c). +Commit pages retain the original author and co-author records, including merge, +translation and automation history. + +## Selected changes + +- [3776f9e8af](https://github.com/Cacti/plugin_syslog/commit/3776f9e8af90010fbefdc65d25dbb1df99731d39) Add dashboards for log investigations; by [@bmfmancini](https://github.com/bmfmancini). +- [c9614425c9](https://github.com/Cacti/plugin_syslog/commit/c9614425c9d39a6aede9641cd26858b9c5151854) Add parallel Syslog processing; by [@bmfmancini](https://github.com/bmfmancini). +- [c21ebb8d3a](https://github.com/Cacti/plugin_syslog/commit/c21ebb8d3aa9c0fab930f605ab6ab42db48a8c29) Share dashboard card controls with the Status view; by [@TheWitness](https://github.com/TheWitness). + +Use the comparison and paginated history to inspect other changes and original attribution. diff --git a/docs/RELEASE_HISTORY.md b/docs/RELEASE_HISTORY.md new file mode 100644 index 00000000..f5880c54 --- /dev/null +++ b/docs/RELEASE_HISTORY.md @@ -0,0 +1,18 @@ +# Syslog release history + +Release notes for every published GitHub release, with version-specific highlights, compatibility requirements, upgrade checks and linked contributor credits. Historical notes preserve the original detailed announcements. + +The [5.0 development notes](RELEASE_NOTES_5.0.md) describe an unreleased version and are separate from this published-release history. + +- [v4.2](RELEASE_NOTES_4.2.md) +- [v4.1](releases/v4.1.md) +- [v3.1](releases/v3.1.md) +- [v3.0](releases/v3.0.md) +- [v2.9](releases/v2.9.md) +- [v2.8](releases/v2.8.md) +- [v2.7](releases/v2.7.md) +- [v2.6](releases/v2.6.md) +- [v2.5](releases/v2.5.md) +- [2.3](releases/2.3.md) +- [v2.2](releases/v2.2.md) +- [v2.1](releases/v2.1.md) diff --git a/docs/RELEASE_NOTES_4.2.md b/docs/RELEASE_NOTES_4.2.md new file mode 100644 index 00000000..b7c5771f --- /dev/null +++ b/docs/RELEASE_NOTES_4.2.md @@ -0,0 +1,51 @@ +# Syslog 4.2: fixes for rule editing, filtering and message cleanup + +Syslog 4.2 is a maintenance release focused on everyday log management: creating +program-based alerts, finding devices in the filter, and removing messages. It +also includes PHP 8.2 deprecation fixes and updated rsyslog configuration guidance. + +## What changes for operators + +- **Program-based alerts:** fixes an error when creating an alert rule based on + a program name ([#220](https://github.com/Cacti/plugin_syslog/issues/220)). +- **Removal expressions:** fixes matching against the `program` column and SQL + errors in removal rules ([#184](https://github.com/Cacti/plugin_syslog/issues/184), + [#217](https://github.com/Cacti/plugin_syslog/issues/217)). +- **Message deletion:** fixes SQL errors when deleting messages + ([#218](https://github.com/Cacti/plugin_syslog/issues/218)). +- **Device filtering:** restores devices missing from the Device Filter + ([#211](https://github.com/Cacti/plugin_syslog/issues/211)). +- **Deployment fixes:** addresses an `escapeshellarg()` ValueError and PHP 8.2 + deprecation messages, and corrects the rsyslog configuration documentation + ([#208](https://github.com/Cacti/plugin_syslog/issues/208), + [#216](https://github.com/Cacti/plugin_syslog/issues/216), + [#222](https://github.com/Cacti/plugin_syslog/issues/222)). + +## Upgrade and verify + +The release declares **Cacti 1.2.23 or later** in its plugin metadata. Back up the +Syslog database, plugin files and local database configuration before replacing +the plugin files. Use the Cacti Plugin Management upgrade path and the +[version 4.2 documentation](https://github.com/Cacti/plugin_syslog/blob/v4.2/README.md#installation) +for the installed version; retain the local database configuration. + +After upgrading, confirm that a known message from your normal forwarder reaches +the viewer, that the Device Filter lists the expected devices, and that existing +program-based alert/removal rules handle controlled test messages as intended. +Check the Cacti/PHP logs for SQL and runtime errors. If rollback is necessary, +restore matching plugin files and the database from the pre-upgrade backup. + +## Contributors and full history + +Thank you to the community members who developed, translated, tested and reviewed +this maintenance release. Contributors recorded between v4.1 and v4.2 include: + +[@arno-st](https://github.com/arno-st), [@bmfmancini](https://github.com/bmfmancini), [@click0](https://github.com/click0), [@Coool](https://github.com/Coool), [@edewillians10](https://github.com/edewillians10), [@Harry-Junhua-Huang](https://github.com/Harry-Junhua-Huang), [@ka1lie](https://github.com/ka1lie), [@Linegod](https://github.com/Linegod), [@netniV](https://github.com/netniV), [@TheWitness](https://github.com/TheWitness), [@weblate](https://github.com/weblate), [@xmacan](https://github.com/xmacan), [@xubowin](https://github.com/xubowin), [@zersh01](https://github.com/zersh01). + +The history also records contributions under Edwin Lankamp. Unlinked names are kept as recorded; no account is guessed. + +[Full changelog](https://github.com/Cacti/plugin_syslog/blob/v4.2/CHANGELOG.md) · +[All commits and original author links](https://github.com/Cacti/plugin_syslog/compare/v4.1...v4.2) + +The separate 5.0 development notes describe an unreleased version; dashboards, +saved searches and other 5.0 features are not part of this 4.2 package. diff --git a/docs/RELEASE_NOTES_5.0.md b/docs/RELEASE_NOTES_5.0.md new file mode 100644 index 00000000..b516b9f1 --- /dev/null +++ b/docs/RELEASE_NOTES_5.0.md @@ -0,0 +1,102 @@ +# Syslog 5.0: reusable investigations and clearer collector health + +**Unreleased.** These notes describe the 5.0 changes on `develop`; the latest +published GitHub release is [4.2](https://github.com/Cacti/plugin_syslog/releases/tag/v4.2). + +Syslog 5.0 brings saved searches, shared dashboards and grouped messages to +everyday log investigation. Preview alert and removal rules against queued +messages, view explanations for recognized message identifiers, and monitor +collection backlogs and processing delays from the Status page. + +## Highlights + +- **Reuse and share investigations.** Save named searches, collapse repeated + messages into groups with occurrence counts, and build dashboards with time + series and breakdown charts. Share searches and dashboards through the + corresponding permission realms; recipients can make their own dashboard copy. +- **Preview a rule before enabling it.** The **Test rule** action returns a + matching count and bounded message sample without saving the rule or performing + its actions. It searches queued incoming messages, so an empty preview does not + mean previously archived logs contain no matches. +- **See when collection needs attention.** Collector health shows the incoming + backlog, oldest queued message, last received log and recent processing count. + Phase timings and worker activity help locate delays; optional pipeline health + notifications report problems and recovery. Complete Cacti or database outages + still need external monitoring. +- **Give operators more context and control.** Recognized message identifiers can + show an explanation and recommended action. Device Alert Rules support alert + pauses and priority exceptions, while threshold alerts support recovery commands + and the documented quiet-period recovery lifecycle. +- **Support remote collection and recovery.** Configured remote collectors keep + processed events in a durable delivery queue through outages and retry delivery + to the main collector. Parallel processing is configurable; partition recovery + is bounded and reports blocked maintenance instead of silently pruning history. + +The release also includes theme and message-readability improvements, security +hardening and fixes for installations using a separate Syslog database. See the +[full changelog](../CHANGELOG.md) for individual changes. + +## Try the investigation workflow + +For example, filter recurring interface-down messages, save the conditions, add a +chart based on that search and share the dashboard with the operations team. +Before enabling a new alert, use **Test rule** to inspect matching queued messages. +An empty queue preview does not search previously archived history. + +![Syslog saved-search sharing and queued-rule preview workflows](images/release-workflow-5.0.svg) + +## Upgrade decision guide + +| Check | What to plan | +| --- | --- | +| Release status | 5.0 is unreleased. This page describes a fixed development snapshot, not the published 4.2 package. | +| Runtime | The documented floor is Cacti 1.2.23+ and PHP 8.0+; Cacti may require a newer PHP version. See the linked CI baseline. | +| Storage | InnoDB, or Aria on MariaDB; Remote Data Collector options require InnoDB. Existing traditional tables remain usable with a migration notice. | +| Ordinary upgrade | Preserve the database and local config. Existing timestamp precision stays unchanged. | +| Legacy table conversion | Review the Upgrade Advisor mode. For a legacy non-partitioned table, **Truncate Syslog Table** discards messages; existing partitioned installs retain their data with each advisor choice. | +| Optional timestamp conversion | MariaDB only. The CLI millisecond conversion deletes stored messages from three log tables; it is not needed for the new interface features. | + +### Upgrade and verify before deployment + +1. Back up the Syslog database and plugin/local configuration files together. + Check the [runtime and test baseline](../README.md#runtime-and-test-baseline). +2. Follow the [upgrade instructions](../README.md#installation) and review the + Upgrade Advisor choice before confirming it. Use a maintenance window for + any table conversion; duration depends on the data and selected conversion. +3. Run the read-only schema audit from the Cacti directory: + + ```sh + php plugins/syslog/cli/syslog_schema.php --audit + ``` + +4. Confirm incoming messages reach the viewer, the processing backlog drains, + and the Status page shows recent processing. Check each enabled remote + collector as well as the main collector. +5. Test a representative saved search and queued-rule preview, review sharing + realms, and confirm existing notifications still reach their intended recipients. + +Also review [storage support](../README.md#table-architecture-and-storage-engine-support), +[threshold recovery](THRESHOLD_RECOVERY.md), and alert command paths. Command +templates now need absolute executable paths; the `/bin/sh` fallback is removed. +The Statistics tab and its collection are deprecated. + +### Optional millisecond conversion: stored messages are deleted + +`cli/updatedb_convert_ms.php` is MariaDB-only and truncates `syslog`, +`syslog_incoming` and `syslog_removed`. Rules and settings are preserved and the +remote-delivery outbox is widened in place. Back up first and read the +[conversion instructions](../README.md#converting-an-existing-mariadb-install). +Normal upgrades never run this conversion automatically. + +If rollback is needed, restore plugin files and the database from the same +pre-upgrade backup; do not assume a binary-only downgrade reverses migrations. +Rehearse the checklist against a copy of your production configuration before +rollout. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who kept this +plugin moving forward. See the [linked contributor credits and selected commits](COMMITS_5.0.md). +Those links include the comparison, paginated history and original author records. + +Development snapshot: [`2489d3d735`](https://github.com/Cacti/plugin_syslog/commit/2489d3d73555ac8b914e5768da55f1f15621b97c). Refresh and validate these notes when 5.0 is finalized. diff --git a/docs/images/release-workflow-5.0.svg b/docs/images/release-workflow-5.0.svg new file mode 100644 index 00000000..35f08030 --- /dev/null +++ b/docs/images/release-workflow-5.0.svg @@ -0,0 +1,41 @@ + +Syslog 5.0: repeatable investigation +Workflow illustration for the unreleased 5.0 changes; this is not a product screenshot. + + +Syslog 5.0: repeatable investigation +Workflow illustration for the unreleased 5.0 changes; this is not a product screenshot. +Investigate archived messages + +1. Filter messages +Find a useful investigation + + +2. Save the search +Reuse its conditions + + +3. Build a dashboard +Chart the saved search + + +4. Share with the team +Review sharing permissions +Validate a rule before enabling it + +1. Incoming queue +Preview uses queued messages + + +2. Test the rule +Read-only matching sample + + +3. Review the matches +Adjust the conditions + + +4. Save and enable +Rule actions run normally + + diff --git a/docs/releases/2.3.md b/docs/releases/2.3.md new file mode 100644 index 00000000..170a3e6f --- /dev/null +++ b/docs/releases/2.3.md @@ -0,0 +1,39 @@ +# Syslog 2.3: device filtering and multi-host collection fixes + +Historical release, published 2019-06-30. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.3 improves filtering and multi-host operation, repairs host/program synchronization and includes the published security fix in the original announcement. + +## Highlights + +- Correct the Alert Log device filter. +- Fix blank pages after collecting messages from multiple hosts. +- Repair synchronization of Syslog Hosts and Programs data. +- Include the security fix listed in the original announcement. + +## Compatibility and upgrade checks + +The [metadata shipped in 2.3](https://github.com/Cacti/plugin_syslog/blob/2.3/INFO) declares a minimum Cacti version of **1.2.0**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/2.3/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, inspect multiple sending hosts, the Alert Log device filter and synchronization of host/program names. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@cigamit](https://github.com/cigamit). + +[Compare v2.2 to 2.3](https://github.com/Cacti/plugin_syslog/compare/v2.2...2.3) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/2.3). + +
+Original detailed announcement and change list + +--- 2.3 --- +* issue#90: Can not show correct info when choose device filter in Syslog - Alert Log page +* issue#91: Page become blank after collecting multiple host syslog info +* issue#94: Stored XSS in syslog_removal.php +* issue#95: Syslog Hosts and Syslog Programs table looses sync with data + +
diff --git a/docs/releases/v2.1.md b/docs/releases/v2.1.md new file mode 100644 index 00000000..b7863bb7 --- /dev/null +++ b/docs/releases/v2.1.md @@ -0,0 +1,48 @@ +# Syslog 2.1: reports, exports and threshold-message improvements + +Historical release, published 2018-03-30. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.1 improves reports and exports, adds hostnames to emailed reports and corrects several statistics, removal-rule and remote-database issues. + +## Highlights + +- Include hostnames in emailed reports and restore report/export behavior. +- Correct threshold-alert formatting and display of removed records. +- Address statistics-view problems and slowdowns with large program lists. +- Improve remote-database compatibility and local configuration documentation. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.1](https://github.com/Cacti/plugin_syslog/blob/v2.1/INFO) declares a minimum Cacti version of **1.1.10**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.1/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, confirm an emailed report contains the expected hostnames and check exports, statistics and removed-record views. +2. For a separate Syslog database, verify its local configuration is retained and its connection is used. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. For this earliest published release, linked authors are drawn from the repository history through its tag. + +[@browniebraun](https://github.com/browniebraun), [@cigamit](https://github.com/cigamit), [@gan-dalf](https://github.com/gan-dalf), [@jpobeda](https://github.com/jpobeda), [@Linegod](https://github.com/Linegod), [@netniV](https://github.com/netniV), [@ronytomen](https://github.com/ronytomen), [@smiles1969](https://github.com/smiles1969), [@TheWitness](https://github.com/TheWitness), [@WonderZone](https://github.com/WonderZone). + +[Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.1). + +
+Original detailed announcement and change list + +--- 2.1 --- +- issue#18: Issues with syslog statistics display +- issue#17: Compatibility with remote database +- issue#19: Removal rules issues +- issue#20: Issues viewing removed records +- issue#23: Threshold rule alert format issues +- issue#30: Syslog page slows when too many programs are in the programs table +- issue#32: Export of Syslog records not functional +- issue#38: Enhance the documentation to discuss config.php.dist and doco site +- issue#40: Adds hostname column to emailed reports +- issue: SQL for matching Cacti host incorrect +- issue: Syslog Reports were not functional +- issue: Cleanup formating of Threshold messaging and viewing + +
diff --git a/docs/releases/v2.2.md b/docs/releases/v2.2.md new file mode 100644 index 00000000..4b894fa8 --- /dev/null +++ b/docs/releases/v2.2.md @@ -0,0 +1,57 @@ +# Syslog 2.2: per-rule reprocessing and filtering corrections + +Historical release, published 2019-06-17. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.2 adds per-rule message reprocessing and addresses a broad set of filter, export, compatibility and rule-import problems. + +## Highlights + +- Reprocess messages for an individual rule. +- Correct device, program, priority and Classic-theme filter behavior. +- Fix Alert Log export, report variables and graph-template import problems. +- Improve database SSL compatibility, predefined installation options and PHP 7.2 handling. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.2](https://github.com/Cacti/plugin_syslog/blob/v2.2/INFO) declares a minimum Cacti version of **1.2.0**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.2/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, use controlled messages to check an individual rule, filter combinations and an exported Alert Log. +2. Review the release’s database SSL and installation options against the versioned documentation before applying them to an existing deployment. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@cigamit](https://github.com/cigamit), [@ddb4github](https://github.com/ddb4github), [@netniV](https://github.com/netniV), [@ronytomen](https://github.com/ronytomen), [@TheWitness](https://github.com/TheWitness). + +Other author names recorded without a linked account: Jimmy Conner, Weblate. + +[Compare v2.1 to v2.2](https://github.com/Cacti/plugin_syslog/compare/v2.1...v2.2) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.2). + +
+Original detailed announcement and change list + +--- 2.2 --- +* feature: Allow for reprocess message per rule +* issue#66: Filter for All Programs can not work well +* issue#67: SQL error after choose device +* issue#69: Cirtical and Alert filter can not work well +* issue#71: Export alert log has sql error +* issue#72: Graph Template not workable after import by cli/import_template.php +* issue#73: Gap to Cacti 1.x: Syslog missed to support database ssl +* issue#74: New Requirement: another new hook 'syslog_update_hostsalarm' +* issue#76: New Requirement: background install syslog plugin with pre-defined options +* issue#77: Fixed: PHP Notice undefined variable +* issue#78: Misc issue about syslog_alerts->log->host +* issue#79: PHP 7.2 supporting to remove deprecated each() +* issue#80: Syslog plugin auto disabled after import an alert rule +* issue#81: php error when enter a value in Program filter and click go +* issue#82: Syslog can not deal with with single quotation +* issue#83: Change device filter can not return correct value in syslog- alert rule page +* issue#84: All Progarms not show anything using Classic theme +* issue#86: No color for emergency item +* issue#89: plugins/syslog/syslog_reports.php:89: Undefined variable '$id' + +
diff --git a/docs/releases/v2.5.md b/docs/releases/v2.5.md new file mode 100644 index 00000000..1bfabfe4 --- /dev/null +++ b/docs/releases/v2.5.md @@ -0,0 +1,49 @@ +# Syslog 2.5: timestamp integration, filters and re-alert timing + +Historical release, published 2019-12-26. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.5 updates rsyslog timestamp handling and corrects filtering, reporting and notification behavior, including one-minute poller intervals. + +## Highlights + +- Support the newer rsyslog timestamp format instead of the earlier separate date/time format. +- Fix program filtering, SQL Expression alert rules and international-character handling. +- Correct Re-Alert Cycle behavior with a one-minute poller interval and program synchronization under PHP 7.2. +- Improve report-row formatting and device-status text colors. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.5](https://github.com/Cacti/plugin_syslog/blob/v2.5/INFO) declares a minimum Cacti version of **1.2.8**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.5/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. Upgrading from an earlier version requires reviewing the rsyslog template in this tag’s README and restarting the forwarder after the change. The original documentation warns that messages may be lost during this transition; plan and validate the cutover. +2. After upgrading, send a known message through the forwarder and check its timestamp, program field and notification timing. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@aleksashka](https://github.com/aleksashka), [@cigamit](https://github.com/cigamit), [@netniV](https://github.com/netniV). + +[Compare 2.3 to v2.5](https://github.com/Cacti/plugin_syslog/compare/2.3...v2.5) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.5). + +
+Original detailed announcement and change list + +--- 2.5 --- + +* issue#103: Allow syslog to use rsyslog new tizezone sensitive timestamps instead of legacy date/time +* issue#102: Syslog statistics filter problem - select program +* issue#101: Alert rule SQL Expression not working as expected +* issue#100: Fix odd/even classes generation in report +* issue#99: Re-Alert Cycle (Alert Rules) is wrong in case of 1 minute poller interval +* issue#96: Syslog filtering does not work with some international characters +* issue#88: Provide text color to indicate device status in Cacti +* issue#87: Program data is not sync with syslog_incoming under PHP 7.2 + +--- 2.4 --- + +* issue: Resolving issues with nav level cache being set incorrectly + +
diff --git a/docs/releases/v2.6.md b/docs/releases/v2.6.md new file mode 100644 index 00000000..d7995648 --- /dev/null +++ b/docs/releases/v2.6.md @@ -0,0 +1,41 @@ +# Syslog 2.6: database selection and statistics-page fixes + +Historical release, published 2020-02-22. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.6 corrects filtering and removal-rule database handling, updates statistics-page rendering and includes a published security correction. + +## Highlights + +- Fix filtering that incorrectly reports the Cacti host table as missing. +- Use the intended database for removal rules when a separate Syslog database is configured. +- Update statistics-page rendering. +- Include the security correction identified in the original change list. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.6](https://github.com/Cacti/plugin_syslog/blob/v2.6/INFO) declares a minimum Cacti version of **1.2.8**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.6/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, check device filtering, statistics output and removal-rule behavior against the configured database. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@cigamit](https://github.com/cigamit), [@netniV](https://github.com/netniV), [@TheWitness](https://github.com/TheWitness). + +[Compare v2.5 to v2.6](https://github.com/Cacti/plugin_syslog/compare/v2.5...v2.6) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.6). + +
+Original detailed announcement and change list + +--- 2.6 --- + +* issue#104: When filtering, syslog incorrectly thinks the Cacti hosts table + does not exist +* issue#107: Removal rule not using correct DB when using $use_cacti_db = false; +* issue#109: Should merge CVE-2020-7106 solution to syslog plugin +* issue: Massive performance improvement in statistics page rendering + +
diff --git a/docs/releases/v2.7.md b/docs/releases/v2.7.md new file mode 100644 index 00000000..5a1a6c68 --- /dev/null +++ b/docs/releases/v2.7.md @@ -0,0 +1,37 @@ +# Syslog 2.7: alert-query and separate-database fixes + +Historical release, published 2020-03-01. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +This maintenance release addresses database errors in alert processing and loading host data from a separate Syslog database. + +## Highlights + +- Fix database errors raised by Syslog alerts. +- Restore host-table loading when Syslog and Cacti use different databases. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.7](https://github.com/Cacti/plugin_syslog/blob/v2.7/INFO) declares a minimum Cacti version of **1.2.8**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.7/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, check the configured database connection and confirm host information and a controlled alert are processed correctly. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@TheWitness](https://github.com/TheWitness). + +[Compare v2.6 to v2.7](https://github.com/Cacti/plugin_syslog/compare/v2.6...v2.7) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.7). + +
+Original detailed announcement and change list + +--- 2.7 --- + +* issue#110: Syslog Alerts cause DB errors + +* issue#111: Can not load host table when use different syslog server + +
diff --git a/docs/releases/v2.8.md b/docs/releases/v2.8.md new file mode 100644 index 00000000..adb5cc3d --- /dev/null +++ b/docs/releases/v2.8.md @@ -0,0 +1,43 @@ +# Syslog 2.8: background processing and dedicated-database exports + +Historical release, published 2020-03-10. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.8 restores processing and rule-export behavior that could fail when the working directory or database layout differed from the default. + +## Highlights + +- Fix background processing when the process starts outside the Cacti installation directory. +- Fix rule export when Syslog uses a database separate from Cacti. +- Correct fields that were not updated following the version change. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.8](https://github.com/Cacti/plugin_syslog/blob/v2.8/INFO) declares a minimum Cacti version of **1.2.10**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.8/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, confirm the scheduled processing command works from its actual working directory. +2. If a dedicated Syslog database is configured, verify a representative rule export uses the intended database. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@cigamit](https://github.com/cigamit), [@ddb4github](https://github.com/ddb4github), [@TheWitness](https://github.com/TheWitness). + +Other author names recorded without a linked account: Jing Chen. + +[Compare v2.7 to v2.8](https://github.com/Cacti/plugin_syslog/compare/v2.7...v2.8) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.8). + +
+Original detailed announcement and change list + +--- 2.8 --- + +* issue#115: Some field where not corrected following the version change + +* issue#116: Background process fail to operate syslog_coming table; syslog_process.php fail if current workdir is not CACTI_TOP + +* issue#117: Export of rules does not work when using db other than Cacti + +
diff --git a/docs/releases/v2.9.md b/docs/releases/v2.9.md new file mode 100644 index 00000000..372cdc61 --- /dev/null +++ b/docs/releases/v2.9.md @@ -0,0 +1,39 @@ +# Syslog 2.9: filter navigation and statistics corrections + +Historical release, published 2020-03-28. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 2.9 is a focused maintenance release for filter navigation, statistics reporting and translated console text. + +## Highlights + +- Fix the SQL error encountered when navigating back through Syslog filters. +- Correct statistics reporting and console internationalization issues. + +## Compatibility and upgrade checks + +The [metadata shipped in v2.9](https://github.com/Cacti/plugin_syslog/blob/v2.9/INFO) declares a minimum Cacti version of **1.2.10**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v2.9/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, test browser Back navigation through a filter change and compare the statistics view with a known sample of incoming messages. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@TheWitness](https://github.com/TheWitness). + +[Compare v2.8 to v2.9](https://github.com/Cacti/plugin_syslog/compare/v2.8...v2.9) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v2.9). + +
+Original detailed announcement and change list + +--- 2.9 --- + +* issue#120: SQL syntax error for syslog when click browser back button + +* issue: Syslog stats not reporting properly + +* issue: Internationalization issues on console + +
diff --git a/docs/releases/v3.0.md b/docs/releases/v3.0.md new file mode 100644 index 00000000..ca48ff08 --- /dev/null +++ b/docs/releases/v3.0.md @@ -0,0 +1,48 @@ +# Syslog 3.0: alert delivery, retained settings and program-aware reports + +Historical release, published 2020-10-28. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 3.0 combines alerting and filter fixes with report improvements, interface updates and a published security fix. + +## Highlights + +- Fix threshold-alert email delivery and Re-Alert Cycle configuration errors. +- Retain saved Syslog tab settings and improve searches for messages that do not contain a term. +- Include Program in report searches and replace image-based interface icons with Font Awesome glyphs. +- Include the previously published security correction identified in the original change list. + +## Compatibility and upgrade checks + +The [metadata shipped in v3.0](https://github.com/Cacti/plugin_syslog/blob/v3.0/INFO) declares a minimum Cacti version of **1.2.10**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v3.0/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, verify a controlled threshold notification, its re-alert interval, saved filters and a program-based report. +2. Review the original detailed list for the published security identifier. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@ddb4github](https://github.com/ddb4github), [@kim-fitness](https://github.com/kim-fitness), [@TheWitness](https://github.com/TheWitness). + +Other author names recorded without a linked account: Jing Chen. + +[Compare v2.9 to v3.0](https://github.com/Cacti/plugin_syslog/compare/v2.9...v3.0) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v3.0). + +
+Original detailed announcement and change list + +Mainly a BugFix release with some light enhancements. + +--- 3.0 --- + +* issue#122: Apply Cacti#3191 for XSS exposure (CVE-2020-7106) +* issue#124: Feature request: Syslog Search for message NOT containing something +* issue#128:The syslog alert email is not sent if the Reporting Method is set to threshold. +* issue#132: Cacti log shows syslog error when setting the "Re-Alert Cycle" in Alert Rules settings +* issue#133: Saving Settings on the Syslog Tab are not retained in latest Cacti +* feature#134: Syslog Search to include Program column - Reports +* feature: Migrate all Syslog Images to Fontawesome Glyphs + +
diff --git a/docs/releases/v3.1.md b/docs/releases/v3.1.md new file mode 100644 index 00000000..e1765421 --- /dev/null +++ b/docs/releases/v3.1.md @@ -0,0 +1,41 @@ +# Syslog 3.1: import, export and Save-action fixes + +Historical release, published 2020-11-10. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +This small maintenance release corrects problems in Syslog import/export workflows and the Save action. + +## Highlights + +- Clear the export-in-progress indicator when export completes. +- Correct imported alert-rule handling and the Syslog Save action. + +## Compatibility and upgrade checks + +The [metadata shipped in v3.1](https://github.com/Cacti/plugin_syslog/blob/v3.1/INFO) declares a minimum Cacti version of **1.2.10**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v3.1/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. After upgrading, export a small result set, inspect the completed state, and verify that a representative form saves and an imported alert rule retains its intended definition. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +[@TheWitness](https://github.com/TheWitness). + +[Compare v3.0 to v3.1](https://github.com/Cacti/plugin_syslog/compare/v3.0...v3.1) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v3.1). + +
+Original detailed announcement and change list + +Minor updates for import/export. + +--- 3.1 --- + +* issue#142: The indicator is not removed upon completion when export syslog + +* issue#141: Import syslog - Alert rule has error + +* issue#142: Syslog save button can not work well + +
diff --git a/docs/releases/v4.1.md b/docs/releases/v4.1.md new file mode 100644 index 00000000..dfa707e5 --- /dev/null +++ b/docs/releases/v4.1.md @@ -0,0 +1,50 @@ +# Syslog 4.1: fixes for cleanup, command execution and collector status + +Historical release, published 2023-01-28. [Current releases](https://github.com/Cacti/plugin_syslog/releases). + +Syslog 4.1 improves everyday processing and maintenance, with clearer messaging when a Data Collector is offline. + +## Highlights + +- Correct cleanup-query column selection and database connection handling. +- Fix command execution and runtime issues in traditional-table maintenance. +- Improve the message shown when the Data Collector is offline. + +## Compatibility and upgrade checks + +The [metadata shipped in v4.1](https://github.com/Cacti/plugin_syslog/blob/v4.1/INFO) declares a minimum Cacti version of **1.2.23**. Follow the [documentation for this tag](https://github.com/Cacti/plugin_syslog/blob/v4.1/README.md) for the matching installation and configuration steps. + +Before replacing plugin files, back up the plugin/local configuration and its database together. Apply migration instructions only when they match the version you are upgrading from. + +1. For upgrades crossing into Syslog 4.x, review the tagged README’s alert-method change: System Level alerts group matching messages, while per-host behavior requires Host Level alerts. +2. After upgrading, check cleanup against the configured database and exercise a representative alert command with controlled test messages. + +## Contributors and change history + +Thank you to the developers, translators, testers and reviewers who contributed. Linked authors below are associated by GitHub with the comparison range. + +
+Contributor profiles (14) + +[@bmfmancini](https://github.com/bmfmancini), [@cigamit](https://github.com/cigamit), [@Coool](https://github.com/Coool), [@ddb4github](https://github.com/ddb4github), [@Hamrad99](https://github.com/Hamrad99), [@ka1lie](https://github.com/ka1lie), [@linya-H](https://github.com/linya-H), [@netniV](https://github.com/netniV), [@ok1ean](https://github.com/ok1ean), [@seanmancini](https://github.com/seanmancini), [@SKROU0803](https://github.com/SKROU0803), [@tbriceno-hub](https://github.com/tbriceno-hub), [@TheWitness](https://github.com/TheWitness), [@weblate](https://github.com/weblate). + +
+ +Other author names recorded without a linked account: Jing Chen, San IPE, kaktus. + +[Compare v3.1 to v4.1](https://github.com/Cacti/plugin_syslog/compare/v3.1...v4.1) · [Browse commits and original author/co-author records](https://github.com/Cacti/plugin_syslog/commits/v4.1). + +
+Original detailed announcement and change list + +--- 4.1 --- + +* issue#185: Wrong column specification on cleanup query +* issue#186: Wrong connection in functions.php +* issue#189: Issues with undefined variable in traditional table maintenance +* issue#193: Fix command execution +* issue#196: Undefined variable $ignore +* issue#205: function syslog_strip_incoming_domains($uniqueID) +* feature: Provide better messaging if the Data Collector is in offline mode + +
diff --git a/tests/Unit/RecommendationsTest.php b/tests/Unit/RecommendationsTest.php index fc334844..60bacce3 100644 --- a/tests/Unit/RecommendationsTest.php +++ b/tests/Unit/RecommendationsTest.php @@ -355,9 +355,12 @@ function recommendation_sample(array $override = []): array { }); it('limits how many candidate identifiers one message can produce', function () { - $message = implode(' ', array_map(static fn ($n) => 'Word' . $n, range(1, 150))); + $message = implode(' ', array_map(static fn ($n) => 'Word' . $n, range(1, 121))); - expect(syslog_recommendation_candidates($message))->toHaveCount(120); + $candidates = syslog_recommendation_candidates($message); + expect($candidates)->toHaveCount(120) + ->and($candidates[119])->toBe('Word120') + ->and($candidates)->not->toContain('Word121'); }); it('remembers the bundled seed was applied', function () {