Update README.md #152
Merged
Update README.md #152
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
rhcarvalho
commented
Jan 28, 2020
|
|
||
| ## Usage | ||
|
|
||
| By default, Sentry Go SDK uses asynchronous transport, which in the code example below requires an explicit awaiting for event delivery to be finished using `sentry.Flush` method. It is necessary, because otherwise the program would not wait for the async HTTP calls to return a response, and exit the process immediately when it reached the end of the `main` function. It would not be required inside a running goroutine or if you would use `HTTPSyncTransport`, which you can read about in `Transports` section. |
There was a problem hiding this comment.
Here I try to clarify when and why Flush needs to be called.
| > before terminating the program, arrange for `sentry.Flush` to be called before | ||
| > the program terminates. | ||
|
|
||
| Example: | ||
|
|
||
| ```go |
There was a problem hiding this comment.
The example now:
- Can be built with a Go compiler;
- Does something realistic;
- Has comments teasing out details (maybe something else needs to be called out?);
- Avoids the
sentry.CaptureExceptionfollowed bysentry.Flushanti-pattern. Typically,sentry.Flushshall only be called once during termination.
There was a problem hiding this comment.
@bruno-garcia could I get your 👀 onto this example, please? Might be easier to read it in https://github.com/getsentry/sentry-go/blob/aac7497bdcff2cdb5d069ee6ae5aeb0aee49e014/README.md#usage
|
|
||
| ## Community | ||
|
|
||
| Join Sentry's [`#go` channel on Discord](https://discord.gg/Ww9hbqr) to get involved and help us improve the SDK! |
| @@ -103,8 +173,11 @@ For more detailed information about how to get the most out of `sentry-go` there | |||
|
|
|||
| ## License | |||
|
|
|||
| Licensed under the BSD license, see `LICENSE` | |||
| @@ -0,0 +1,156 @@ | |||
| package main | |||
There was a problem hiding this comment.
This is the old example/basic/main.go unchanged.
| @@ -1,156 +1,53 @@ | |||
| // This is an example program that makes an HTTP request and prints response | |||
There was a problem hiding this comment.
This is fresh new code for a "basic" example. The same code is used in the repo's README.md file.
3 tasks
bruno-garcia
previously approved these changes
Jan 29, 2020
rhcarvalho
commented
Jan 29, 2020
README.md
Outdated
Comment on lines
121
to
122
| // Either set your DSN here or set the SENTRY_DSN environment variable. | ||
| Dsn: "", | ||
| // Enable printing of SDK debug messages. Useful when getting started or | ||
| // trying to figure something out. | ||
| Debug: true, |
There was a problem hiding this comment.
@bruno-garcia this is my second take. Good Developer eXperience for you?
|
@kamilogorek I'd like your input here, specially the updated example that goes into the front-facing README. Thanks! |
kamilogorek
reviewed
Jan 30, 2020
kamilogorek
reviewed
Jan 30, 2020
kamilogorek
reviewed
Jan 30, 2020
kamilogorek
reviewed
Jan 30, 2020
Move existing "basic" example into new directory.
Main points: - Rewrite Go version requirements to avoid constant manual maintenance: we don't need to list out version numbers explicitly. - Add links where they might be helpful. - Clarify configuration and usage sections. Use a simple example that people can copy from as a starting point.
|
Let's get this in as an incremental improvement. |
rhcarvalho
added a commit
to rhcarvalho/sentry-docs
that referenced
this pull request
Feb 2, 2020
Matching changes from getsentry/sentry-go#152.
rhcarvalho
added a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 3, 2020
Matching changes from getsentry/sentry-go#152.
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.
Clarify usage of
sentry.Flushwith a simple and realistic code example, plus some miscellaneous changes.Related to #106.