User Site

The user site config is in map format. We can set how to match this site, enable site level metrics, or do any other site level config.

id

required, type: metric node name

Each site should have an ID, and it will be used in metrics name if enabled.

exact_match

optional, type: host

Set the exact domain or the exact target IP in user request which we should match.

Note

the value should be different within all sites config of the current user.

child_match

optional, type: domain

Set the parent domain and all it’s child domains will be matched.

Note

the value should be different within all sites config of the current user.

subnet_match

optional, type: ip network str

Set the network to match if the target is IP address in user request.

Note

the value should be different within all sites config of the current user.

emit_stats

optional, type: bool

Set whether we should emit site level stats for this site.

See user site metrics for the definition of metrics.

default: false

duration_stats

optional, type: histogram metrics

Histogram metrics config for the site level duration stats.

default: set with default value

Added in version 1.7.32.

resolve_strategy

optional, type: resolve strategy

Set a custom resolve strategy at user-site level, which will override the one at user level, but still within the range of the one set on the escaper. Not all escapers support this, see the documentation for each escaper for more info.

default: not custom resolve strategy is set

Added in version 1.7.10.

tls_client

optional, type: tls client

Set the tls client config for server handshake in TLS interception.

This will overwrite:

  • auditor tls_interception_client <conf_auditor_tls_interception_client> if tls interception is enabled

  • http_proxy server tls_client <conf_server_http_proxy_tls_client> if https forward is enabled

default: not set

Added in version 1.9.0.

http_rsp_header_recv_timeout

optional, type: humanize duration

Set a custom http response receive timeout value for this site.

This will set and overwrite:

default: not set

Added in version 1.9.0.