-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into readme-header
- Loading branch information
Showing
7 changed files
with
502 additions
and
44 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,22 +4,22 @@ | |
| # New Relic Go Agent [](https://godoc.org/github.com/newrelic/go-agent/v3/newrelic/) [](https://goreportcard.com/report/github.com/newrelic/go-agent) | ||
|
|
||
| The New Relic Go Agent allows you to monitor your Go applications with New | ||
| Relic. It helps you track transactions, outbound requests, database calls, and | ||
| Relic. It helps you track transactions, outbound requests, database calls, and | ||
| other parts of your Go application's behavior and provides a running overview of | ||
| garbage collection, goroutine activity, and memory use. | ||
|
|
||
| Go is a compiled language, and doesn’t use a virtual machine. This means that setting up New Relic for your Golang app requires you to use our Go agent API and manually add New Relic methods to your source code. Our API provides exceptional flexibility and control over what gets instrumented. | ||
|
|
||
| ## Installation | ||
|
|
||
| ## Compatibility and Requirements | ||
| ### Compatibility and Requirements | ||
|
|
||
| For the latest version of the agent, Go 1.7+ is required, due to the use of `context.Context`. | ||
| (For versions 2.X and earlier of the Go agent, Go 1.3+ is required.) | ||
|
|
||
| Linux, OS X, and Windows (Vista, Server 2008 and later) are supported. | ||
|
|
||
|
|
||
| ## Installing and using the Go agent | ||
| ### Installing and using the Go agent | ||
|
|
||
| To install the agent, follow the instructions in our [GETTING_STARTED](https://github.com/newrelic/go-agent/blob/master/GETTING_STARTED.md) | ||
| document or our [GUIDE](https://github.com/newrelic/go-agent/blob/master/GUIDE.md). | ||
|
|
@@ -35,14 +35,27 @@ for out-of-the box support for many popular Go web frameworks and libraries. We | |
| continue to add integration packages based on your feedback. You can weigh in on | ||
| potential integrations by opening an `Issue` here in our New Relic Go agent GitHub project. | ||
|
|
||
|
|
||
| ## Upgrading | ||
| ### Upgrading | ||
|
|
||
| If you have already been using version 2.X of the agent and are upgrading to | ||
| version 3.0, see our [MIGRATION guide](MIGRATION.md) for details. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| [v3/examples/server/main.go](v3/examples/server/main.go) is an example that | ||
| will appear as "Example App" in your New Relic applications list. To run it: | ||
|
|
||
| ``` | ||
| env NEW_RELIC_LICENSE_KEY=__YOUR_NEW_RELIC_LICENSE_KEY__LICENSE__ \ | ||
| go run v3/examples/server/main.go | ||
| ``` | ||
|
|
||
| Some endpoints exposed are [http://localhost:8000/](http://localhost:8000/) | ||
| and [http://localhost:8000/notice_error](http://localhost:8000/notice_error) | ||
|
|
||
| ## Usage | ||
|
|
||
| ## Integration Packages | ||
| ### Integration Packages | ||
|
|
||
| The following [integration packages](https://godoc.org/github.com/newrelic/go-agent/v3/integrations) | ||
| extend the base [newrelic](https://godoc.org/github.com/newrelic/go-agent/v3/newrelic/) package | ||
|
|
@@ -52,11 +65,11 @@ instrumented using the [newrelic](https://godoc.org/github.com/newrelic/go-agent | |
| package primitives. | ||
|
|
||
| <!--- | ||
| NOTE! When updating the tables below, be sure to update the docs site version too: | ||
| NOTE! When updating the tables below, be sure to update the docs site version too: | ||
| https://docs.newrelic.com/docs/agents/go-agent/get-started/go-agent-compatibility-requirements | ||
| --> | ||
|
|
||
| ### Service Frameworks | ||
| #### Service Frameworks | ||
|
|
||
| | Project | Integration Package | | | ||
| | ------------- | ------------- | - | | ||
|
|
@@ -68,7 +81,7 @@ https://docs.newrelic.com/docs/agents/go-agent/get-started/go-agent-compatibilit | |
| | [julienschmidt/httprouter](https://github.com/julienschmidt/httprouter) | [v3/integrations/nrhttprouter](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrhttprouter) | Instrument inbound requests through the HttpRouter framework | | ||
| | [micro/go-micro](https://github.com/micro/go-micro) | [v3/integrations/nrmicro](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrmicro) | Instrument servers, clients, publishers, and subscribers through the Micro framework | | ||
|
|
||
| ### Datastores | ||
| #### Datastores | ||
|
|
||
| More information about instrumenting databases without an integration package | ||
| using [newrelic](https://godoc.org/github.com/newrelic/go-agent/v3/newrelic/) | ||
|
|
@@ -86,30 +99,30 @@ package primitives can be found [here](GUIDE.md#datastore-segments). | |
| | [snowflakedb/gosnowflake](https://github.com/snowflakedb/gosnowflake) | [v3/integrations/nrsnowflake](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrsnowflake) | Instrument Snowflake driver | | ||
| | [mongodb/mongo-go-driver](https://github.com/mongodb/mongo-go-driver) | [v3/integrations/nrmongo](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrmongo) | Instrument MongoDB calls | | ||
|
|
||
| ### Logging | ||
| #### Logging | ||
|
|
||
| | Project | Integration Package | | | ||
| | ------------- | ------------- | - | | ||
| | [sirupsen/logrus](https://github.com/sirupsen/logrus) | [v3/integrations/nrlogrus](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus) | Send agent log messages to Logrus | | ||
| | [mgutz/logxi](https://github.com/mgutz/logxi) | [v3/integrations/nrlogxi](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi) | Send agent log messages to Logxi | | ||
| | [uber-go/zap](https://github.com/uber-go/zap) | [v3/integrations/nrzap](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap) | Send agent log messages to Zap | | ||
|
|
||
| ### AWS | ||
| #### AWS | ||
|
|
||
| | Project | Integration Package | | | ||
| | ------------- | ------------- | - | | ||
| | [aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) | [v3/integrations/nrawssdk-v1](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrawssdk-v1) | Instrument outbound calls made using Go AWS SDK | | ||
| | [aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2) | [v3/integrations/nrawssdk-v2](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrawssdk-v2) | Instrument outbound calls made using Go AWS SDK v2 | | ||
| | [aws/aws-lambda-go](https://github.com/aws/aws-lambda-go) | [v3/integrations/nrlambda](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlambda) | Instrument AWS Lambda applications | | ||
|
|
||
| ### GraphQL | ||
| #### GraphQL | ||
|
|
||
| | Project | Integration Package | | | ||
| | ------------- | ------------- | - | | ||
| | [graph-gophers/graphql-go](https://github.com/graph-gophers/graphql-go) | [v3/integrations/nrgraphgophers](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrgraphgophers) | Instrument inbound requests using graph-gophers/graphql-go | | ||
| | [graphql-go/graphql](https://github.com/graphql-go/graphql) | [v3/integrations/nrgraphqlgo](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrgraphqlgo) | Instrument inbound requests using graphql-go/graphql | | ||
|
|
||
| ### Misc | ||
| #### Misc | ||
|
|
||
| | Project | Integration Package | | | ||
| | ------------- | ------------- | - | | ||
|
|
@@ -123,22 +136,7 @@ These integration packages must be imported along | |
| with the [newrelic](https://godoc.org/github.com/newrelic/go-agent/v3/newrelic/) package, as shown in this | ||
| [nrgin example](https://github.com/newrelic/go-agent/blob/master/v3/integrations/nrgin/example/main.go). | ||
|
|
||
|
|
||
| ## Runnable Example | ||
|
|
||
| [v3/examples/server/main.go](v3/examples/server/main.go) is an example that | ||
| will appear as "Example App" in your New Relic applications list. To run it: | ||
|
|
||
| ``` | ||
| env NEW_RELIC_LICENSE_KEY=__YOUR_NEW_RELIC_LICENSE_KEY__LICENSE__ \ | ||
| go run v3/examples/server/main.go | ||
| ``` | ||
|
|
||
| Some endpoints exposed are [http://localhost:8000/](http://localhost:8000/) | ||
| and [http://localhost:8000/notice_error](http://localhost:8000/notice_error) | ||
|
|
||
|
|
||
| ## Alternatives | ||
| ### Alternatives | ||
|
|
||
| If you are already using another open source solution to gather telemetry data, you may find it easier to use one of our open source exporters to send this data to New Relic: | ||
|
|
||
|
|
@@ -151,7 +149,10 @@ If you are already using another open source solution to gather telemetry data, | |
|
|
||
| ## Support | ||
|
|
||
| Should you need assistance with New Relic products, you are in good hands with several support channels. If the issue has been confirmed as a bug or is a Feature request, please file a Github issue. | ||
| Should you need assistance with New Relic products, you are in good hands with several support channels. | ||
|
|
||
| If the issue has been confirmed as a bug or is a Feature request, please file a Github issue. | ||
|
|
||
|
|
||
| * [Go Agent GUIDE](GUIDE.md): Step by step how-to for key agent features | ||
| * [New Relic Documentation](https://docs.newrelic.com/docs/agents/go-agent): Comprehensive guidance for using our platform | ||
|
|
@@ -162,25 +163,28 @@ Should you need assistance with New Relic products, you are in good hands with s | |
|
|
||
| ## Privacy | ||
|
|
||
| At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise. | ||
| At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise. | ||
|
|
||
| We define "Personal Data" as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address and email address. | ||
|
|
||
| Please review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy) for more information. | ||
| For more information, review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy). | ||
|
|
||
| ## Contribute | ||
|
|
||
| We encourage your contributions to improve the Go Agent! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. | ||
|
|
||
| ## Contributing | ||
| If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected]. | ||
|
|
||
| We encourage your contributions to improve the Go Agent! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected]. | ||
|
|
||
| **A note about vulnerabilities** | ||
|
|
||
| As noted in our [security policy](https://github.com/newrelic/.github/blob/master/security.md), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. | ||
| As noted in our [security policy](https://github.com/newrelic/.github/blob/master/security.md), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. | ||
|
|
||
| If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic). | ||
|
|
||
| If you would like to contribute to this project, please review [these guidelines](./CONTRIBUTING.md). | ||
|
|
||
| To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to | ||
| To [all contributors](https://github.com/newrelic/go-agent/graphs/contributors), we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to | ||
| the [Go Agent](https://opensource.newrelic.com/projects/newrelic/go-agent). | ||
|
|
||
| ## License | ||
|
|
||
Oops, something went wrong.