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.

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

feat(logging): Add support for Grafana Cloud Logs. #1333

Merged
merged 3 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions pkg/api/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,12 @@ type Interface interface {
UpdateGCS(*fastly.UpdateGCSInput) (*fastly.GCS, error)
DeleteGCS(*fastly.DeleteGCSInput) error

CreateGrafanaCloudLogs(*fastly.CreateGrafanaCloudLogsInput) (*fastly.GrafanaCloudLogs, error)
ListGrafanaCloudLogs(*fastly.ListGrafanaCloudLogsInput) ([]*fastly.GrafanaCloudLogs, error)
GetGrafanaCloudLogs(*fastly.GetGrafanaCloudLogsInput) (*fastly.GrafanaCloudLogs, error)
UpdateGrafanaCloudLogs(*fastly.UpdateGrafanaCloudLogsInput) (*fastly.GrafanaCloudLogs, error)
DeleteGrafanaCloudLogs(*fastly.DeleteGrafanaCloudLogsInput) error

CreateFTP(*fastly.CreateFTPInput) (*fastly.FTP, error)
ListFTPs(*fastly.ListFTPsInput) ([]*fastly.FTP, error)
GetFTP(*fastly.GetFTPInput) (*fastly.FTP, error)
Expand Down
13 changes: 13 additions & 0 deletions pkg/commands/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (
"github.com/fastly/cli/pkg/commands/logging/ftp"
"github.com/fastly/cli/pkg/commands/logging/gcs"
"github.com/fastly/cli/pkg/commands/logging/googlepubsub"
"github.com/fastly/cli/pkg/commands/logging/grafanacloudlogs"
"github.com/fastly/cli/pkg/commands/logging/heroku"
"github.com/fastly/cli/pkg/commands/logging/honeycomb"
"github.com/fastly/cli/pkg/commands/logging/https"
Expand Down Expand Up @@ -246,6 +247,12 @@ func Define(
loggingGooglepubsubDescribe := googlepubsub.NewDescribeCommand(loggingGooglepubsubCmdRoot.CmdClause, data)
loggingGooglepubsubList := googlepubsub.NewListCommand(loggingGooglepubsubCmdRoot.CmdClause, data)
loggingGooglepubsubUpdate := googlepubsub.NewUpdateCommand(loggingGooglepubsubCmdRoot.CmdClause, data)
loggingGrafanacloudlogsCmdRoot := grafanacloudlogs.NewRootCommand(loggingCmdRoot.CmdClause, data)
loggingGrafanacloudlogsCreate := grafanacloudlogs.NewCreateCommand(loggingGrafanacloudlogsCmdRoot.CmdClause, data)
loggingGrafanacloudlogsDelete := grafanacloudlogs.NewDeleteCommand(loggingGrafanacloudlogsCmdRoot.CmdClause, data)
loggingGrafanacloudlogsDescribe := grafanacloudlogs.NewDescribeCommand(loggingGrafanacloudlogsCmdRoot.CmdClause, data)
loggingGrafanacloudlogsList := grafanacloudlogs.NewListCommand(loggingGrafanacloudlogsCmdRoot.CmdClause, data)
loggingGrafanacloudlogsUpdate := grafanacloudlogs.NewUpdateCommand(loggingGrafanacloudlogsCmdRoot.CmdClause, data)
loggingHerokuCmdRoot := heroku.NewRootCommand(loggingCmdRoot.CmdClause, data)
loggingHerokuCreate := heroku.NewCreateCommand(loggingHerokuCmdRoot.CmdClause, data)
loggingHerokuDelete := heroku.NewDeleteCommand(loggingHerokuCmdRoot.CmdClause, data)
Expand Down Expand Up @@ -619,6 +626,12 @@ func Define(
loggingGooglepubsubDescribe,
loggingGooglepubsubList,
loggingGooglepubsubUpdate,
loggingGrafanacloudlogsCmdRoot,
loggingGrafanacloudlogsCreate,
loggingGrafanacloudlogsDelete,
loggingGrafanacloudlogsDescribe,
loggingGrafanacloudlogsList,
loggingGrafanacloudlogsUpdate,
loggingHerokuCmdRoot,
loggingHerokuCreate,
loggingHerokuDelete,
Expand Down
169 changes: 169 additions & 0 deletions pkg/commands/logging/grafanacloudlogs/create.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
package grafanacloudlogs

import (
"io"

"4d63.com/optional"
"github.com/fastly/cli/pkg/argparser"
"github.com/fastly/cli/pkg/commands/logging/common"
"github.com/fastly/cli/pkg/errors"
"github.com/fastly/cli/pkg/global"
"github.com/fastly/cli/pkg/manifest"
"github.com/fastly/cli/pkg/text"
"github.com/fastly/go-fastly/v9/fastly"
)

// CreateCommand calls the Fastly API to create a GrafanaCloudLogs logging endpoint.
type CreateCommand struct {
argparser.Base
Manifest manifest.Data

// Required.
ServiceName argparser.OptionalServiceNameID
ServiceVersion argparser.OptionalServiceVersion
User argparser.OptionalString
URL argparser.OptionalString
Index argparser.OptionalString
Token argparser.OptionalString

// Optional.
AutoClone argparser.OptionalAutoClone
EndpointName argparser.OptionalString // Can't shadow argparser.Base method Name().
Format argparser.OptionalString
FormatVersion argparser.OptionalInt
MessageType argparser.OptionalString
Placement argparser.OptionalString
ResponseCondition argparser.OptionalString
TimestampFormat argparser.OptionalString
}

// NewCreateCommand returns a usable command registered under the parent.
func NewCreateCommand(parent argparser.Registerer, g *global.Data) *CreateCommand {
c := CreateCommand{
Base: argparser.Base{
Globals: g,
},
}
c.CmdClause = parent.Command("create", "Create a Grafana Cloud Logs logging endpoint on a Fastly service version").Alias("add")

// Required.
c.CmdClause.Flag("name", "The name of the Grafana Cloud Logs logging endpoint. Used as a primary key for API access").Short('n').Action(c.EndpointName.Set).StringVar(&c.EndpointName.Value)
c.RegisterFlag(argparser.StringFlagOpts{
Name: argparser.FlagVersionName,
Description: argparser.FlagVersionDesc,
Dst: &c.ServiceVersion.Value,
Required: true,
})
c.RegisterFlag(argparser.StringFlagOpts{
Name: argparser.FlagServiceIDName,
Description: argparser.FlagServiceIDDesc,
Dst: &g.Manifest.Flag.ServiceID,
Short: 's',
})
c.RegisterFlag(argparser.StringFlagOpts{
Action: c.ServiceName.Set,
Name: argparser.FlagServiceName,
Description: argparser.FlagServiceNameDesc,
Dst: &c.ServiceName.Value,
})

// Optional.
c.RegisterAutoCloneFlag(argparser.AutoCloneFlagOpts{
Action: c.AutoClone.Set,
Dst: &c.AutoClone.Value,
})
common.Format(c.CmdClause, &c.Format)
common.FormatVersion(c.CmdClause, &c.FormatVersion)
common.MessageType(c.CmdClause, &c.MessageType)
common.Placement(c.CmdClause, &c.Placement)
common.ResponseCondition(c.CmdClause, &c.ResponseCondition)

c.CmdClause.Flag("index", `The stream identifier`).Action(c.Index.Set).StringVar(&c.Index.Value)
c.CmdClause.Flag("url", "The URL of your Grafana instance").Action(c.URL.Set).StringVar(&c.URL.Value)
c.CmdClause.Flag("user", "Your Grafana User ID.").Action(c.User.Set).StringVar(&c.User.Value)
c.CmdClause.Flag("auth-token", "Your Grafana Access Policy Token").Action(c.Token.Set).StringVar(&c.Token.Value)

return &c
}

// ConstructInput transforms values parsed from CLI flags into an object to be used by the API client library.
func (c *CreateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.CreateGrafanaCloudLogsInput, error) {
input := fastly.CreateGrafanaCloudLogsInput{
ServiceID: serviceID,
ServiceVersion: serviceVersion,
}

if c.EndpointName.WasSet {
input.Name = &c.EndpointName.Value
}
if c.Format.WasSet {
input.Format = &c.Format.Value
}
if c.FormatVersion.WasSet {
input.FormatVersion = &c.FormatVersion.Value
}
if c.MessageType.WasSet {
input.MessageType = &c.MessageType.Value
}
if c.Index.WasSet {
input.Index = &c.Index.Value
}
if c.URL.WasSet {
input.URL = &c.URL.Value
}
if c.User.WasSet {
input.User = &c.User.Value
}
if c.Token.WasSet {
input.Token = &c.Token.Value
}
if c.Placement.WasSet {
input.Placement = &c.Placement.Value
}
if c.ResponseCondition.WasSet {
input.ResponseCondition = &c.ResponseCondition.Value
}
return &input, nil
}

// Exec invokes the application logic for the command.
func (c *CreateCommand) Exec(_ io.Reader, out io.Writer) error {
serviceID, serviceVersion, err := argparser.ServiceDetails(argparser.ServiceDetailsOpts{
Active: optional.Of(false),
Locked: optional.Of(false),
AutoCloneFlag: c.AutoClone,
APIClient: c.Globals.APIClient,
Manifest: *c.Globals.Manifest,
Out: out,
ServiceNameFlag: c.ServiceName,
ServiceVersionFlag: c.ServiceVersion,
VerboseMode: c.Globals.Flags.Verbose,
})
if err != nil {
c.Globals.ErrLog.AddWithContext(err, map[string]any{
"Service ID": serviceID,
"Service Version": errors.ServiceVersion(serviceVersion),
})
return err
}

input, err := c.ConstructInput(serviceID, fastly.ToValue(serviceVersion.Number))
if err != nil {
c.Globals.ErrLog.Add(err)
return err
}

d, err := c.Globals.APIClient.CreateGrafanaCloudLogs(input)
if err != nil {
c.Globals.ErrLog.Add(err)
return err
}

text.Success(out,
"Created Grafana Cloud Logs logging endpoint %s (service %s version %d)",
fastly.ToValue(d.Name),
fastly.ToValue(d.ServiceID),
fastly.ToValue(d.ServiceVersion),
)
return nil
}
93 changes: 93 additions & 0 deletions pkg/commands/logging/grafanacloudlogs/delete.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
package grafanacloudlogs

import (
"io"

"github.com/fastly/go-fastly/v9/fastly"

"4d63.com/optional"
"github.com/fastly/cli/pkg/argparser"
"github.com/fastly/cli/pkg/errors"
"github.com/fastly/cli/pkg/global"
"github.com/fastly/cli/pkg/text"
)

// DeleteCommand calls the Fastly API to delete a Grafana Cloud Logs logging endpoint.
type DeleteCommand struct {
argparser.Base
Input fastly.DeleteGrafanaCloudLogsInput
serviceName argparser.OptionalServiceNameID
serviceVersion argparser.OptionalServiceVersion
autoClone argparser.OptionalAutoClone
}

// NewDeleteCommand returns a usable command registered under the parent.
func NewDeleteCommand(parent argparser.Registerer, g *global.Data) *DeleteCommand {
c := DeleteCommand{
Base: argparser.Base{
Globals: g,
},
}
c.CmdClause = parent.Command("delete", "Delete a GrafanaCloudLogs logging endpoint on a Fastly service version").Alias("remove")

// Required.
c.CmdClause.Flag("name", "The name of the Grafana Cloud Logs logging object").Short('n').Required().StringVar(&c.Input.Name)
c.RegisterFlag(argparser.StringFlagOpts{
Name: argparser.FlagVersionName,
Description: argparser.FlagVersionDesc,
Dst: &c.serviceVersion.Value,
Required: true,
})

// Optional.
c.RegisterAutoCloneFlag(argparser.AutoCloneFlagOpts{
Action: c.autoClone.Set,
Dst: &c.autoClone.Value,
})
c.RegisterFlag(argparser.StringFlagOpts{
Name: argparser.FlagServiceIDName,
Description: argparser.FlagServiceIDDesc,
Dst: &g.Manifest.Flag.ServiceID,
Short: 's',
})
c.RegisterFlag(argparser.StringFlagOpts{
Action: c.serviceName.Set,
Name: argparser.FlagServiceName,
Description: argparser.FlagServiceNameDesc,
Dst: &c.serviceName.Value,
})
return &c
}

// Exec invokes the application logic for the command.
func (c *DeleteCommand) Exec(_ io.Reader, out io.Writer) error {
serviceID, serviceVersion, err := argparser.ServiceDetails(argparser.ServiceDetailsOpts{
Active: optional.Of(false),
Locked: optional.Of(false),
AutoCloneFlag: c.autoClone,
APIClient: c.Globals.APIClient,
Manifest: *c.Globals.Manifest,
Out: out,
ServiceNameFlag: c.serviceName,
ServiceVersionFlag: c.serviceVersion,
VerboseMode: c.Globals.Flags.Verbose,
})
if err != nil {
c.Globals.ErrLog.AddWithContext(err, map[string]any{
"Service ID": serviceID,
"Service Version": errors.ServiceVersion(serviceVersion),
})
return err
}

c.Input.ServiceID = serviceID
c.Input.ServiceVersion = fastly.ToValue(serviceVersion.Number)

if err := c.Globals.APIClient.DeleteGrafanaCloudLogs(&c.Input); err != nil {
c.Globals.ErrLog.Add(err)
return err
}

text.Success(out, "Deleted Grafana Cloud Logs logging endpoint %s (service %s version %d)", c.Input.Name, c.Input.ServiceID, c.Input.ServiceVersion)
return nil
}
Loading
Loading