[ZBX-16414] Improve "Supported trigger functions" page. Created: 2014 Oct 15  Updated: 2024 Apr 10  Resolved: 2020 Feb 24

Status: Closed
Project: ZABBIX BUGS AND ISSUES
Component/s: Documentation (D)
Affects Version/s: None
Fix Version/s: 5.0 (plan)

Type: Documentation task Priority: Trivial
Reporter: Oleg Ivanivskyi Assignee: Martins Valkovskis
Resolution: Fixed Votes: 0
Labels: triggerfunctions
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File doc.png    
Team: Team D
Team: Team D
Sprint: Sprint 56 (Sep 2019), Sprint 55 (Aug 2019), Sprint 54 (Jul 2019), Sprint 57 (Oct 2019), Sprint 58 (Nov 2019), Sprint 59 (Dec 2019), Sprint 60 (Jan 2020), Sprint 61 (Feb 2020)

 Description   

Please improve "Parameter(s)" for some functions in the documentation (https://www.zabbix.com/documentation/2.4/manual/appendix/triggers/functions). For example:

  • some functions accept "time_shift" as a second parameter (e.g. "avg", "last", etc), but in the documentation I can see "sec or #num" in the parameters cell
  • "count" accepts "pattern", "operator" and "time_shift" parameters also (not "sec or #num" only).

 Comments   
Comment by Glebs Ivanovskis (Inactive) [ 2016 Apr 25 ]

Supported trigger functions table is large and not very interactive.

  • It's not possible to give a link to a particular trigger function description.
  • time_shift parameter is described only for avg() and all other trigger functions which support time_shift reference avg() but without a clickable reference. (Maybe a footnote about sec|#num and time_shift could help here.)
  • It would be nice to add references between similar functions for easier search of appropriate function for a particular use case. (For example, count() with operator like extends functionality of str() by returning the number of matched values instead of simply 1 and by supporting time_shift.)
Comment by Martins Valkovskis [ 2020 Feb 18 ]

Most of the issues have been resolved in documentation for the currently supported 3.0, 4.0, 4.4, 5.0 versions.

It is not possible to give a link to a particular trigger function description, but that is the current table design.

Generated at Thu Apr 18 12:31:09 EEST 2024 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.