Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Add spec for listen option #18080

Merged
merged 2 commits into from
Oct 4, 2023
Merged

chore(docs): Add spec for listen option #18080

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8f01d3
chore(docs): Add spec for `listen` option
jszwedko Jul 25, 2023
a47dffb
Update docs/specs/component.md
jszwedko Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/specs/component.md
View file
Open in desktop
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>`.
spencergilbert marked this conversation as resolved.
Show resolved Hide resolved

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