Skip to content

Commit

Permalink
Fix typo in README.md (#267)
Browse files Browse the repository at this point in the history
updSocketOptions are set when protocol is `udp` not `uds`. Simple fix!
  • Loading branch information
tebriel authored Sep 7, 2024
1 parent b442244 commit 37b12b6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Parameters (specified as one object passed into hot-shots):
* `udsGracefulErrorHandling`: Used only when the protocol is `uds`. Boolean indicating whether to handle socket errors gracefully. Defaults to true.
* `udsGracefulRestartRateLimit`: Used only when the protocol is `uds`. Time (ms) between re-creating the socket. Defaults to `1000`.
* `closingFlushInterval`: Before closing, StatsD will check for inflight messages. Time (ms) between each check. Defaults to `50`.
* `udpSocketOptions`: Used only when the protocol is `uds`. Specify the options passed into dgram.createSocket(). Defaults to `{ type: 'udp4' }`
* `udpSocketOptions`: Used only when the protocol is `udp`. Specify the options passed into dgram.createSocket(). Defaults to `{ type: 'udp4' }`

### StatsD methods
All StatsD methods other than `event`, `close`, and `check` have the same API:
Expand Down

0 comments on commit 37b12b6

Please sign in to comment.