Commit Graph

49 Commits

Author SHA1 Message Date
Tony Murray
49f8269262 Improved Latency graph (#15940)
* Improved Latency graph
Store loss+jitter info in rrd instead of database
New graph icmp_perf (legacy ping_perf still valid referencing part of the newer data)
Delete device_perf table

* Change loss to an area so it is more visible

* Style fixes

* Cleanups from phpstan & tests

* exit_code fix

* Remove alert usage of device_perf

* Don't use magic __get

* Add test for bulkPing
Add host to previous tests

* style fixes

* Fix issue fping error responses
2024-04-18 09:57:01 -05:00
blknight88
6798a43e4a Fix @signedGraphTag documention (#15853)
The @signedGraphTag section is wrong, it should not be "device_id" that fails to load, it needs to just be "device"
The server link below that is also wrong, it should not be "id", it should be "device"
2024-03-03 22:51:25 +01:00
Justin Lentz
53874840db Update Templates.md (#15210) 2023-08-09 20:16:25 +02:00
electrocret
07e2ce5fc1 Polling poller debug (#14691)
* Add poller_name to debug

* Documentation

* Clarify debug output var is for traceroute.

* Fix -hopefully

* StyleCI
2022-12-15 21:48:43 -06:00
electrocret
0ef39344fd Correct example variable (#14683) 2022-11-30 20:40:20 -06:00
electrocret
d10ccc697c Undefined constant error (#14668) 2022-11-22 15:52:15 -06:00
Tony Murray
9f39acd615 Update docs around APP_URL (#14282)
* Update docs around APP_URL
it is required in more cases than implied such as signed graphs

* Some require public urls

* Update Templates.md
2022-09-03 23:46:16 -05:00
Tony Murray
5c76890373 Add @signedGraphTag() and @signedGraphUrl() blade directives (#14269)
* More secure external graph access
Add @signedGraphTag() and @signedGraphUrl() blade directives
Takes either an array of graph variables or a url to a graph
Uses a signed url that is accessible without user login, embeds signature in url to authenticate access
See Laravel Signed Url for more details.
Adds Laravel route to graphs (does not change links to use it yet)
@graphImage requires the other PR
Also APP_URL is required in .env

* missing files from rebase

* Fix url parsing with a get string

* allow width and height to be omitted

* Documentation

* Add to, otherwise it will always be now

* Doc note for to and from relative security

* fix vars.inc.php (Laravel has a dummy url here)
2022-09-03 12:48:43 -05:00
wrongecho
060c87c535 Documentation typos (#14099)
* Update Templates.md

withing > within

* Update index.md

Small typos correction

* Update Performance.md

Typos/Rewording

* Update Performance.md
2022-07-09 09:32:59 -05:00
twelch24
402163fec9 fix a typo (#13970) 2022-05-10 11:00:37 +02: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
f93f8a02e6 Add better default sensor alert template (#13703) 2022-02-08 23:18:13 +00: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
Tony Murray
3c0831c821 Use display name in alerts (#13650)
* Use display name in alerts

* remove error from baseline
2022-01-04 23:40:42 +00:00
ottorei
35dbb3e9cb Update docs: Example for optional data on templates (#13128) 2021-08-12 12:55:36 +02:00
pepperoni-pi
28ae37c406 Added ability to use JSON directly in Msteams Transport (#11129)
* Added ability to use JSON directly in Msteams Transport

* Update Transports.md

* Update Msteams.php

* Update Msteams.php

Added boolean to fix test transport button

* Update Templates.md

Added JSON example and modified titles slightly.

* Update Templates.md

Moved MS Teams examples under "Examples" header since they are no longer formatted in HTML

* Update Templates.md

* Update Templates.md

* Update Msteams.php

changed condition to use $obj['id'] rather than $obj['msg']

* Update Msteams.php
2020-06-04 22:18:49 -05:00
Danislav
36dbe0484e Add quotes around the word mail (#11267)
* Add quotes around the word mail

The word 'mail' needs quotes around it so php will use it as a string instead of a variable name.

* Double quotes to Single as is in the rest
2020-03-10 15:48:15 +01:00
PipoCanaja
d72c722075 Alerts - Add features + serial in alerts-> table (#10747)
* Alerts - Add features + serial for device

* doc
2019-10-26 00:28:36 +00:00
seros1521
2db29a325f Add procedure URL to alert templates (#10609) 2019-09-24 13:08: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
75e11a7d3f Update Templates.md (#10120) 2019-04-17 16:28:55 +02:00
sorano
3f5d8e3633 Add HTML transport example for ms teams (#9969)
and fix missing " in Processor Alert with Graph example.
2019-03-17 20:39:20 -05:00
tharbakim
4f7a71c09f Update Templates.md (#9833) 2019-02-15 12:31:07 -06:00
Tony Murray
e18f4522d5 Update to Laravel 5.7 (PHP 7.3 support) (#9800)
* Move assets to 5.7 location

* Add 5.7 SVGs

* add cache data dir

* update QUEUE_DRIVER -> QUEUE_CONNECTION

* Update trusted proxy config

* update composer.json

* 5.5 command loading

* @php and @endphp can't be inline

* Laravel 5.6 logging, Nice!

* Update blade directives

* improved redirects

* remove unneeded service providers

* Improved debugbar loading

* no need to emulate renderable exceptions anymore

* merge updated 5.7 files (WIP)

* Enable CSRF

* database_path() call causes issue in init.php

* fix old testcase name

* generic phpunit 7 fixes

* add missed file_get_contents
Keep migrations table content

* fix duplicate key

* Drop old php versions from travis-ci

* remove hhvm

* fix code climate message

* remove use of deprecated function assertInternalType

* Disable CSRF, we'll enable it separately.
All forms need to be updated to work.

* Update document references
2019-02-12 17:45:04 -06:00
Neil Lathwood
ceea9d4981 Added ability to record traceroutes for devices down due to ICMP (#9457)
* Added ability to record traceroutes for devices down due to ICMP

* Update Templates.md

* Updated schema

* Update dev-overview-data.inc.php
2018-11-19 09:58:59 -06:00
Neil Lathwood
38e3250528 Added support for using Transport name in templates (#9411) 2018-11-05 07:56:16 +00: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
Atroskelis
c36a9e9abf Missing {{ }} around $value in some examples (#9272)
Storage alert and another was missing {{ and }} around the $value giving an error in test-template.php.
2018-09-30 21:08:51 -05: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
Peter Musolino
4e1a8bdcc4 Updated example for new alerting engine (#9193)
* Updated example for new alerting engine

Using the example of port utilization caused errors when trying to use it with the new alert system.  Putting variables in curly braces and removing php calls resolved it.  Updating docs to reflect this.

Also removed examples with hash tags in the body of the template as pasting this in will cause syntax errors by the alerts script.

* Update Templates.md
2018-09-13 21:08:40 -05:00
lug-gh
4cba0a5244 Syntax error in documentation (#9145)
just found a little syntax error in the docs, nothing special :)

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 9145`
2018-09-04 14:04:42 +01:00
Evil.2000
fefde753f1 Added information on assigning templates to alert rules
I added some description how to attach templates to rules, because this was not very obvious to me.

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`
2018-08-22 21:04:36 +01:00
Neil Lathwood
f29b286f7f Update Templates.md (#8979)
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.

- [ ] 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`
2018-08-03 22:08:09 +01:00
Paul Heinrichs
7f16e586a7 Update base template (#8973) 2018-08-02 08:27:29 +01:00
Paul Heinrichs
da58c91dd9 Add docs for using a base template (#8939)
* Add docs for using a base template

* Updated readme
2018-07-31 19:16:45 -05:00
dsgagi
344dfb9797 Update Templates.md (#8965)
Fix errors in `Service Alert` template example.

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`
2018-07-30 21:13:32 +01:00
Neil Lathwood
ad6ec7f72a Refactor alert templates to use Laravel Blade templating engine (#8803)
* Initial start on new templating support

* further updates

* more updates

* More working version

* Last fixes

* Small updates

* modified test to look for dbname.

* Schema update

* Added fix for not being able to disable Philips Hue transport

* Updated sql file

* Updated db_schema

* Set myclabs/deep-copy to be 1.7.x version in composer

* Fixes from murrant

* Forced nikic/php-parser to version 3.1.x in composer

* Updated composer to use custom fork of string-blade-compiler + fixed transport use

* Updated to always use correct template

* Merged legacy and blade templating engines

* Removed template type + fixed test-alert.php

* Added more template placeholders

* Added ability to reference data in templates as $alert->X

* Updated docs for templates

* Updated db_schema.yaml

* Added $alert->builder

* Clarify the use of $alert->builder

* Fixed the use of $alert->transport

* renamed schema file

* Added template validation

* Small update to fix travis issue

* Add Docs text to title bar

* Updated amqp to new of version

* Consistency in alert rule and template title bars
2018-07-14 22:15:43 +01:00
Neil Lathwood
d7899f509c alerting: Updated variables available for templates (#8713) 2018-05-15 20:30:59 -05:00
theherodied
4e94e9905c Fixed backticks (#8366)
Fixed backticks for new html examples.
2018-03-13 13:24:04 +00:00
theherodied
7946f15b44 Added two html alert template examples (#8360)
Added two html alert template examples. Asked pii100 for permission to include his and he said ok.
Included my html service alert check that includes service_message.
Added a note for html and graphs. I believe most people will find it useful on this page.
2018-03-13 11:21:27 +00:00
Kevin Krumm
8a917683ca docs: Added memory alert template (#8176)
basic memory alert template.
2018-01-31 21:55:17 +00:00
Kevin Krumm
5384d1ca15 docs: Fix for alert template port utilization (#8175)
* docs: fix for alert template port utilization

Alert Template for port utilization. Fix from jdtp ;)

* changed to hostname
2018-01-30 21:16:18 +00:00
Kevin Krumm
cf2411934b docs: add value sensors and temperature template (#8120) 2018-01-21 11:44:28 -06:00
Kevin Krumm
922a4f2fbd docs: added Storage to templates (#7986) 2017-12-30 09:56:47 -06:00
Kevin Krumm
51a641c93b docs: added ports template to alert rules doc (#7763)
Ports utilization template
2017-11-17 19:33:35 -06: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
Aldemir Akpinar
34d0fc3199 refactor: Ability to edit default alert template (#7121)
* newfeature: ability to edit default alert template

* Fix style errors

* Added missing db query

* Removed unnecessary code, and added faq section

* Minor documentation about default alert template. And put back wrongly removed lines

* Fixing the silly old mistakes... again
2017-08-12 20:21:13 +01:00
Neil Lathwood
84814efc8b docs: Reorganised alerting docs + added some clarifications (#6869) 2017-06-24 21:27:42 -05:00