newrelic-client-go

module
v0.59.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 10, 2021 License: Apache-2.0

README

Community Project header

newrelic-client-go

Testing Security Scan Go Report Card GoDoc License CLA assistant Release

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.

Example

package main

import (
	"fmt"
	"os"

	log "github.com/sirupsen/logrus"

	"github.com/newrelic/newrelic-client-go/newrelic"
	"github.com/newrelic/newrelic-client-go/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.
	searchParams := entities.SearchEntitiesParams{
		Name: "Example entity",
		Type: entities.EntityTypes.Application,
	}

	entities, err := client.Entities.SearchEntities(searchParams)
	if err != nil {
		log.Fatal("error searching entities:", err)
	}

	fmt.Printf("%+v\n", entities)
}

Community

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.

  • Roadmap - As part of the Developer Toolkit, the roadmap for this project follows the same RFC process
  • 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 (and if you submit a Enhancement Request, expect to be invited to contribute it yourself 😁).
  • 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.

Development

Requirements
  • Go 1.14.0+
  • GNU Make
  • git
Building

This package does not generate any direct usable assets (it's a library). You can still run the build scripts to validate you code, and generate coverage information.

# Default target is 'build'
$ make

# Explicitly run build
$ make build

# Locally test the CI build scripts
# make build-ci
Testing

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

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
Go Version Support

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.

Commit Messages

Using the following format for commit messages allows for auto-generation of the CHANGELOG:

Format

<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
Scope

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 package
  • http - Work related to the internal/http package
  • alerts - Work related to the pkg/alerts package
Documentation

Note: This requires the repo to be in your GOPATH (godoc issue)

$ make docs

Community Support

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:

Developer ToolKit

Please do not report issues with Top to New Relic Global Technical Support. Instead, visit the Explorers Hub for troubleshooting and best-practices.

Issues / Enhancement Requests

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.

Contributing

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.

Open Source License

This project is distributed under the Apache 2 license.

Directories

Path Synopsis
internal
Package newrelic is a convenience package that provides a programmatic API surface area for interacting with all the New Relic One products encompassed by this project.
Package newrelic is a convenience package that provides a programmatic API surface area for interacting with all the New Relic One products encompassed by this project.
pkg
accounts
Package accounts provides a programmatic API for interacting with New Relic accounts.
Package accounts provides a programmatic API for interacting with New Relic accounts.
alerts
Package alerts provides a programmatic API for interacting with the New Relic Alerts product.
Package alerts provides a programmatic API for interacting with the New Relic Alerts product.
apiaccess
Package apiaccess provides a programmatic API for interacting with New Relic API keys Code generated by tutone: DO NOT EDIT
Package apiaccess provides a programmatic API for interacting with New Relic API keys Code generated by tutone: DO NOT EDIT
apm
Package apm provides a programmatic API for interacting with the New Relic APM product.
Package apm provides a programmatic API for interacting with the New Relic APM product.
cloud
Code generated by tutone: DO NOT EDIT Code generated by tutone: DO NOT EDIT
Code generated by tutone: DO NOT EDIT Code generated by tutone: DO NOT EDIT
config
Package config provides cross-cutting configuration support for the newrelic-client-go project.
Package config provides cross-cutting configuration support for the newrelic-client-go project.
dashboards
Package dashboards provides a programmatic API for interacting with New Relic dashboards.
Package dashboards provides a programmatic API for interacting with New Relic dashboards.
edge
Package edge provides a programmatic API for interacting with New Relic Edge with infinite tracing.
Package edge provides a programmatic API for interacting with New Relic Edge with infinite tracing.
entities
Package entities provides a programmatic API for interacting with New Relic One entities.
Package entities provides a programmatic API for interacting with New Relic One entities.
errors
Package errors provides error types for specific error scenarios.
Package errors provides error types for specific error scenarios.
events
Package events provides a programmatic API for creating custom events in New Relic.
Package events provides a programmatic API for creating custom events in New Relic.
eventstometrics
Code generated by tutone: DO NOT EDIT
Code generated by tutone: DO NOT EDIT
infrastructure
Package infrastructure provides metadata about the underlying Infrastructure API, which is only used to provision Infrastructure alert conditions.
Package infrastructure provides metadata about the underlying Infrastructure API, which is only used to provision Infrastructure alert conditions.
nerdgraph
Package nerdgraph provides a programmatic API for interacting with the New Relic NerdGraph GraphQL API.
Package nerdgraph provides a programmatic API for interacting with the New Relic NerdGraph GraphQL API.
nerdstorage
Package nerdstorage provides a programmatic API for interacting with the New Relic One NerdStorage document store.
Package nerdstorage provides a programmatic API for interacting with the New Relic One NerdStorage document store.
nrdb
Package nrdb provides a programmatic API for interacting with the New Relic Database.
Package nrdb provides a programmatic API for interacting with the New Relic Database.
nrqldroprules
Package nrqldroprules provides a programmatic API for interacting configuring New Relc NRQL Drop Rules.
Package nrqldroprules provides a programmatic API for interacting configuring New Relc NRQL Drop Rules.
nrtime
Code generated by tutone: DO NOT EDIT
Code generated by tutone: DO NOT EDIT
plugins
Package plugins provides a programmatic API for interacting with the New Relic Plugins product.
Package plugins provides a programmatic API for interacting with the New Relic Plugins product.
region
Package region describes the operational regions defined for New Relic Regions are geographical locations where the New Relic platform operates and this package provides an abstraction layer for handling them within the New Relic Client and underlying APIs
Package region describes the operational regions defined for New Relic Regions are geographical locations where the New Relic platform operates and this package provides an abstraction layer for handling them within the New Relic Client and underlying APIs
synthetics
Package synthetics provides a programmatic API for interacting with the New Relic Synthetics API.
Package synthetics provides a programmatic API for interacting with the New Relic Synthetics API.
users
Package users provides a programmatic API for interacting with New Relic users.
Package users provides a programmatic API for interacting with New Relic users.
workloads
Package workloads provides a programmatic API for interacting with New Relic One workloads.
Package workloads provides a programmatic API for interacting with New Relic One workloads.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL