Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-04 16:51:11 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

make docs-update-version
Some checks failed
build / Build (push) Has been cancelled
Details
CodeQL Go / Analyze (push) Has been cancelled
Details
CodeQL JS/TS / Analyze (push) Has been cancelled
Details
main / lint (push) Has been cancelled
Details
publish-docs / Build (push) Has been cancelled
Details
main / test (test-full) (push) Has been cancelled
Details
main / test (test-full-386) (push) Has been cancelled
Details
main / test (test-pure) (push) Has been cancelled
Details
main / integration-test (push) Has been cancelled
Details

Browse Source
This commit is contained in:
f41gh7 2024-11-29 17:45:18 +01:00
parent 5bf2d6a689
commit 6d0420b454
No known key found for this signature in database
GPG Key ID: 4558311CF775EC72
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -341,7 +341,7 @@ VictoriaMetrics provides UI for query troubleshooting and exploration. The UI is
(or at `http://<vmselect>:8481/select/<accountID>/vmui/` in [cluster version of VictoriaMetrics](https://docs.victoriametrics.com/cluster-victoriametrics/)). (or at `http://<vmselect>:8481/select/<accountID>/vmui/` in [cluster version of VictoriaMetrics](https://docs.victoriametrics.com/cluster-victoriametrics/)).
The UI allows exploring query results via graphs and tables. It also provides the following features: The UI allows exploring query results via graphs and tables. It also provides the following features:
- View [raw samples](https://docs.victoriametrics.com/keyconcepts/#raw-samples) via `Raw Query` tab {{% available_from "#" %}}. Helps in debugging of [unexpected query results](https://docs.victoriametrics.com/troubleshooting/#unexpected-query-results). - View [raw samples](https://docs.victoriametrics.com/keyconcepts/#raw-samples) via `Raw Query` tab {{% available_from "v1.107.0" %}}. Helps in debugging of [unexpected query results](https://docs.victoriametrics.com/troubleshooting/#unexpected-query-results).
- Explore: - Explore:
- [Metrics explorer](#metrics-explorer) - automatically builds graphs for selected metrics; - [Metrics explorer](#metrics-explorer) - automatically builds graphs for selected metrics;
- [Cardinality explorer](#cardinality-explorer) - stats about existing metrics in TSDB; - [Cardinality explorer](#cardinality-explorer) - stats about existing metrics in TSDB;

8
docs/vmauth.md
View File

@ -380,7 +380,7 @@ See also [security docs](#security), [routing docs](#routing) and [load balancin
- [Multiple parts](#routing-by-multiple-parts) - [Multiple parts](#routing-by-multiple-parts)
See also [authorization](#authorization) and [load balancing](#load-balancing). See also [authorization](#authorization) and [load balancing](#load-balancing).
For debug purposes, extra logging for failed requests can be enabled by setting `dump_request_on_errors: true` {{% available_from "#" %}} For debug purposes, extra logging for failed requests can be enabled by setting `dump_request_on_errors: true` {{% available_from "v1.107.0" %}}
on user level. Please note, such logging may expose sensitive info and is recommended to use only for debugging. on user level. Please note, such logging may expose sensitive info and is recommended to use only for debugging.
### Routing by path ### Routing by path
@ -827,9 +827,9 @@ users:
allow_list: [127.0.0.1] allow_list: [127.0.0.1]
``` ```
By default, the client's TCP address is utilized for IP filtering. In scenarios where `vmauth` operates behind a reverse proxy, it is advisable to configure `vmauth` to retrieve the client IP address from an [HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For) (e.g., `X-Forwarded-For`) {{% available_from "#" %}} or via the [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) for TCP load balancers. This can be achieved using the global configuration flags: By default, the client's TCP address is utilized for IP filtering. In scenarios where `vmauth` operates behind a reverse proxy, it is advisable to configure `vmauth` to retrieve the client IP address from an [HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For) (e.g., `X-Forwarded-For`) {{% available_from "v1.107.0" %}} or via the [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) for TCP load balancers. This can be achieved using the global configuration flags:
* `-httpRealIPHeader=X-Forwarded-For` {{% available_from "#" %}} * `-httpRealIPHeader=X-Forwarded-For` {{% available_from "v1.107.0" %}}
* `-httpListenAddr.useProxyProtocol=true` * `-httpListenAddr.useProxyProtocol=true`
### Security Considerations ### Security Considerations
@ -842,7 +842,7 @@ By default, the client's TCP address is utilized for IP filtering. In scenarios
See additional recommendations at [link](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#security_and_privacy_concerns) See additional recommendations at [link](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#security_and_privacy_concerns)
### Per-User Configuration ### Per-User Configuration
The values of `httpRealIPHeader` {{% available_from "#" %}} can be changed on a per-user basis within the user-specific configuration. The values of `httpRealIPHeader` {{% available_from "v1.107.0" %}} can be changed on a per-user basis within the user-specific configuration.
```yaml ```yaml
users: users: