reports

Documentation

Index

• type Client
  • func NewClient(cfg Config) (*Client, error)
  • func (c *Client) GenerateDigestReport(teamID, teamName, dateFrom, dateTo, liveReportURL string, recipients []string, ...) error
• type Config
• type Notification

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg Config) (*Client, error)

NewClient builds a new reports client.

func (*Client) GenerateDigestReport

func (c *Client) GenerateDigestReport(teamID, teamName, dateFrom, dateTo, liveReportURL string,
	recipients []string, severitiesStats map[string]int, autoSend bool) error

GenerateDigestReport pushes an SNS event to trigger the digest report generation for the specified teamID.

type Config

type Config struct {
	SNSARN      string `mapstructure:"sns_arn"`
	SNSEndpoint string `mapstructure:"sns_endpoint"`
	InsecureTLS bool   `mapstructure:"insecure_tls"`
	VulcanUIURL string `mapstructure:"vulcanui_url"`
}

Config contains the configuration parameters for report related actions.

type Notification

type Notification struct {
	Subject string `json:"subject"`
	Body    string `json:"body"`
	Format  string `json:"format"`
}

Notification represents a report notification.