Skip to content

Commit 147249c

Browse files
docs(readme): add rate limiter settings section
1 parent ba761de commit 147249c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,26 @@ The format of the file is described in the
411411

412412
</details>
413413

414+
<details>
415+
<summary>Rate Limiting</summary>
416+
417+
Since v0.18.5 SQL Exporter supports rate limiting for incoming requests to the HTTP endpoints.
418+
419+
To use rate limiting for incoming requests, you need to pass a configuration file using the `--web.config.file`
420+
parameter. In the configuration file you need to specify rate limiting settings as in the example below:
421+
```yaml
422+
...
423+
rate_limit:
424+
interval: "1s" # time interval between two requests, set to 0 to disable rate limiter
425+
burst: 20 # and permits a burst of up to 20 requests.
426+
...
427+
```
428+
429+
The format of the file is described in the
430+
[exporter-toolkit](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) repository.
431+
</details>
432+
433+
414434
If you have an issue using sql_exporter, please check [Discussions](https://github.com/burningalchemist/sql_exporter/discussions) or
415435
closed [Issues](https://github.com/burningalchemist/sql_exporter/issues?q=is%3Aissue+is%3Aclosed) first. Chances are
416436
someone else has already encountered the same problem and there is a solution. If not, feel free to create a new

0 commit comments

Comments
 (0)