Skip to content

Commit 71bfa05

Browse files
stats-exporter() editorial (#210)
Small fixes and updates.
2 parents db6f285 + 954a834 commit 71bfa05

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

doc/_admin-guide/060_Sources/153_stats_exporter/000_stats_exporter_source_options.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: stats-exporter() source options
33
id: adm-src--stats-exporter-opt
44
description: >-
5-
The stats-exporter() sources directly can serve the output of syslog-ng-ctl stats and syslog-ng-ctl query to a HTTP Scraper. Unlike the stats-exporter-dont-log() that suppresses log messages from incoming scraper requests, the stats-exporter() logs the unparsed messages, storing incoming scraper HTTP requests in the MSG field.
5+
The stats-exporter() sources directly can serve the output of syslog-ng-ctl stats and syslog-ng-ctl query to an HTTP Scraper. Unlike the stats-exporter-dont-log() that suppresses log messages from incoming scraper requests, the stats-exporter() logs the unparsed messages, storing incoming scraper HTTP requests in the MSG field.
66
---
77

8-
Technically, both sources are specialized versions of the network() source. See the network() source options for details.
8+
Technically, both sources are specialized versions of the network() source. For more options and details, see the network() source options.
99

10-
>**NOTE:** A destination is not required for this source to work; the `stats-exporter()` sources will respond to the scraper regardless of whether a destination is present in the log path.
10+
>**NOTE:** A destination is not required for this source to work; the stats-exporter() sources will respond to the scraper regardless of whether a destination is present in the log path.
1111
{: .notice--info}
1212

1313
These drivers have the following additional options:
@@ -17,43 +17,43 @@ These drivers have the following additional options:
1717
|Accepted values:| query \| stats |
1818
|Default: | stats |
1919

20-
*Description:* The stat type you wish to provide in the response to a HTTP Scraper request, just like for the syslog-ng-ctl command line tool.
20+
*Description:* This option sets the desired stat type to be produced in response to an HTTP Scraper request. This method operates like the syslog-ng-ctl command line tool.
2121

2222
## stat-query()
2323

2424
|Accepted values:| regular expression |
2525
|Default: | |
2626

27-
*Description:* The query regex string that can be used to filter the output of a `query` type request.
27+
*Description:* This option sets the query regex string which can be used to filter the output of a query type request.
2828

2929
## stat-format()
3030

3131
|Accepted values:| csv \| kv \| prometheus |
3232
|Default: | prometheus |
3333

34-
*Description:* Specifies the format of the statistics output in HTTP responses, similar to the options available in syslog-ng-ctl. The available formats are:
34+
*Description:* This option specifies the format of the statistics output in HTTP responses, similar to the options available in syslog-ng-ctl. The available formats are the following:
3535

36-
- csv – comma-separated values format
37-
- kv – key-value pairs, one per line
38-
- prometheus – Prometheus-compatible exposition format
36+
- `csv` – comma-separated values format
37+
- `kv` – key-value pairs, one per line
38+
- `prometheus` – Prometheus-compatible exposition format
3939

4040
## scrape-pattern()
4141

4242
|Accepted values:| regular expression |
43-
|Default: | GET /metrics* |
43+
|Default: | `GET /metrics*` |
4444

45-
*Description:* The pattern used to match the HTTP header of incoming scraping requests. A stat response will be generated and sent only if the header matches the scrape-pattern().
45+
*Description:* This option sets the pattern used to match the HTTP header of incoming scraping requests. A stat response will be generated and sent only if the header matches the one set in the `scrape-pattern()` option.
4646

4747
## scrape-freq-limit()
4848

4949
|Accepted values:| number |
50-
|Default: | 0 |
50+
|Default: | `0` |
5151

52-
*Description:* Limits the frequency of repeated scraper requests to the specified number of seconds. Any repeated request within this period will be ignored. A value of 0 means no limit.
52+
*Description:* This option limits the frequency of repeated scraper requests to the specified number of seconds. Any repeated request within this period will be ignored. A set value of `0` means no limit.
5353

5454
## single-instance()
5555

5656
|Accepted values:| yes \| no |
5757
|Default: | no |
5858

59-
*Description:* If set to `yes` only one scraper connection and request will be allowed at once.
59+
*Description:* If this option is set to `yes`, only one scraper connection and request will be allowed at once.

doc/_admin-guide/060_Sources/153_stats_exporter/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ log {
3030
};
3131
```
3232

33-
Example usage for a generic HTTP Scraper which sends e.g. the `GET /stats HTTP/1.1` HTTP request to get statistics of {{ site.product.short_name }}, do not want to log or further process the HTTP requests in the log pipe, and needs the response in CSV format:
33+
Example usage for a generic HTTP Scraper which sends the `GET /stats HTTP/1.1` HTTP request to get statistics of a {{ site.product.short_name }} system, which is not required to log or further process the HTTP requests in the log pipe, and needs the response in CSV format:
3434

3535
``` config
3636
@version: 4.9
@@ -53,5 +53,5 @@ log {
5353
};
5454
```
5555

56-
>**NOTE:** A destination is not required for this to work; the `stats-exporter()` sources will respond to the scraper regardless of whether a destination is present in the log path.
56+
>**NOTE:** A destination is not required for this to work. The stats-exporter() sources will respond to the scraper regardless of whether a destination is present in the log path or not.
5757
{: .notice--info}

0 commit comments

Comments
 (0)