Skip to content

Commit

Permalink
Merge pull request #216 from sambostock/document-prefix-suffix-separator
Browse files Browse the repository at this point in the history
Document explicit prefix/suffix separators
  • Loading branch information
bdeitte authored Oct 31, 2021
2 parents 8fcb044 + 27947a5 commit 6861da1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Parameters (specified as one object passed into hot-shots):
* `host`: The host to send stats to, if not set, the constructor tries to
retrieve it from the `DD_AGENT_HOST` environment variable, `default: 'undefined'` which as per [UDP/datagram socket docs](https://nodejs.org/api/dgram.html#dgram_socket_send_msg_offset_length_port_address_callback) results in `127.0.0.1` or `::1` being used.
* `port`: The port to send stats to, if not set, the constructor tries to retrieve it from the `DD_DOGSTATSD_PORT` environment variable, `default: 8125`
* `prefix`: What to prefix each stat name with `default: ''`
* `suffix`: What to suffix each stat name with `default: ''`
* `prefix`: What to prefix each stat name with `default: ''`. Note prefix separator must be specified explicitly if desired (e.g. `my_prefix.`).
* `suffix`: What to suffix each stat name with `default: ''`. Note suffix separator must be specified explicitly if desired (e.g. `.my_suffix`).
* `tagPrefix`: Prefix tag list with character `default: '#'`. Note does not work with `telegraf` option.
* `tagSeparator`: Separate tags with character `default: ','`. Note does not work with `telegraf` option.
* `globalize`: Expose this StatsD instance globally. `default: false`
Expand Down

0 comments on commit 6861da1

Please sign in to comment.