Skip to content

Commit

Permalink
📝 Update memo
Browse files Browse the repository at this point in the history
  • Loading branch information
budougumi0617 committed Jan 12, 2021
1 parent 00ad0f3 commit 7af196c
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,10 @@ func IgnoreHandler(w http.ResponseWriter, req *http.Request) {
- [x] This processing is recursively repeated.
- [x] Able to ignore function/method by `nrseg:ignore` comment.
- [x] Ignore specified directories with cli option `-i`/`-ignore`.
- [ ] Remove all `Function segments`.
- [ ] Remove all `Function segments`
- [ ] Add: `dry-run` option
- [ ] Validate: Show a function that doesn't call the segment.
- [ ] Support anonymous function

## Synopsis
```
Expand All @@ -131,6 +134,24 @@ exit status 1
```

## Limitation
nrseg inserts only `function segments`, so we need the initialize of Newrelic manually.

- [Install New Relic for Go][segment]
- [Monitor a transaction by wrapping an HTTP handler][nr_handler]

[nr_handler]: https://docs.newrelic.com/docs/agents/go-agent/instrumentation/instrument-go-transactions#http-handler-txns
[segment]: https://docs.newrelic.com/docs/agents/go-agent/installation/install-new-relic-go

If we want to adopt Newrelic to our application, , we write initialize, and newrelic.WrapHandleFunc manually before execute this tool.
```go
app, err := newrelic.NewApplication(
newrelic.ConfigAppName("my_application"),
newrelic.ConfigLicense(newrelicLicenseKey),
newrelic.ConfigDistributedTracerEnabled(true),
)
```

## Installation

```
Expand Down

0 comments on commit 7af196c

Please sign in to comment.