Commit Graph

126 Commits

Author SHA1 Message Date
Shubham Srivastava
5097d1e315 Add Zenduty Integration info to Transports.md docs (#14826) 2023-02-08 16:25:18 +01:00
support-capensis
f539aed95e Fix Doc Link for Canopsis transport (#14778) 2023-01-10 14:56:24 +01:00
Zero Services GmbH
f754a5107d Update ElasticSearch Index pattern for php 8.1 changes (#14775) 2023-01-08 01:58:39 +01: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
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
Tony Murray
302a989d4e Email Transport: embed graphs by default (#14270)
* Email embed graphs

* Allow attachment for non-html
Add setting to webui
Correct $auth setting

* Cleanups, throw RrdGraphException instead of returning an error image.
Generate the error image later, giving more control.
Reduce code duplication a little

* Style and lint fixes
Change to flags

* Add baseline for lint errors I don't know how to resolve

* oopsie, changed the code after generating the baseline

* Tiny cleanups.  Make set DeviceCache primary, it is free.

* Docs.

* email_html note

* Allow control of graph embed at the email transport level to override the global config.

* Allow control of graph embed at the email transport level to override the global config.

* Add INLINE_BASE64 to make it easier to create inline image tags
2022-09-05 20:41:55 -05: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
afb5fb7eea Small documentation typos (#14101)
* Update Templates.md

withing > within

* Update index.md

Small typos correction

* Update Performance.md

Typos/Rewording

* Update Performance.md

* Update Syslog.md

recieving > receiving

* Update Entities.md

Remove rogue `

* Update Dashboards.md

embeded > embedded

* Update Interface-Description-Parsing.md

infor > information

* Update Network-Map.md

genrated > generated
2022-07-10 11:46:01 +02: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
geg347
ef12e5f980 Added Basic authentication capability to Alertmanager Transport (#13867)
* Adding Basic authentication capability to Alertmanager's Transport

* Fix PHPStan linting error

* Fix StyleCI error

* Fix StyleCI error part 2
2022-03-31 21:45:44 +01:00
geg347
9036fd53b4 Added extra dynamic values alerttransport alertmanager (#13828)
* Add extra dynamic values to Alert transport for Alertmanager

* Add description to explain how extra dynamic values for Alertmanager works in the WebUI

* Add _ in dynamic label name + fix continuous-itegration error

* Fix continuous-itegration error part 2

* Updating AlertManager docs with explanation of how dynamic variables works
2022-03-14 21:39:00 +00: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
Tony Murray
0b8b97bb68 Push Notifications (Mobile and PC) (#13277)
* Update manifest and add service worker
cleanup icons a bit

* Push notifications WIP

* navigate working

* cleanup

* acknowledge wired up

* Set VAPID keys on composer install

* Component to control notification permissions.

* Allow all user option to validate

* Enable on browser load if transport exists.

* Check for transport before showing user permissions
translations

* Documentation

* style fixes

* access via the attribute model

* fix alerting test

* update schema

* cleanup subscription on disable

* non-configurable db and table for webpush subscriptions (respect system connection)

* revert AlertTransport change
hopefully phpstan can figure it out

* phpstan fixes

* Support custom details display

* Match transport names to brand's preferred display

* less duplicate id errors

* Tests are done in Laravel code now so
remove legacy function usage... could be better, but ok

* Style fixes

* Style fixes 2

* Fix alert test

* Doc updates requires HTTPS and GMP

* unregister subscription when permission is set to denied

* cleanup after user deletion

* delete the right thing

* fix whitespace

* update install docs to include php-gmp

* suggest ext-gmp

* update javascript

* Update functions.php

Co-authored-by: Jellyfrog <Jellyfrog@users.noreply.github.com>
2021-10-06 07:29:47 -05:00
ottorei
35dbb3e9cb Update docs: Example for optional data on templates (#13128) 2021-08-12 12:55:36 +02:00
Kevin Zink
d0d8a9024b Add Signal CLI transport support (#12954)
* Add Signal CLI support

* Update Signal.php

* fix style

* fix style

* fix CI style

* fix CI style

* escapeshellarg

* fix style

* fix style

* fix style
2021-06-18 00:38:09 +02:00
Sean
bcedc0ed77 Improve Markdown syntax in Document (#12949)
* Use GitLab instead of Gitlab

Only change text part, the Alert.Transport.Gitlab class left as is.

* Fix href in document

* Move section in document

The agent list in this document is sorted by alphabetical order,
"SDFS info" is the only exception.

* Remove trailing spaces in document

* Align code in document

* Fix Markdown in document

- Escape underline
- Add syntax highlight
- Add two space in the end of line to make it a newline
- Add newline before list or code section

* Update LibreNMS/Alert/Transport/Gitlab.php

Co-authored-by: Jellyfrog <Jellyfrog@users.noreply.github.com>
2021-06-16 21:16:21 +02:00
Filippo Giunchedi
c8c8bc3a81 Support multiple Alertmanager URLs (#12346) 2021-03-27 10:01:48 -05:00
Lee Spottiswood
283dafda1c add UKFast PSS transport (#12624)
* add UKFast PSS transport

* rename var

* use correct class signature

* fix styleci

* styleci

* styleci
2021-03-22 10:39:58 -05:00
Hans Erasmus
45c20b2dd6 Update transports docs (#12518) 2021-02-10 00:13:33 +01:00
Shao Yu-Lung (Allen)
8ec9183df5 Doc - Begins with / Ends with, SQL example is reversed (#12113) 2020-09-21 08:11:22 +02:00
Raphael Dannecker
73b7636c9f Matrix alert transport (#12018)
* Added Matrix as alert-channel (Feature request #4927)

* formatting

* Dokumentation of matrix-transport

* Matrix Server-URL

* Formatting
2020-08-20 12:04:17 +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
Luca Olivetti
5e6d371e42 Added example for the alerta transport (#11596) 2020-05-12 15:45:00 -05:00
VTS
60552d96ae Copy and modify the syslog transport for sending alerts to Splunk in an easy to parse format (#11176)
* Create Splunk.php

* add documentation

add documentation for splunk transport rule

Co-authored-by: Tony Murray <murraytony@gmail.com>
2020-05-11 23:11:45 -05:00
Lucas Dousse
5242c26fb4 Add ASP sms provider (#11489) 2020-04-26 19:40:19 +02:00
Anael Mobilia
1b7d0dd4e9 Add transport for Smsmode (SMS provider) (#11332)
* Add transport for Smsmode (SMS provider)

* Delete Smsmode.php

* Add SMSmode to doc using API transport
2020-04-26 13:02:04 +02:00
Adam Bishop
492ab32b6d Add support for sending events to Sensu (#11383)
* Add support for sending events to Sensu

Sensu is an alerting and monitoring service (and much more) that has a
nagios compatible check API.

This transport translates LibreNMS alerts into Sensu events, and sends
them to the agent API running on the same host as the poller.

The transport has a few options, but none of them are required - if the
Sensu agent is correctly configured, alerts will be sent as soon as the
transport is enabled.

There's a fair amount of code, as I've tried to translate as much data as
possible between LibreNMS and Sensu.

* Update Transports.md

* If alerted is 0, send an "ok" alert dated rrd.step / 2 seconds ago

This makes Sensu aware of the last time the check ran successfully (ish).
If we don't send the initial "ok", Sensu will either display 'unknown',
or an incorrectly high duration for the incident.

Alerted gets set to 1 after the first alert is sent.

We choose rrd.step / 2 as:
 * rrd.step is the maximum time ago the check could have succeeded
 * we halve it, so that if a check is flapping, it is not masked

Basically, we guess that the check fails around halfway through the time
since the poller last ran.

* Add additional metadata

* Improve codeclimate slightly

* Consider names that are 2 or 3 components long
2020-04-11 14:29:13 -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
ee8297df19 Extend FS switches support, handle lowerLayerDown ifOperStatus (#10904)
* extend FS switches support

* MIB compilation

* HW and Ver

* sensors and CPU

* tests

* correct version

* try to handle properly "down" as not up, for OperStat like lowerLayerDown

* try to handle properly "down" as not up, for OperStat like lowerLayerDown

* try to handle properly "down" as not up, for OperStat like lowerLayerDown

* try to replace "down" with "not up" :)

* fix other ifOperStatus checks
2020-01-15 08:28:36 -06:00
Kevin Krumm
1e3551a7e5 docs: Update transport doc. (#10963)
Removed the old doc that has an email address entered by comas, this is no longer needed with transports. A admin can make transport for each user or make a group of users.
2019-12-19 15:00:33 -06:00
louis-oui
9734434de3 fix port_usage_perc macro matches in but not out (#10932)
* port_usage_perc macros matches in or out
* update doc
2019-12-12 20:51:37 +01:00
mendoza-conicet
0ea346113a Add Headers and body to API Transports (#10614)
* Add Headers and body
add PUT Method

* fix check length of headers

* bad commit

* style check

* better body description

* Descr and RFC enforcement on 'PUT' and body

Only PUT can accept a statically defined body. GET will ignore it (RFC) and POST body is generated with the parameters.

* Process the variables as well for headers

* Update Api.php

* update docs
2019-11-01 09:00:26 +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
Jellyfrog
c76e95d343 Markdown linting of docs (#10595)
* Remove trailing spaces

* Markdown linting of docs
2019-10-21 00:47:40 +00:00
seros1521
2db29a325f Add procedure URL to alert templates (#10609) 2019-09-24 13:08:22 +02:00
Shao Yu-Lung (Allen)
9ac70037bb Add LINE Notify Alert Transport. (#10495)
* Add LINE Notify Alert Transport.

* Fix code style.

* Update document.

* Update Linenotify.php
2019-09-05 04:30:53 +00:00
PipoCanaja
c5a915709c Transport API - Doc for placeholders (#10416)
* Transport API - Doc for placeholders

The available placeholders are the same as the Templates documentation but the syntax is not exactly identical.

* Update Transports.md

* Update Transports.md

* Update Transports.md
2019-07-23 12:32:13 -05:00
Joe Clarke
8bbc69a878 Add support for using Markdown for the Ciscospark transport (#10442)
* Add support for using Markdown.

Alert templates can be written using Webex Teams (i.e., Spark) Markdown,
which makes for some richer alerts.  This option defaults to false to
maintain Principle of Least Astonishment.

* Update Cisco Spark docs.

* Mention that Cisco Spark is now called Webex Teams
* Add support for Markdown

* Refactor text.

Do not exceed 80 characters per line.

* Refactor code to meet style guidelines.

* Remove errant tabs and use spaces instead
* Correct type check
* Remove use of 'else'
2019-07-14 16:34:22 -05:00
PipoCanaja
55f67f42fe Refactor Api transport to use Guzzle (and new variables syntax) (#10070)
* Allow new {{ $xxxx }} syntax

* Properly handle urlencode on variable values without braking the URL, and uses Blades

* Doc
Doc typo

* use Guzzle for HTTP requests

* Add Basic auth support

* Doc update

* clean

* Revert Blades, but keep the {{ $xxxx }} syntax

* Revert Blades, but keep the {{ $xxxx }} syntax

* Init Vars and comments

* Notifications

* api-options are not required

* Update notifications.rss
2019-07-04 16:55:29 +01: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
pobradovic08
2d246097d4 Documentation: Fix broken links and anchors (#10194)
* documentation: Fix broken Templates.md link

* Update AUTHORS.md

* docs: Fix broken anchor in Fast-Ping-Check.md

* docs: Changed Alerting link in Configuration.md
2019-05-06 21:50:45 -05:00
Mihai Petracovici
2df2956817 Improved option naming & validation for smseagle (#10141)
* Relax validation for smseagle hostname
* Update property description and documentation
2019-04-27 09:08:16 +02:00
TheGreatDoc
ea8f0de330 Fix formatting (#10135) 2019-04-24 10:09:48 +02:00