socks client

The socks client binding encodes outbound application streams as SOCKS5 proxy connections to a remote server.

Configuration (* required)

options

object

The socks client specific options.

options.address

string

SOCKS5 proxy server address.

routes

array

Conditional socks specific routes.

routes[].guarded

object as map of named array of string

List of roles required by each named guard to authorize this route.

routes[].when

array

List of conditions (any match) to match this route. Read more: When a route matches

when[].connect

string

Target address to connect to via the SOCKS5 proxy.

routes[].with

object

Route with override configuration.

routes[].exit

string

Next binding when following this route.

exit

string

Default exit binding when no conditional routes are viable.

exit: echo_server

telemetry

object

Defines the desired telemetry for the binding.

telemetry.metrics

array

Telemetry metrics to track

telemetry:
  metrics:
    - stream.*

telemetry.attributes

object as map of named string properties

Telemetry attributes to add to the binding metrics.

telemetry.attributes

object as map of named string properties

Telemetry attributes for this binding.