diff --git a/docs/specs/component.md b/docs/specs/component.md index 20e43b4bf5ec3..ff3ff98819244 100644 --- a/docs/specs/component.md +++ b/docs/specs/component.md @@ -84,6 +84,22 @@ representing multiple endpoints. If a component uses multiple options to automatically build the endpoint, then the `endpoint(s)` option MUST override that process. +#### `listen` + +When a component listens for incoming connections, it SHOULD expose a `listen` configuration option that takes +a `string` representing an address with `:
`. + +Options for `protocol` are: + +- `unix+stream`, where `address` should be a file path +- `unix+datagram`, where `address` should be a file path +- `unix`, same as `unix+stream` +- `tcp`, where `address` should be `:` +- `udp`, where `address` should be `:` + +Components MAY have a default protocol. For example, a `statsd` component may default the protocol +to `udp` and only require the `:` to bind to. + ## Instrumentation **Extends the [Instrumentation Specification].**