report

Documentation

Index

• Variables
• type Options
• type PDF
  • func New(logger log.Logger, conf config.Config, chromeInstance chrome.Instance, ...) (*PDF, error)
  • func (r *PDF) Generate(ctx context.Context, writer io.Writer) error
  • func (r *PDF) Title() string
• type Report

Variables

var ErrEmptyDashboard = errors.New("empty dashboard model")

Types

type Options

type Options struct {
	DashUID     string
	Layout      string
	Orientation string
	TimeRange   dashboard.TimeRange
}

Options contains Report options.

type PDF

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

PDF represents a PDF report.

func New

func New(logger log.Logger, conf config.Config, chromeInstance chrome.Instance, workerPools worker.Pools, client client.Grafana, options *Options) (*PDF, error)

New creates a new PDF struct.

func (*PDF) Generate

func (r *PDF) Generate(ctx context.Context, writer io.Writer) error

Generate returns the PDF.pdf file. After reading this file, it should be Closed() After closing the file, call PDF.Clean() to delete the file as well the temporary build files.

func (*PDF) Title

func (r *PDF) Title() string

Title returns the dashboard title parsed from the dashboard definition.

type Report

type Report interface {
	Generate(ctx context.Context) ([]byte, error)
}

Report groups functions related to genrating the PDF.