Skip to content

Commit

Permalink
fix confignet README (dialer timeout) (#11686)
Browse files Browse the repository at this point in the history
#### Description
Updates  dialer timeout section documentation in confignet README 

#### Link to tracking issue
Fixes #11685
  • Loading branch information
gpomykala authored Nov 16, 2024
1 parent 8b99b80 commit d59bf0a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .chloggen/confignet-readme.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: all

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Updates dialer timeout section documentation in confignet README

# One or more tracking issues or pull requests related to the change
issues: [11685]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
3 changes: 2 additions & 1 deletion config/confignet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ leverage network configuration to set connection and transport information.
- `transport`: Known protocols are "tcp", "tcp4" (IPv4-only), "tcp6"
(IPv6-only), "udp", "udp4" (IPv4-only), "udp6" (IPv6-only), "ip", "ip4"
(IPv4-only), "ip6" (IPv6-only), "unix", "unixgram" and "unixpacket".
- `dialer_timeout`: DialerTimeout is the maximum amount of time a dial will wait for a connect to complete. The default is no timeout.
- `dialer`: Dialer configuration
- `timeout`: Dialer timeout is the maximum amount of time a dial will wait for a connect to complete. The default is no timeout.

Note that for TCP receivers only the `endpoint` configuration setting is
required.

0 comments on commit d59bf0a

Please sign in to comment.