diff options
author | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2018-11-12 21:34:59 +0100 |
---|---|---|
committer | Costa Tsaousis <costa@tsaousis.gr> | 2018-11-12 22:34:59 +0200 |
commit | 3aae8f6c2ceea7f74cde61a2044aa50c5f252fae (patch) | |
tree | 781412f323c0183c520e4ff1c9fdac53a900b463 /web/api | |
parent | a29b433526f56fe983d88dc4e86585bad65916c4 (diff) |
Htmldoc (#4607)
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* fixes
* test
* test
* test
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* fixes
* test
* test
* test
* First set of major cleanup/deduplication
* 2nd major cleanup
* update getting started structure
* Cleanup in using netdata
* Final cleanup/deduplication
* Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators
* Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md
* First html documentation debug set
* Updated Makefile.am to ignore the new md and htmldoc generation files
* Removing files from rebase
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* fixes
* test
* test
* test
* First html documentation debug set
* Test 2
* Relative path changed
* Updated comments
* Cleanup, installation draft added
* test
* test
* First set of major cleanup/deduplication
* 2nd major cleanup
* update getting started structure
* Cleanup in using netdata
* Final cleanup/deduplication
* Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators
* Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md
* First html documentation debug set
* Updated Makefile.am to ignore the new md and htmldoc generation files
* Removing files from rebase
* Fixed Makefile.am
* Same line header and badges
* Fixed broken link
* CPU monitoring is in apps plugin
* Removed obsolete files
* Remove obsolete files
* - Make the Health API part of health/README.md new file web/api/health/README.md
- Make installer/LAUNCH.md part of deamon/README.md
- Move installer/MAINTAINERS.md to packaging/maintainers/README.md
- Move installer/DOCKER.md to docker/README.md
- Move system/README.md to daemon/config/README.md
- Move web/CUSTOM-DASHBOARDS.md to web/gui/custom/README.md
- Move web/CONFLUENCE-DASHBOARDS.md to web/gui/confluence/README.md
* Resolve codacy issue $(..) syntax instead of `..`
* Fix following warnings and add svgs to the data_structures/README.md
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTORS.md
- REDISTRIBUTED.md
- diagrams/data_structures/README.md
- docker/README.md
WARNING - Documentation file 'README.md' contains a link to 'collectors/plugins.d' which does not exist in the documentation directory.
WARNING - Documentation file 'README.md' contains a link to 'collectors/statsd.plugin' which does not exist in the documentation directory.
WARNING - Documentation file 'CONTRIBUTING.md' contains a link to 'web/CUSTOM-DASHBOARDS.md' which does not exist in the documentation directory.
WARNING - Documentation file 'CONTRIBUTING.md' contains a link to 'web/CONFLUENCE-DASHBOARDS.md' which does not exist in the documentation directory.
* Wrong urls in data_structures/README.md svgs
* Fix svg URLs number 2
* Modify the first line of the main README.md, to enable proper static html generation. Executed after copying the file to htmldoc/src
* Added back Why Netdata
* Fixed link to registry in Why-Netdata.md
* Added Why-Netdata to buildyaml and to Makefile.am
* Replaced http links causing mixed content warnings
* Made buildhtml ignore the directory node_modules created by Netlify
* Corrected CONTRIBUTING.MD to CONTRIBUTING.md
Diffstat (limited to 'web/api')
-rw-r--r-- | web/api/badges/README.md | 28 | ||||
-rw-r--r-- | web/api/exporters/README.md | 3 | ||||
-rw-r--r-- | web/api/health/README.md | 43 |
3 files changed, 60 insertions, 14 deletions
diff --git a/web/api/badges/README.md b/web/api/badges/README.md index cf0b22beac..2d85271907 100644 --- a/web/api/badges/README.md +++ b/web/api/badges/README.md @@ -56,14 +56,14 @@ Here is what you can put for `options` (these are standard netdata API options): ```html <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu"></img> </a> ``` Which produces this: <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu"></img> </a> - `alarm=NAME` @@ -84,14 +84,14 @@ Here is what you can put for `options` (these are standard netdata API options): ```html <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&dimensions=system%7Cnice"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&dimensions=system%7Cnice"></img> </a> ``` Which produces this: <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&dimensions=system%7Cnice"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&dimensions=system%7Cnice"></img> </a> - `before=SECONDS` and `after=SECONDS` @@ -106,28 +106,28 @@ Here is what you can put for `options` (these are standard netdata API options): ```html <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60"></img> </a> ``` Which produces the average of last complete minute (XX:XX:00 - XX:XX:59): <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60"></img> </a> While this is the previous minute (one minute before the last one, again aligned XX:XX:00 - XX:XX:59): ```html <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&before=-60&after=-60"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&before=-60&after=-60"></img> </a> ``` It produces this: <a href="#"> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&before=-60&after=-60"></img> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&before=-60&after=-60"></img> </a> - `group=min` or `group=max` or `group=average` (the default) or `group=sum` or `group=incremental-sum` @@ -208,11 +208,11 @@ These are options dedicated to badges: This option scales the svg image. It accepts values above or equal to 100 (100% is the default scale). For example, lets get a few different sizes: - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=100"></img> original<br/> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=125"></img> `scale=125`<br/> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=150"></img> `scale=150`<br/> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=175"></img> `scale=175`<br/> - <img src="http://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=200"></img> `scale=200` + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=100"></img> original<br/> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=125"></img> `scale=125`<br/> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=150"></img> `scale=150`<br/> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=175"></img> `scale=175`<br/> + <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&after=-60&scale=200"></img> `scale=200` - `refresh=auto` or `refresh=SECONDS` @@ -321,4 +321,4 @@ You can refresh them from your browser console though. Press F12 to open the web ```js var len = document.images.length; while(len--) { document.images[len].src = document.images[len].src.replace(/\?cacheBuster=\d*/, "") + "?cacheBuster=" + new Date().getTime().toString(); }; -```
\ No newline at end of file +``` diff --git a/web/api/exporters/README.md b/web/api/exporters/README.md index e69de29bb2..02e04abbf7 100644 --- a/web/api/exporters/README.md +++ b/web/api/exporters/README.md @@ -0,0 +1,3 @@ +# Exporters + +TBD diff --git a/web/api/health/README.md b/web/api/health/README.md new file mode 100644 index 0000000000..9bab960b1d --- /dev/null +++ b/web/api/health/README.md @@ -0,0 +1,43 @@ +# Health API Calls + +## Enabled Alarms + +NetData enables alarms on demand, i.e. when the chart they should be linked to starts collecting data. So, although many more alarms are configured, only the useful ones are enabled. + +To get the list of all enabled alarms: + +`http://your.netdata.ip:19999/api/v1/alarms?all` + +## Raised Alarms + +This API call will return the alarms currently in WARNING or CRITICAL state. + +`http://your.netdata.ip:19999/api/v1/alarms` + +## Event Log + +The size of the alarm log is configured in `netdata.conf`. There are 2 settings: the rotation of the alarm log file and the in memory size of the alarm log. + +``` +[health] + health db file = /var/lib/netdata/health/health-log.db + in memory max health log entries = 1000 + rotate log every lines = 2000 +``` + +The API call retrieves all entries of the alarm log: + +`http://your.netdata.ip:19999/api/v1/alarm_log` + +## Alarm Log Incremental Updates + +`http://your.netdata.ip:19999/api/v1/alarm_log?after=UNIQUEID` + +The above returns all the events in the alarm log that occurred after UNIQUEID (you poll it once without `after=`, remember the last UNIQUEID of the returned set, which you give back to get incrementally the next events). + +## Alarm badges + +The following will return an SVG badge of the alarm named `NAME`, attached to the chart named `CHART`. + +`http://your.netdata.ip:19999/api/v1/badge.svg?alarm=NAME&chart=CHART` + |