The New Relic Client provides the building blocks for tools in the Developer Toolkit, enabling quick access to the suite of New Relic APIs. As a library, it can also be leveraged within your own custom applications.
- Getting Started and Example Usage
- Upgrade to the latest version
- Community
- Development
- Community Support
- Issues / Enhancement Requests
- Contributing
- Open Source License
Follow the steps below to add github.com/newrelic/newrelic-client-go
as a dependency in your Go project.
-
In the root directory of your project, run
go get github.com/newrelic/newrelic-client-go@latest
. This will update yourgo.mod
file with the latest versionnewrelic-client-go
. -
Import
newrelic-client-go
in your project code.package main import "github.com/newrelic/newrelic-client-go/v2/newrelic" func main() { // Initialize the client. client, err := newrelic.New(newrelic.ConfigPersonalAPIKey(os.Getenv("NEW_RELIC_API_KEY"))) if err != nil { // ... } }
-
Run
go mod tidy
. This will ensure all your dependencies are in sync with your code. -
Your module's
go.mod
file should now be updated with the latest version of the client and should look similar to the following example (version number is hypothetical in the example below).module example.com/yourmodule go 1.21 require ( github.com/newrelic/newrelic-client-go/v2 v2.0.1 )
-
The example below demonstrates fetching New Relic entities.
package main import ( "fmt" "os" log "github.com/sirupsen/logrus" "github.com/newrelic/newrelic-client-go/v2/newrelic" "github.com/newrelic/newrelic-client-go/v2/pkg/entities" ) func main() { // Initialize the client. client, err := newrelic.New(newrelic.ConfigPersonalAPIKey(os.Getenv("NEW_RELIC_API_KEY"))) if err != nil { log.Fatal("error initializing client:", err) } // Search the current account for entities by name and type. queryBuilder := entities.EntitySearchQueryBuilder{ Name: "Example entity", Type: entities.EntitySearchQueryBuilderTypeTypes.APPLICATION, } entitySearch, err := client.Entities.GetEntitySearch( entities.EntitySearchOptions{}, "", queryBuilder, []entities.EntitySearchSortCriteria{}, ) if err != nil { log.Fatal("error searching entities:", err) } fmt.Printf("%+v\n", entitySearch.Results.Entities) }
- Run the following command to tell Go to download the latest version.
go get github.com/newrelic/newrelic-client-go/v2@latest
- Run
go mod tidy
to sync your dependencies with your code. - Confirm your
go.mod
file is referencing the latest version.
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices.
- Issues or Enhancement Requests - Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
- Contributors Guide - Contributions are welcome.
- Community discussion board - Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub.
Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com.
- Go 1.21+
- GNU Make
- git
This package does not generate any direct usable assets (it's a library). You can still run the build scripts to validate your code, and generate coverage information.
# Default target is 'build'
$ make
# Explicitly run build
$ make build
# Locally test the CI build scripts
$ make build-ci
Before contributing, all linting and tests must pass.
Tests can be run directly via:
# Tests and Linting
$ make test
# Only unit tests
$ make test-unit
# Only integration tests
$ make test-integration
Integration tests communicate with the New Relic API, and therefore require proper account credentials to run properly. The suite makes use of secrets, which will need to be configured in the environment or else the integraiton tests will be skipped during a test run. To run the integration test suite, the following secrets will need to be configured:
NEW_RELIC_ACCOUNT_ID
NEW_RELIC_API_KEY
NEW_RELIC_INSIGHTS_INSERT_KEY
NEW_RELIC_LICENSE_KEY
NEW_RELIC_REGION
NEW_RELIC_TEST_USER_ID
Optional for debugging (defaults to debug
):
NEW_RELIC_LOG_LEVEL=trace
We'll aim to support the latest supported release of Go, along with the previous release. This doesn't mean that building with an older version of Go will not work, but we don't intend to support a Go version in this project that is not supported by the larger Go community. Please see the Go releases page for more details.
Using the following format for commit messages allows for auto-generation of the CHANGELOG:
<type>(<scope>): <subject>
Type | Description | Change log? |
---|---|---|
chore |
Maintenance type work | No |
docs |
Documentation Updates | Yes |
feat |
New Features | Yes |
fix |
Bug Fixes | Yes |
refactor |
Code Refactoring | No |
This refers to what part of the code is the focus of the work. For example:
General:
build
- Work related to the build system (linting, makefiles, CI/CD, etc)release
- Work related to cutting a new release
Package Specific:
newrelic
- Work related to the New Relic packagehttp
- Work related to theinternal/http
packagealerts
- Work related to thepkg/alerts
package
Note: This requires the repo to be in your GOPATH (godoc issue)
$ make docs
Releases are automated via the Release Github Action on merges to the default branch. No user interaction is required.
Using svu, commit messages are parsed to identify if a new release is needed, and to what extent. Here's the breakdown:
Commit message | Tag increase |
---|---|
fix: fixed something |
Patch |
feat: added new button to do X |
Minor |
fix: fixed thing xyz BREAKING CHANGE: this will break users because of blah |
Major |
fix!: fixed something |
Major |
feat!: added blah |
Major |
chore: foo |
Nothing |
refactor: updated bar |
Nothing |
New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all New Relic open source community projects, there's a related topic in the New Relic Explorers Hub. You can find our team's project topic/threads here:
Please do not report issues with Top to New Relic Global Technical Support. Instead, visit the Explorers Hub
for troubleshooting and best-practices.
Issues and enhancement requests can be submitted in te Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself 😁). Please review our Contributors Guide.
Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com.
This project is distributed under the Apache 2 license.