config

Documentation

Overview

Package config provides cross-cutting configuration support for the newrelic-client-go project.

Package config provides a configuration surface area for configuring the underlying client.

Authentication

You will need a valid Personal API key to communicate with the backend New Relic APIs that power the client. See the API key documentation below for more information on how to locate this key:

https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys

Index

• Variables
• type CompressionType
  • func ParseCompression(name string) CompressionType
  • func (c CompressionType) String() string
• type Config
  • func New() Config
  • func (c *Config) GetLogger() logging.Logger
  • func (cfg *Config) Init(opts []ConfigOption) error
  • func (c *Config) Region() *region.Region
  • func (c *Config) SetRegion(reg *region.Region) error
  • func (c *Config) SetServiceName(serviceName string) error
• type ConfigOption
  • func ConfigAdminAPIKey(adminAPIKey string) ConfigOption
  • func ConfigBaseURL(url string) ConfigOption
  • func ConfigHTTPTimeout(t time.Duration) ConfigOption
  • func ConfigHTTPTransport(transport http.RoundTripper) ConfigOption
  • func ConfigInfrastructureBaseURL(url string) ConfigOption
  • func ConfigInsightsInsertKey(insightsInsertKey string) ConfigOption
  • func ConfigLogJSON(logJSON bool) ConfigOption
  • func ConfigLogLevel(logLevel string) ConfigOption
  • func ConfigLogger(logger logging.Logger) ConfigOption
  • func ConfigNerdGraphBaseURL(url string) ConfigOption
  • func ConfigPersonalAPIKey(apiKey string) ConfigOption
  • func ConfigRegion(r string) ConfigOption
  • func ConfigServiceName(name string) ConfigOption
  • func ConfigSyntheticsBaseURL(url string) ConfigOption
  • func ConfigUserAgent(ua string) ConfigOption

Variables

var Compression = struct {
	None CompressionType
	Gzip CompressionType
}{
	None: "",
	Gzip: "gzip",
}

Compression is an Enum of compression types available

Types

type CompressionType

type CompressionType string

CompressionType to use during transport.

func ParseCompression

func ParseCompression(name string) CompressionType

ParseCompression takes a named compression and returns the Type

func (CompressionType) String

func (c CompressionType) String() string

String returns the name of the compression type

type Config

type Config struct {
	// LicenseKey to authenticate Log API requests
	// see: https://docs.newrelic.com/docs/accounts/accounts-billing/account-setup/new-relic-license-key
	LicenseKey string

	// PersonalAPIKey to authenticate API requests
	// see: https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#personal-api-key
	PersonalAPIKey string

	// AdminAPIKey to authenticate API requests
	// Deprecated.  Use a Personal API key for authentication.
	// see: https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#admin
	AdminAPIKey string

	// InsightsInsertKey to send custom events to Insights
	InsightsInsertKey string

	// Timeout is the client timeout for HTTP requests.
	Timeout *time.Duration

	// HTTPTransport allows customization of the client's underlying transport.
	HTTPTransport http.RoundTripper

	// Compression used in sending data in HTTP requests.
	Compression CompressionType

	// UserAgent updates the default user agent string used by the client.
	UserAgent string

	// ServiceName is for New Relic internal use only.
	ServiceName string

	// LogLevel can be one of the following values:
	// "panic", "fatal", "error", "warn", "info", "debug", "trace"
	LogLevel string

	// LogJSON toggles formatting of log entries in JSON format.
	LogJSON bool

	// Logger allows customization of the client's underlying logger.
	Logger logging.Logger
	// contains filtered or unexported fields
}

Config contains all the configuration data for the API Client.

func New

func New() Config

New creates a default configuration and returns it

func (*Config) GetLogger

func (c *Config) GetLogger() logging.Logger

GetLogger returns a logger instance based on the config values.

func (*Config) Init

func (cfg *Config) Init(opts []ConfigOption) error

func (*Config) Region

func (c *Config) Region() *region.Region

Region returns the region configuration struct if one has not been set, use the default region

func (*Config) SetRegion

func (c *Config) SetRegion(reg *region.Region) error

SetRegion configures the region

func (*Config) SetServiceName

func (c *Config) SetServiceName(serviceName string) error

type ConfigOption

type ConfigOption func(*Config) error

ConfigOption configures the Config when provided to NewApplication. https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys

func ConfigAdminAPIKey

func ConfigAdminAPIKey(adminAPIKey string) ConfigOption

ConfigAdminAPIKey sets the New Relic Admin API key this client will use. Deprecated. Use a personal API key for authentication. https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys

func ConfigBaseURL

func ConfigBaseURL(url string) ConfigOption

ConfigBaseURL sets the base URL used to make requests to the REST API V2.

func ConfigHTTPTimeout

func ConfigHTTPTimeout(t time.Duration) ConfigOption

ConfigHTTPTimeout sets the timeout for HTTP requests.

func ConfigHTTPTransport

func ConfigHTTPTransport(transport http.RoundTripper) ConfigOption

ConfigHTTPTransport sets the HTTP Transporter.

func ConfigInfrastructureBaseURL

func ConfigInfrastructureBaseURL(url string) ConfigOption

ConfigInfrastructureBaseURL sets the base URL used to make requests to the Infrastructure API.

func ConfigInsightsInsertKey

func ConfigInsightsInsertKey(insightsInsertKey string) ConfigOption

ConfigInsightsInsertKey sets the New Relic Insights insert key this client will use. https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys

func ConfigLogJSON

func ConfigLogJSON(logJSON bool) ConfigOption

ConfigLogJSON toggles JSON formatting on for the logger if set to true.

func ConfigLogLevel

func ConfigLogLevel(logLevel string) ConfigOption

ConfigLogLevel sets the log level for the client.

func ConfigLogger

func ConfigLogger(logger logging.Logger) ConfigOption

ConfigLogger can be used to customize the client's logger. Custom loggers must conform to the logging.Logger interface.

func ConfigNerdGraphBaseURL

func ConfigNerdGraphBaseURL(url string) ConfigOption

ConfigNerdGraphBaseURL sets the base URL used to make requests to the NerdGraph API.

func ConfigPersonalAPIKey

func ConfigPersonalAPIKey(apiKey string) ConfigOption

ConfigPersonalAPIKey sets the New Relic Admin API key this client will use. This key should be used to create a client instance. https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys

func ConfigRegion

func ConfigRegion(r string) ConfigOption

ConfigRegion sets the New Relic Region this client will use.

func ConfigServiceName

func ConfigServiceName(name string) ConfigOption

ConfigServiceName sets the service name logged

func ConfigSyntheticsBaseURL

func ConfigSyntheticsBaseURL(url string) ConfigOption

ConfigSyntheticsBaseURL sets the base URL used to make requests to the Synthetics API.

func ConfigUserAgent

func ConfigUserAgent(ua string) ConfigOption

ConfigUserAgent sets the HTTP UserAgent for API requests.