diff options
| author | Promise Akpan <akpanpromise@hotmail.com> | 2019-08-15 12:06:39 +0100 |
|---|---|---|
| committer | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2019-08-15 13:06:39 +0200 |
| commit | f5006d51e8caf9148d393eb68d53dc9fcd28b7b6 (patch) | |
| tree | 03b757236d6b45e46813a4a875c77dc775e5f896 /web | |
| parent | 69172fd57472df75d877f43de2dcc693c48ab5c0 (diff) | |
Fix Markdown Lint warnings (#6664)
* make remark access all directories
* detailed fix after autofix by remark lint
* cross check autofix for this set of files
* crosscheck more files
* crosschecking and small fixes
* crosscheck autofixed md files
Diffstat (limited to 'web')
27 files changed, 463 insertions, 463 deletions
diff --git a/web/README.md b/web/README.md index 66f3ce2788..fc230f51de 100644 --- a/web/README.md +++ b/web/README.md @@ -1,14 +1,14 @@ # Web dashboards overview -The default port is 19999; for example, to access the dashboard on localhost, use: http://localhost:19999 +The default port is 19999; for example, to access the dashboard on localhost, use: <http://localhost:19999> To view Netdata collected data you access its **[REST API v1](api/)**. For our convenience, Netdata provides 2 more layers: -1. The `dashboard.js` javascript library that allows us to design custom dashboards using plain HTML. For information on creating custom dashboards, see **[Custom Dashboards](gui/custom/)** and **[Atlassian Confluence Dashboards](gui/confluence/)** +1. The `dashboard.js` javascript library that allows us to design custom dashboards using plain HTML. For information on creating custom dashboards, see **[Custom Dashboards](gui/custom/)** and **[Atlassian Confluence Dashboards](gui/confluence/)** -2. Ready to be used web dashboards that render all the charts a Netdata server maintains. +2. Ready to be used web dashboards that render all the charts a Netdata server maintains. ## Customizing the standard dashboards @@ -25,4 +25,4 @@ To configure your info file set in `netdata.conf`: custom dashboard_info.js = your_file_name.js ``` -[]() +[](<>) diff --git a/web/api/README.md b/web/api/README.md index 21cebdfa17..958b1580ce 100644 --- a/web/api/README.md +++ b/web/api/README.md @@ -18,4 +18,4 @@ and this [multi chart, jsfiddle example](https://jsfiddle.net/ktsaou/L5y2eqp2/):  -[]() +[](<>) diff --git a/web/api/badges/README.md b/web/api/badges/README.md index 60f12e545d..75c30abffc 100644 --- a/web/api/badges/README.md +++ b/web/api/badges/README.md @@ -22,17 +22,17 @@ The right one is a **volume** calculation. Netdata calculated the total of the l Let's see a few more badge examples (they come from the [Netdata registry](../../../registry/)): -- **cpu usage of user `root`** (you can pick any user; 100% = 1 core). This will be `green <10%`, `yellow <20%`, `orange <50%`, `blue <100%` (1 core), `red` otherwise (you define thresholds and colors on the URL). +- **cpu usage of user `root`** (you can pick any user; 100% = 1 core). This will be `green <10%`, `yellow <20%`, `orange <50%`, `blue <100%` (1 core), `red` otherwise (you define thresholds and colors on the URL). - <a href="https://registry.my-netdata.io/#apps_cpu"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=users.cpu&dimensions=root&value_color=grey:null%7Cgreen%3C10%7Cyellow%3C20%7Corange%3C50%7Cblue%3C100%7Cred&label=root%20user%20cpu%20now&units=%25"></img></a> <a href="https://registry.my-netdata.io/#apps_cpu"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=users.cpu&dimensions=root&after=-3600&value_color=grey:null%7Cgreen%3C10%7Cyellow%3C20%7Corange%3C50%7Cblue%3C100%7Cred&label=root%20user%20average%20cpu%20last%20hour&units=%25"></img></a> + <a href="https://registry.my-netdata.io/#apps_cpu"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=users.cpu&dimensions=root&value_color=grey:null%7Cgreen%3C10%7Cyellow%3C20%7Corange%3C50%7Cblue%3C100%7Cred&label=root%20user%20cpu%20now&units=%25"></img></a> <a href="https://registry.my-netdata.io/#apps_cpu"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=users.cpu&dimensions=root&after=-3600&value_color=grey:null%7Cgreen%3C10%7Cyellow%3C20%7Corange%3C50%7Cblue%3C100%7Cred&label=root%20user%20average%20cpu%20last%20hour&units=%25"></img></a> -- **mysql queries per second** +- **mysql queries per second** - <a href="https://registry.my-netdata.io/#mysql_local"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.queries&dimensions=questions&label=mysql%20queries%20now&value_color=red&units=%5Cs"></img></a> <a href="https://registry.my-netdata.io/#mysql_local"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.queries&dimensions=questions&after=-3600&options=unaligned&group=sum&label=mysql%20queries%20this%20hour&value_color=green&units=null"></img></a> <a href="https://registry.my-netdata.io/#mysql_local"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.queries&dimensions=questions&after=-86400&options=unaligned&group=sum&label=mysql%20queries%20today&value_color=blue&units=null"></img></a> + <a href="https://registry.my-netdata.io/#mysql_local"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.queries&dimensions=questions&label=mysql%20queries%20now&value_color=red&units=%5Cs"></img></a> <a href="https://registry.my-netdata.io/#mysql_local"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.queries&dimensions=questions&after=-3600&options=unaligned&group=sum&label=mysql%20queries%20this%20hour&value_color=green&units=null"></img></a> <a href="https://registry.my-netdata.io/#mysql_local"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.queries&dimensions=questions&after=-86400&options=unaligned&group=sum&label=mysql%20queries%20today&value_color=blue&units=null"></img></a> - niche ones: **mysql SELECT statements with JOIN, which did full table scans**: + niche ones: **mysql SELECT statements with JOIN, which did full table scans**: - <a href="https://registry.my-netdata.io/#mysql_local_issues"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.join_issues&dimensions=scan&after=-3600&label=full%20table%20scans%20the%20last%20hour&value_color=orange&group=sum&units=null"></img></a> + <a href="https://registry.my-netdata.io/#mysql_local_issues"><img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=mysql_local.join_issues&dimensions=scan&after=-3600&label=full%20table%20scans%20the%20last%20hour&value_color=orange&group=sum&units=null"></img></a> --- @@ -46,13 +46,13 @@ The basic URL is `http://your.netdata:19999/api/v1/badge.svg?option1&option2&opt Here is what you can put for `options` (these are standard Netdata API options): -- `chart=CHART.NAME` +- `chart=CHART.NAME` - The chart to get the values from. + The chart to get the values from. - **This is the only parameter required** and with just this parameter, Netdata will return the sum of the latest values of all chart dimensions. + **This is the only parameter required** and with just this parameter, Netdata will return the sum of the latest values of all chart dimensions. - Example: + Example: ```html <a href="#"> @@ -66,21 +66,21 @@ Here is what you can put for `options` (these are standard Netdata API options): <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu"></img> </a> -- `alarm=NAME` +- `alarm=NAME` - Render the current value and status of an alarm linked to the chart. This option can be ignored if the badge to be generated is not related to an alarm. + Render the current value and status of an alarm linked to the chart. This option can be ignored if the badge to be generated is not related to an alarm. - The current value of the alarm will be rendered. The color of the badge will indicate the status of the alarm. + The current value of the alarm will be rendered. The color of the badge will indicate the status of the alarm. - For alarm badges, **both `chart` and `alarm` parameters are required**. + For alarm badges, **both `chart` and `alarm` parameters are required**. -- `dimensions=DIMENSION1|DIMENSION2|...` +- `dimensions=DIMENSION1|DIMENSION2|...` - The dimensions of the chart to use. If you don't set any dimension, all will be used. When multiple dimensions are used, Netdata will sum their values. You can append `options=absolute` if you want this sum to convert all values to positive before adding them. + The dimensions of the chart to use. If you don't set any dimension, all will be used. When multiple dimensions are used, Netdata will sum their values. You can append `options=absolute` if you want this sum to convert all values to positive before adding them. - Pipes in HTML have to escaped with `%7C`. + Pipes in HTML have to escaped with `%7C`. - Example: + Example: ```html <a href="#"> @@ -94,15 +94,15 @@ Here is what you can put for `options` (these are standard Netdata API options): <img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=system.cpu&dimensions=system%7Cnice"></img> </a> -- `before=SECONDS` and `after=SECONDS` +- `before=SECONDS` and `after=SECONDS` - The timeframe. These can be absolute unix timestamps, or relative to now, number of seconds. By default `before=0` and `after=-1` (1 second in the past). + The timeframe. These can be absolute unix timestamps, or relative to now, number of seconds. By default `before=0` and `after=-1` (1 second in the past). - To get the last minute set `after=-60`. This will give the average of the last complete minute (XX:XX:00 - XX:XX:59). + To get the last minute set `after=-60`. This will give the average of the last complete minute (XX:XX:00 - XX:XX:59). - To get the max of the last hour set `after=-3600&group=max`. This will give the maximum value of the last complete hour (XX:00:00 - XX:59:59) + To get the max of the last hour set `after=-3600&group=max`. This will give the maximum value of the last complete hour (XX:00:00 - XX:59:59) - Example: + Example: ```html <a href="#"> @@ -125,103 +125,102 @@ Here is what you can put for `options` (these are standard Netdata API options): ``` It produces this: - + <a href="#"> <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` +- `group=min` or `group=max` or `group=average` (the default) or `group=sum` or `group=incremental-sum` - If Netdata will have to reduce (aggregate) the data to calculate the value, which aggregation method to use. + If Netdata will have to reduce (aggregate) the data to calculate the value, which aggregation method to use. - - `max` will find the max value for the timeframe. This works on both positive and negative dimensions. It will find the most extreme value. + - `max` will find the max value for the timeframe. This works on both positive and negative dimensions. It will find the most extreme value. - - `min` will find the min value for the timeframe. This works on both positive and negative dimensions. It will find the number closest to zero. + - `min` will find the min value for the timeframe. This works on both positive and negative dimensions. It will find the number closest to zero. - - `average` will calculate the average value for the timeframe. + - `average` will calculate the average value for the timeframe. - - `sum` will sum all the values for the timeframe. This is nice for finding the volume of dimensions for a timeframe. So if you have a dimension that reports `X per second`, you can find the volume of the dimension in a timeframe, by adding its values in that timeframe. + - `sum` will sum all the values for the timeframe. This is nice for finding the volume of dimensions for a timeframe. So if you have a dimension that reports `X per second`, you can find the volume of the dimension in a timeframe, by adding its values in that timeframe. - - `incremental-sum` will sum the difference of each value to its next. Let's assume you have a dimension that does not measure the rate of something, but the absolute value of it. So it has values like this "1, 5, 3, 7, 4". `incremental-sum` will calculate the difference of adjacent values. In this example, they will be `(5 - 1) + (3 - 5) + (7 - 3) + (4 - 7) = 3` (which is equal to the last value minus the first = 4 - 1). + - `incremental-sum` will sum the difference of each value to its next. Let's assume you have a dimension that does not measure the rate of something, but the absolute value of it. So it has values like this "1, 5, 3, 7, 4". `incremental-sum` will calculate the difference of adjacent values. In this example, they will be `(5 - 1) + (3 - 5) + (7 - 3) + (4 - 7) = 3` (which is equal to the last value minus the first = 4 - 1). -- `options=opt1|opt2|opt3|...` +- `options=opt1|opt2|opt3|...` - These fine tune various options of the API. Here is what you can use for badges (the API has more option, but only these are useful for badges): + These fine tune various options of the API. Here is what you can use for badges (the API has more option, but only these are useful for badges): - - `percentage`, instead of returning the value, calculate the percentage of the sum of the selected dimensions, versus the sum of all the dimensions of the chart. This also sets the units to `%`. + - `percentage`, instead of returning the value, calculate the percentage of the sum of the selected dimensions, versus the sum of all the dimensions of the chart. This also sets the units to `%`. - - `absolute` or `abs`, turn all values positive and then sum them. + - `absolute` or `abs`, turn all values positive and then sum them. - - `display_absolute` or `display-absolute`, to use the signed value during color calculation, but display the absolute value on the badge. + - `display_absolute` or `display-absolute`, to use the signed value during color calculation, but display the absolute value on the badge. - - `min2max`, when multiple dimensions are given, do not sum them, but take their `max - min`. + - `min2max`, when multiple dimensions are given, do not sum them, but take their `max - min`. - - `unaligned`, when data are reduced / aggregated (e.g. the request is about the average of the last minute, or hour), Netdata by default aligns them so that the charts will have a constant shape (so average per minute returns always XX:XX:00 - XX:XX:59). Setting the `unaligned` option, Netdata will aggregate data without any alignment, so if the request is for 60 seconds, it will aggregate the latest 60 seconds of collected data. + - `unaligned`, when data are reduced / aggregated (e.g. the request is about the average of the last minute, or hour), Netdata by default aligns them so that the charts will have a constant shape (so average per minute returns always XX:XX:00 - XX:XX:59). Setting the `unaligned` option, Netdata will aggregate data without any alignment, so if the request is for 60 seconds, it will aggregate the latest 60 seconds of collected data. These are options dedicated to badges: -- `label=TEXT` - - The label of the badge. +- `label=TEXT` -- `units=TEXT` + The label of the badge. - The units of the badge. If you want to put a `/`, please put a `\`. This is because Netdata allows badges parameters to be given as path in URL, instead of query string. You can also use `null` or `empty` to show it without any units. +- `units=TEXT` - The units `seconds`, `minutes` and `hours` trigger special formatting. The value has to be in this unit, and Netdata will automatically change it to show a more pretty duration. + The units of the badge. If you want to put a `/`, please put a `\`. This is because Netdata allows badges parameters to be given as path in URL, instead of query string. You can also use `null` or `empty` to show it without any units. -- `multiply=NUMBER` + The units `seconds`, `minutes` and `hours` trigger special formatting. The value has to be in this unit, and Netdata will automatically change it to show a more pretty duration. - Multiply the value with this number. The default is `1`. +- `multiply=NUMBER` -- `divide=NUMBER` + Multiply the value with this number. The default is `1`. - Divide the value with this number. The default is `1`. +- `divide=NUMBER` -- `label_color=COLOR` + Divide the value with this number. The default is `1`. - The color of the label (the left part). You can use any HTML color, include `#NNN` and `#NNNNNN`. The following colors are defined in Netdata (and you can use them by name): `green`, `brightgreen`, `yellow`, `yellowgreen`, `orange`, `red`, `blue`, `grey`, `gray`, `lightgrey`, `lightgray`. These are taken from https://github.com/badges/shields so they are compatible with standard badges. +- `label_color=COLOR` -- `value_color=COLOR:null|COLOR<VALUE|COLOR>VALUE|COLOR>=VALUE|COLOR<=VALUE|...` + The color of the label (the left part). You can use any HTML color, include `#NNN` and `#NNNNNN`. The following colors are defined in Netdata (and you can use them by name): `green`, `brightgreen`, `yellow`, `yellowgreen`, `orange`, `red`, `blue`, `grey`, `gray`, `lightgrey`, `lightgray`. These are taken from <https://github.com/badges/shields> so they are compatible with standard badges. - You can add a pipe delimited list of conditions to pick the color. The first matching (left to right) will be used. +- `value_color=COLOR:null|COLOR<VALUE|COLOR>VALUE|COLOR>=VALUE|COLOR<=VALUE|...` - Example: `value_color=grey:null|green<10|yellow<100|orange<1000|blue<10000|red` + You can add a pipe delimited list of conditions to pick the color. The first matching (left to right) will be used. - The above will set `grey` if no value exists (not collected within the `gap when lost iterations above` in `netdata.conf` for the chart), `green` if the value is less than 10, `yellow` if the value is less than 100, etc up to `red` which will be used if no other conditions match. + Example: `value_color=grey:null|green<10|yellow<100|orange<1000|blue<10000|red` - The supported operators are `<`, `>`, `<=`, `>=`, `=` (or `:`) and `!=` (or `<>`). + The above will set `grey` if no value exists (not collected within the `gap when lost iterations above` in `netdata.conf` for the chart), `green` if the value is less than 10, `yellow` if the value is less than 100, etc up to `red` which will be used if no other conditions match. -- `precision=NUMBER` + The supported operators are `<`, `>`, `<=`, `>=`, `=` (or `:`) and `!=` (or `<>`). - The number of decimal digits of the value. By default Netdata will add: +- `precision=NUMBER` - - no decimal digits for values > 1000 - - 1 decimal digit for values > 100 - - 2 decimal digits for values > 1 - - 3 decimal digits for values > 0.1 - - 4 decimal digits for values <= 0.1 + The number of decimal digits of the value. By default Netdata will add: - Using the `precision=NUMBER` you can set your preference per badge. + - no decimal digits for values > 1000 + - 1 decimal digit for values > 100 + - 2 decimal digits for values > 1 + - 3 decimal digits for values > 0.1 + - 4 decimal digits for values \<= 0.1 -- `scale=XXX` + Using the `precision=NUMBER` you can set your preference per badge. - 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: +- `scale=XXX` - <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` + 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="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` +- `refresh=auto` or `refresh=SECONDS` - This option enables auto-refreshing of images. Netdata will send the HTTP header `Refresh: SECONDS` to the web browser, thus requesting automatic refresh of the images at regular intervals. + This option enables auto-refreshing of images. Netdata will send the HTTP header `Refresh: SECONDS` to the web browser, thus requesting automatic refresh of the images at regular intervals. - `auto` will calculate the proper `SECONDS` to avoid unnecessary refreshes. If `SECONDS` is zero, this feature is disabled (it is also disabled by default). + `auto` will calculate the proper `SECONDS` to avoid unnecessary refreshes. If `SECONDS` is zero, this feature is disabled (it is also disabled by default). - Auto-refreshing like this, works only if you access the badge directly. So, you may have to put it an `embed` or `iframe` for it to be auto-refreshed. Use something like this: + Auto-refreshing like this, works only if you access the badge directly. So, you may have to put it an `embed` or `iframe` for it to be auto-refreshed. Use something like this: ```html <embed src="BADGE_URL" type="image/svg+xml" height="20" /> @@ -251,37 +250,37 @@ A more advanced badges refresh method is to include `http://your.netdata.ip:1999 Keep in mind that if you add badge URLs to your HTML pages you have to escape the special characters: -character|name|escape sequence -:-------:|:--:|:-------------: -` `|space (in labels and units)|`%20` -` # `|hash (for colors)|`%23` -` % `|percent (in units)|`%25` -` < `|less than|`%3C` -` > `|greater than|`%3E` -` \ `|backslash (when you need a `/`)|`%5C` -` \| `|pipe (delimiting parameters)|`%7C` +|character|name|escape sequence| +|:-------:|:--:|:-------------:| +|``|space (in labels and units)|`%20`| +|`#`|hash (for colors)|`%23`| +|`%`|percent (in units)|`%25`| +|`<`|less than|`%3C`| +|`>`|greater than|`%3E`| +|`\`|backslash (when you need a `/`)|`%5C`| +|`\|`|pipe (delimiting parameters)|`%7C`| ## FAQ #### Is it fast? + On modern hardware, Netdata can generate about **2.000 badges per second per core**, before noticing any delays. It generates a badge in about half a millisecond! Of course these timing are for badges that use recent data. If you need badges that do calculations over long durations (a day, or more), timing will differ. Netdata logs its timings at its `access.log`, so take a look there before adding a heavy badge on a busy web site. Of course, you can cache such badges or have a cron job get them from Netdata and save them at your web server at regular intervals. - #### Embedding badges in github You have 2 options a) SVG images with markdown and b) SVG images with HTML (directly in .md files). For example, this is the cpu badge shown above: -- Markdown example: +- Markdown example: ```md [](https://registry.my-netdata.io/#apps_cpu) ``` -- HTML example: +- HTML example: ```html <a href="https://registry.my-netdata.io/#apps_cpu"> @@ -305,4 +304,4 @@ You can refresh them from your browser console though. Press F12 to open the web var len = document.images.length; while(len--) { document.images[len].src = document.images[len].src.replace(/\?cacheBuster=\d*/, "") + "?cacheBuster=" + new Date().getTime().toString(); }; ``` -[]() +[](<>) diff --git a/web/api/exporters/README.md b/web/api/exporters/README.md index ff711d7e15..2cbb037cde 100644 --- a/web/api/exporters/README.md +++ b/web/api/exporters/README.md @@ -2,4 +2,4 @@ TBD -[]() +[](<>) diff --git a/web/api/exporters/prometheus/README.md b/web/api/exporters/prometheus/README.md index 8c4f2b4efe..9b2367cce1 100644 --- a/web/api/exporters/prometheus/README.md +++ b/web/api/exporters/prometheus/README.md @@ -2,4 +2,4 @@ The prometheus exporter for Netdata is located at the [backends section for prometheus](../../../../backends/prometheus). -[]() +[](<>) diff --git a/web/api/exporters/shell/README.md b/web/api/exporters/shell/README.md index 90ad915821..fef253c8e1 100644 --- a/web/api/exporters/shell/README.md +++ b/web/api/exporters/shell/README.md @@ -63,4 +63,4 @@ NETDATA_${chart_id^^}_${dimension_id^^}="${value}" The value is rounded to the closest integer, since shell script cannot process decimal numbers. -[]() +[](<>) diff --git a/web/api/formatters/README.md b/web/api/formatters/README.md index 4c361bb13f..037fb53462 100644 --- a/web/api/formatters/README.md +++ b/web/api/formatters/README.md @@ -5,20 +5,20 @@ Using API parameters, the caller may define the format he/she wishes to get back The following formats are supported: -format|module|content type|description -:---:|:---:|:---:|:----- -`array`|[ssv](ssv)|application/json|a JSON array -`csv`|[csv](csv)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines -`csvjsonarray`|[csv](csv)|application/json|a JSON array, with each row as another array (the first row has the dimension names) -`datasource`|[json](json)|application/json|a Google Visualization Provider `datasource` javascript callback -`datatable`|[json](json)|application/json|a Google `datatable` -`html`|[csv](csv)|text/html|an html table -`json`|[json](json)|application/json|a JSON object -`jsonp`|[json](json)|application/json|a JSONP javascript callback -`markdown`|[csv](csv)|text/plain|a markdown table -`ssv`|[ssv](ssv)|text/plain|a space separated list of values -`ssvcomma`|[ssv](ssv)|text/plain|a comma separated list of values -`tsv`|[csv](csv)|text/plain|a TAB delimited `csv` (MS Excel flavor) +| format|module|content type|description| +|:----:|:----:|:----------:|:----------| +| `array`|[ssv](ssv)|application/json|a JSON array| +| `csv`|[csv](csv)|text/plain|a text table, comma separated, with a header line (dimension names) and `\r\n` at the end of the lines| +| `csvjsonarray`|[csv](csv)|application/json|a JSON array, with each row as another array (the first row has the dimension names)| +| `datasource`|[json](json)|application/json|a Google Visualization Provider `datasource` javascript callback| +| `datatable`|[json](json)|application/json|a Google `datatable`| +| `html`|[csv](csv)|text/html|an html table| +| `json`|[json](json)|application/json|a JSON object| +| `jsonp`|[json](json)|application/json|a JSONP javascript callback| +| `markdown`|[csv](csv)|text/plain|a markdown table| +| `ssv`|[ssv](ssv)|text/plain|a space separated list of values| +| `ssvcomma`|[ssv](ssv)|text/plain|a comma separated list of values| +| `tsv`|[csv](csv)|text/plain|a TAB delimited `csv` (MS Excel flavor)| For examples of each format, check the relative module documentation. @@ -67,8 +67,7 @@ the result and save it under a given filename. For example, to download a CSV file with CPU utilization of the last hour, [click here](https://registry.my-netdata.io/api/v1/data?chart=system.cpu&after=-3600&format=csv&options=nonzero&tqx=outFileName:system+cpu+utilization+of+the+last_hour.csv). - This is done by appending `&tqx=outFileName:FILENAME` to any data query. The output will be in the format given with `&format=`. -[]() +[](<>) diff --git a/web/api/formatters/csv/README.md b/web/api/formatters/csv/README.md index 995e740b8c..0d16fc4ec1 100644 --- a/web/api/formatters/csv/README.md +++ b/web/api/formatters/csv/README.md |