Skip to content

Commit

Permalink
chore(docs): Add spec for listen option (vectordotdev#18080)
Browse files Browse the repository at this point in the history
* chore(docs): Add spec for `listen` option

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

* Update docs/specs/component.md

Co-authored-by: neuronull <neuronull@pm.me>

---------

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
Co-authored-by: neuronull <neuronull@pm.me>
  • Loading branch information
jszwedko and neuronull authored Oct 3, 2023
1 parent f9e51e1 commit 29e5e22
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/specs/component.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<protocol>:<address>`.

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 `<host>:<port>`
- `udp`, where `address` should be `<host>:<port>`

Components MAY have a default protocol. For example, a `statsd` component may default the protocol
to `udp` and only require the `<host>:<port>` to bind to.

## Instrumentation

**Extends the [Instrumentation Specification].**
Expand Down

0 comments on commit 29e5e22

Please sign in to comment.