Commit Graph

24 Commits

Author SHA1 Message Date
kiwibrew
c91691bfa6 Update Rules.md (#14505)
Removed links to videos about how to create rules. The videos no longer describe the process for adding rules or wildcards. The new alerting UI is too different from the old one for them to be useful.
2022-10-24 21:26:42 -05:00
Zane C. Bowers-Hadley
1bdcd8fad2 assorted cleanups to alerting docs, primarily to make mdl happier (#13950)
* make mdl more happy for transports.md

* more tweaks for the splunk bits

* minor fix to entities.md

* try that again...

* ...

* okay, just leave that as is

* minor fixes to templates.md

* remote some trailling spaces

* wrap a line macros.md

* cleanup Rules.md reworked the videos section a bit to be more formatting consistent, I hope

* header cleanup for testing.md

* transports.md cleanup part 2
2022-04-26 09:37:39 +02:00
Jellyfrog
8f474dd4d4 Rework documentation (#13709)
* Rework documentation

* Slightly adjust theme

* wip

* fixes

* Remove unneeded header

* Re-added Acknowledgement.md file

* Added Acknowledgement.md to mkdocs.yml

Co-authored-by: Neil Lathwood <gh+n@laf.io>
2022-02-08 23:02:28 +00:00
Shao Yu-Lung (Allen)
8ec9183df5 Doc - Begins with / Ends with, SQL example is reversed (#12113) 2020-09-21 08:11:22 +02:00
VVelox
6575042f5f go through making lots of the docs more lint happy (#10342)
* clean up all but header incrementing in Creating-Transport.md

* make Device-Dependencies.md mdl happy

* make Entities.md as mdl happy as possible... one long table line left

* make mdl as happy as possible for index.md

* clean up Introduction.md as much as possible

* minor formatting cleanup... move each icon onto its own row

* make ack and notes the same style

* clean Macros.md up

* clean Rules.md up as much as possible

* tweak one line a bit to get it to format a bit nicer

* a bit more format tweaking, making sure it does not sure with >

* clean up as much as possible for Templates.md

* make Testing.md as mdl happy as possibly

* clean Transports.md up as much as possible

* clean as many issues as possible for Alerts.md

* clean up as much of ARP.md as possible

* clean up as much as possible for Bills.md

* make DeviceGroups.md as mdl happy as possible

* cleanup Devices.md

* make as mdl happy as possible Inventory.md and index.md

* mdl cleanup for Logs.md and PortGroups.md

* make Ports.md and Routing.md as happy as possible

* clean up Services.md, Switching.md, and Systems.md as much as possible

* more markup cleanup

* lots more md cleanup udner Devloping/

* reapply bits from #10343 that accidentally got removed when merging
2019-06-20 13:53:44 -05:00
TheGreatDoc
ea8f0de330 Fix formatting (#10135) 2019-04-24 10:09:48 +02:00
Neil Lathwood
1ee2e8e0e0 Updated to use new theme for docs site (#9320)
* Updated to use new theme for docs site

* Updated theme location

* Removed librenms.css

* Updated index page + re-added librenms.css

* Use built in theme modification

* flexbox grid, dump bootstrap

* tidy up things

* Added path and updated deploy script + mkdocs config

* Removed db schmea changes

* Updated to install python/pip 3

* Removed pip3 install

* Pip3 install

* Updated deploy-docs

* Updated deploy-docs
2018-10-27 23:04:34 +01:00
Kevin Krumm
51220e6b77 Fixed Alert rules Advanced SQL query (#9350)
DO NOT DELETE THIS TEXT

#### Please note

> Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting.

- [X] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/)

#### Testers

If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926`
After you are done testing, you can remove the changes with `./scripts/github-remove`.  If there are schema changes, you can ask on discord how to revert.
2018-10-19 22:58:14 +01:00
Neil Lathwood
466b5a35a8 Added ability to set a custom SQL query for alert rules. (#9094)
* Added support for AVG in rules

* More updates

* Final work to have advanced sql queries

* Added missing use

* Fix exception when invalid json is passed

* Fixed api for alert rules

* updated docs
2018-09-19 07:47:45 -05:00
Vitali Kari
daeadbc4e3 Update Rules.md (#9156) 2018-09-05 07:24:07 -05:00
Valent Turkovic
ee2bb8e820 Update Rules.md (#8501)
devices.status != 1 (means device is down)
devices.status = 1 (means device is up)
2018-04-04 09:00:23 +01:00
Neil Lathwood
544b363951 alert: Added support for disabling recovery notifications (#8430)
* alert: Added support for disabling recovery notifications

* reversed use of recovery

* removed debug + small update
2018-03-22 12:38:16 -05:00
Neil Lathwood
03076c4025 feature: Added new alert rule builder UI and rule mapping UI (#8293)
* feature: Added new alert rule builder UI

* Updated to export sql queries

* More updates

* more changes

* removed debug

* fix scrut

* Updated to include import options + various other fixes

* fix rule

* Populate name from collection rules.

* Fix default rule import
Allow new and old style rules in the collection.
Don't add new yet as I'm not sure GenSQL() is working.

* Fix GenSQL call

* Extract filter building to class so it is nicely contained in one place

* moved schema

* some fixes and tweaks

* travis fixes

* Some more features / updates

* Fix up my mistakes when adding default rules

* Use a modal for new alert (Incomplete)
Larger dialog!!
Remove page loading stuff.

Working:
Loading rules, resetting dialog, importing from collection.

Not working yet:
select width
device limited rule access? don't know what this is...

Lots of unused stuff to delete...

* reload "table" after save

* fixed editing rule

* Auto select2 width

* Reload window on save

* Restore per-device alert. Remove debug.

* Small cleanups. Rule Name first.

* Restore button to button type. Rename schema.

* Fixes: wrong command to reload window, remove extra attributes, rule is never passed

* Fixed old rule editing

* some small updates for old imports

* travis update to use trusty

* maybe travis fix

* Ability to set alert rule mappings on the rule edit screen

* pip installs one line, no quiet for deploy

* update schema def

* Fix style and some copyright headers

* fix docs missing file

* Allow new versions of snmpsim and libraries

* Parser WIP

* Fix default rules insert

* reorganize

* Legacy import first draft done

* Implement saving
Skip translation to sql for now

* Working on glues

* small rule collection fix

* Working on glues

* Working on glues

* Docs updates + small UI changes

* Parser WIP

* reorganize

* Legacy import first draft done

* Implement saving
Skip translation to sql for now

* Working on glues

* Working on glues

* Working on glues

* Add table mapping, should move to it's own class

* WIP

* Glue working!!

* Extract Schema class

* Some final touches.
revert alerts_rules.json for now.

* Finish up initial implementation
Needs more tests

* Fix a few places

* small doc updates

* Fix finding tables in grouped rules.

* remove unused code

* code format fixes

* Some quick tests for Schema
Simplified output for findRelationshipPath. Always includes start and target in the result.
This simplifies a lot of code in QueryBuilderParser.php
This also always loads the target table data now (which we want)

* Make bill_id the PRIMARY index for the bills table

* Load macros from a json file in misc instead of the database.

* Fix whitespace and wrong key for collection.

* Handle IN properly when generating SQL

* Fix glue (devices.device_id = ports.port_id) is incorrect :D
Show ALL tables we can resolve relationships for in the query builder filter.

* Remove all macros from the database
Remove insert statements, leave updates to update user's existing rules.
2018-03-14 20:25:19 +00:00
Kevin Krumm
4120bbc2a9 docs: Minor changes and fixes to Alert Rules (#7789)
* docs: minor changes and fixes to Alert Rules

* Update Rules.md

* Update Rules.md
2017-11-24 23:06:32 +00:00
Kevin Krumm
6fe5ac60d6 docs: rules doc small changes (#7787)
some minor movements to the alert rules doc.
2017-11-22 19:37:39 -06:00
Kevin Krumm
998a797bcd docs: added links/alerts/Cleanup Options (#7785)
* docs: added link to the alerts collection

* docs: added link to clean options

added link under setup to help users locate Clean options.
2017-11-22 18:34:10 -06:00
Kevin Krumm
c7430dc970 docs: alert rules update info (#7681)
* docs: testing alert rule link

added link to the device troubleshooting page.

* Update Rules.md

fix link

* Update Testing.md

fix link

* Update Rules.md

removed link - not useful for this part.

* image for alert rules collection

* image for alert rules collection

added image alert rules collection
2017-11-08 13:21:47 -06:00
Kevin Krumm
99fc28f8f5 docs: added in example rule and Link (#7680)
* docs: added in example rule and Link

Link to Device Troubleshooting page

* Update Rules.md
2017-11-08 11:28:23 -06:00
kkrumm1
e235c3d495 docs: Added in the alert rules videos to alert rules page (#7512)
* docs: alert rules, added in the alert rules video

alert rules, added in the alert rules video from youtube. On libreNMS channel.

* docs:alert rules

changed some of the formattings.
2017-10-19 09:22:05 +01:00
kkrumm1
83e85a5478 docs: Alerts glues (#7480)
* docs: Alerts

added the note for or `||` for `OR` to use macro.

* docs: alert glues

fixed typo

* docs: alert glues

rearranged some words.
2017-10-13 21:46:05 +01:00
Neil Lathwood
f1b50737bb Docs refactor (#7389)
* docs: Refactored docs for new layout

* some more changes

* more doc updates

* More doc updates

* small update

* small update
2017-10-02 21:36:22 +01:00
Bennett Blodinger
31993387e4 docs: Updated alerting docs / formatting (#7185)
* Ignore docs/

* Fix indenentation

YAML's pretty strict

* Remove static anchor names

Markdown does this automatically for us

* Tabelize entities

* Remove tildes

They don't do anything
2017-08-19 19:40:50 +01:00
Neil Lathwood
66008a0fd5 feature: Added script to test alerts (#7050)
* feature: Added script to test alerts

* actually added the file

* Add text when no alert is found.
2017-07-23 19:56:22 +01:00
Neil Lathwood
84814efc8b docs: Reorganised alerting docs + added some clarifications (#6869) 2017-06-24 21:27:42 -05:00