Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Adding README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 29, 2020
Merged

Adding README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
debug is a simple library for Go that allows you to optionally debug your executable based on env variables.

# Usage

Simply add debug.Self() to your main function as shown below:

```
import (
"github.com/edwarnicke/debug"
)

func main() {
if err := debug.Self(); err != nil {
log.Infof("%s", err)
}
...
}
```

will cause your application to log out:

```
Setting env variable DLV_LISTEN_{{executable name}} to a valid dlv '--listen' value will cause the dlv debugger to execute this binary and listen as directed.
```

thus informing you of what env variable to set to a valid dlv listener value to trigger debugging.

So if your application where named 'forwarder', you'd see:

```
Setting env variable DLV_LISTEN_FORWARDER to a valid dlv '--listen' value will cause the dlv debugger to execute this binary and listen as directed.
```

and setting the env variable:

```
export DLV_LISTEN_FORWARDER=:50000
```

would cause your applicaton to exec itself over with dlv with arguments to run the application itself.