revamp docs #85
Merged
revamp docs #85
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
truthbk
reviewed
Apr 9, 2019
README.md
Outdated
|
|
||
| When transporting DogStatsD datagram over UDS, two modes are available, "blocking" and "asynchronous". | ||
|
|
||
| "blocking" allows for error checking but does not guarantee that calls to the library will return instantly. For example `client.Gauge(...)` might take 50ms or more to complete. If used in a hot path of your application, this behavior might significantly impact your performance. |
There was a problem hiding this comment.
Two small change suggestions:
s/instantly/immediately
and:
...might take and arbitrary amount of time to complete depending on server performance and load...
or something along those lines.
Finally:
...this behavior might significantly impact its performance.
Trying to highlight the impact would be on the application.
README.md
Outdated
| "asynchronous" does not allow for error checking but guarantees that calls are instantaneous (<1ms). This is similar to UDP behavior. | ||
|
|
||
| Currently, in 2.x, "blocking" is the default behavior to ensure backward compatibility. To use the "asynchronous" behavior, use the `statsd.WithAsyncUDS()` option. | ||
| **Version 3.0 will drop support for the blocking mode.** As such, we suggest enabling the "asynchronous" mode. |
There was a problem hiding this comment.
Can we commit to this? Is this something that makes sense to disclose here and now?
README.md
Outdated
|
|
||
| ## Performance / Metric drops | ||
|
|
||
| If you plan on sending metrics at a significant rate using this client, depending on your use case, you might need to configure the client and the agent to improve the performance and/or avoid dropping metrics. |
There was a problem hiding this comment.
I would maybe precise a little further:
...you might need to configure the client and the datadog agent (dogstatsd server) to improve the performance...
README.md
Outdated
|
|
||
| ### Tweaking kernel options | ||
|
|
||
| In very high throughput environments it is possible to improve things even further by changing the values of some kernel options. |
There was a problem hiding this comment.
nit: ...improve performance further by changing...
truthbk
reviewed
Apr 9, 2019
README.md
Outdated
| @@ -53,7 +53,7 @@ You can use this protocol by giving a `unix:///path/to/dsd.socket` address argum | |||
|
|
|||
| When transporting DogStatsD datagram over UDS, two modes are available, "blocking" and "asynchronous". | |||
|
|
|||
| "blocking" allows for error checking but does not guarantee that calls to the library will return instantly. For example `client.Gauge(...)` might take 50ms or more to complete. If used in a hot path of your application, this behavior might significantly impact your performance. | |||
| "blocking" allows for error checking but does not guarantee that calls to the library will return immediately. For example `client.Gauge(...)` might take and arbitrary amount of time to complete depending on server performance and load. If used in a hot path of your application, this behavior might significantly impact its performance. | |||
README.md
Outdated
| @@ -78,7 +78,7 @@ client, err := statsd.New("127.0.0.1:8125", | |||
|
|
|||
| ### Tweaking kernel options | |||
|
|
|||
| In very high throughput environments it is possible to improve things even further by changing the values of some kernel options. | |||
| In very high throughput environments it is possible to improve performance further by changing by changing the values of some kernel options. | |||
There was a problem hiding this comment.
nit: two by_changing by changing (it's repeated).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do
statsd/READMEthe rootREADME. This repo was originally intended to contain all public datadog golang libraries but is now only scoped to the dogstatsd client.