Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(events): add events api #1065

Merged
merged 5 commits into from
Nov 14, 2023
Merged

chore(events): add events api #1065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f7ae8f
chore(events): add events api
Julien4218 Nov 13, 2023
e1bdd11
fix: add events service test
Julien4218 Nov 13, 2023
1579a79
Merge branch 'main' into chore/add-events-api
Julien4218 Nov 13, 2023
178858d
refactor: move config handling to package
Julien4218 Nov 14, 2023
8eee324
chore: add documentation
Julien4218 Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 19 additions & 132 deletions newrelic/newrelic.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
package newrelic

import (
"errors"
"net/http"
"time"

log "github.com/sirupsen/logrus"

"github.com/newrelic/newrelic-client-go/v2/pkg/accountmanagement"
"github.com/newrelic/newrelic-client-go/v2/pkg/accounts"
"github.com/newrelic/newrelic-client-go/v2/pkg/agentapplications"
Expand All @@ -31,7 +28,6 @@ import (
"github.com/newrelic/newrelic-client-go/v2/pkg/nrdb"
"github.com/newrelic/newrelic-client-go/v2/pkg/nrqldroprules"
"github.com/newrelic/newrelic-client-go/v2/pkg/plugins"
"github.com/newrelic/newrelic-client-go/v2/pkg/region"
"github.com/newrelic/newrelic-client-go/v2/pkg/servicelevel"
"github.com/newrelic/newrelic-client-go/v2/pkg/synthetics"
"github.com/newrelic/newrelic-client-go/v2/pkg/workflows"
Expand Down Expand Up @@ -74,21 +70,9 @@ type NewRelic struct {
func New(opts ...ConfigOption) (*NewRelic, error) {
cfg := config.New()

// Loop through config options
for _, fn := range opts {
if nil != fn {
if err := fn(&cfg); err != nil {
return nil, err
}
}
}

if cfg.PersonalAPIKey == "" && cfg.AdminAPIKey == "" && cfg.InsightsInsertKey == "" {
return nil, errors.New("must use at least one of: ConfigPersonalAPIKey, ConfigAdminAPIKey, ConfigInsightsInsertKey")
}

if cfg.Logger == nil {
cfg.Logger = cfg.GetLogger()
err := cfg.Init(opts)
if err != nil {
return nil, err
}

nr := &NewRelic{
Expand Down Expand Up @@ -150,182 +134,85 @@ func (nr *NewRelic) TestEndpoints() error {

// ConfigOption configures the Config when provided to NewApplication.
// https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys
type ConfigOption func(*config.Config) error
type ConfigOption = config.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 ConfigPersonalAPIKey(apiKey string) ConfigOption {
return func(cfg *config.Config) error {
cfg.PersonalAPIKey = apiKey
return nil
}
return config.ConfigPersonalAPIKey(apiKey)
}

// 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 ConfigInsightsInsertKey(insightsInsertKey string) ConfigOption {
return func(cfg *config.Config) error {
cfg.InsightsInsertKey = insightsInsertKey
return nil
}
return config.ConfigInsightsInsertKey(insightsInsertKey)
}

// 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 ConfigAdminAPIKey(adminAPIKey string) ConfigOption {
return func(cfg *config.Config) error {
cfg.AdminAPIKey = adminAPIKey
return nil
}
return config.ConfigAdminAPIKey(adminAPIKey)
}

// ConfigRegion sets the New Relic Region this client will use.
func ConfigRegion(r string) ConfigOption {
return func(cfg *config.Config) error {
// We can ignore this error since we will be defaulting in the next step
regName, _ := region.Parse(r)

reg, err := region.Get(regName)
if err != nil {
if _, ok := err.(region.UnknownUsingDefaultError); ok {
// If region wasn't provided, output a warning message
// indicating the default region "US" is being used.
log.Warn(err)
return nil
}

return err
}

err = cfg.SetRegion(reg)

return err
}
return config.ConfigRegion(r)
}

// ConfigHTTPTimeout sets the timeout for HTTP requests.
func ConfigHTTPTimeout(t time.Duration) ConfigOption {
return func(cfg *config.Config) error {
var timeout = &t
cfg.Timeout = timeout
return nil
}
return config.ConfigHTTPTimeout(t)
}

// ConfigHTTPTransport sets the HTTP Transporter.
func ConfigHTTPTransport(transport http.RoundTripper) ConfigOption {
return func(cfg *config.Config) error {
if transport != nil {
cfg.HTTPTransport = transport
return nil
}

return errors.New("HTTP Transport can not be nil")
}
return config.ConfigHTTPTransport(transport)
}

// ConfigUserAgent sets the HTTP UserAgent for API requests.
func ConfigUserAgent(ua string) ConfigOption {
return func(cfg *config.Config) error {
if ua != "" {
cfg.UserAgent = ua
return nil
}

return errors.New("user-agent can not be empty")
}
return config.ConfigUserAgent(ua)
}

// ConfigServiceName sets the service name logged
func ConfigServiceName(name string) ConfigOption {
return func(cfg *config.Config) error {
if name != "" {
cfg.ServiceName = name
}

return nil
}
return config.ConfigServiceName(name)
}

// ConfigBaseURL sets the base URL used to make requests to the REST API V2.
func ConfigBaseURL(url string) ConfigOption {
return func(cfg *config.Config) error {
if url != "" {
cfg.Region().SetRestBaseURL(url)
return nil
}

return errors.New("base URL can not be empty")
}
return config.ConfigBaseURL(url)
}

// ConfigInfrastructureBaseURL sets the base URL used to make requests to the Infrastructure API.
func ConfigInfrastructureBaseURL(url string) ConfigOption {
return func(cfg *config.Config) error {
if url != "" {
cfg.Region().SetInfrastructureBaseURL(url)
return nil
}

return errors.New("infrastructure base URL can not be empty")
}
return config.ConfigInfrastructureBaseURL(url)
}

// ConfigSyntheticsBaseURL sets the base URL used to make requests to the Synthetics API.
func ConfigSyntheticsBaseURL(url string) ConfigOption {
return func(cfg *config.Config) error {
if url != "" {
cfg.Region().SetSyntheticsBaseURL(url)
return nil
}

return errors.New("synthetics base URL can not be empty")
}
return config.ConfigSyntheticsBaseURL(url)
}

// ConfigNerdGraphBaseURL sets the base URL used to make requests to the NerdGraph API.
func ConfigNerdGraphBaseURL(url string) ConfigOption {
return func(cfg *config.Config) error {
if url != "" {
cfg.Region().SetNerdGraphBaseURL(url)
return nil
}

return errors.New("nerdgraph base URL can not be empty")
}
return config.ConfigNerdGraphBaseURL(url)
}

// ConfigLogLevel sets the log level for the client.
func ConfigLogLevel(logLevel string) ConfigOption {
return func(cfg *config.Config) error {
if logLevel != "" {
cfg.LogLevel = logLevel
return nil
}

return errors.New("log level can not be empty")
}
return config.ConfigLogLevel(logLevel)
}

// ConfigLogJSON toggles JSON formatting on for the logger if set to true.
func ConfigLogJSON(logJSON bool) ConfigOption {
return func(cfg *config.Config) error {
cfg.LogJSON = logJSON
return nil
}
return config.ConfigLogJSON(logJSON)
}

// ConfigLogger can be used to customize the client's logger.
// Custom loggers must conform to the logging.Logger interface.
func ConfigLogger(logger logging.Logger) ConfigOption {
return func(cfg *config.Config) error {
if logger != nil {
cfg.Logger = logger
return nil
}

return errors.New("logger can not be nil")
}
return config.ConfigLogger(logger)
}
22 changes: 22 additions & 0 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
package config

import (
"errors"
"fmt"
"net/http"
"os"
Expand Down Expand Up @@ -70,6 +71,27 @@ func New() Config {
}
}

func (cfg *Config) Init(opts []ConfigOption) error {
// Loop through config options
for _, fn := range opts {
if nil != fn {
if err := fn(cfg); err != nil {
return err
}
}
}

if cfg.PersonalAPIKey == "" && cfg.AdminAPIKey == "" && cfg.InsightsInsertKey == "" {
return errors.New("must use at least one of: ConfigPersonalAPIKey, ConfigAdminAPIKey, ConfigInsightsInsertKey")
}

if cfg.Logger == nil {
cfg.Logger = cfg.GetLogger()
}

return nil
}

// Region returns the region configuration struct
// if one has not been set, use the default region
func (c *Config) Region() *region.Region {
Expand Down
Loading
Loading