ws client

The ws client binding converts inbound ws full duplex streams into http request-response streams.

ws_client:
  type: ws
  kind: client

Configuration (* required)

options

object

The ws specific options.

options.defaults

object

Defaults.

defaults.protocol

string

Subprotocol.

defaults.scheme

string

Scheme.

defaults.authority

string

Authority.

defaults.path

string

Path.

routes

array of object

Conditional ws specific routes. At least one of routes or the top-level exit is required.

routes:
  - when:
      - protocol: echo
  exit: echo_server

routes[].guarded

object as map of named array of string

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

routes:
  - guarded:
      my_guard:
        - read:items

routes[].when

array of object

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

routes:
  - when:
      - protocol: echo

when[].protocol

string

Subprotocol pattern.

when[].scheme

string

Scheme pattern.

when[].authority

string

Authority pattern.

when[].path

string

Path pattern.

routes[].exit

string

Next binding when following this route.

routes:
  - when:
    ...
    exit: echo_server

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.