report

Documentation

Overview

Package report provides APIs for generating incident reports.

Index

• func Generate(request GenerateRequest) (string, error)
• func Upload(request UploadRequest) error
• type GenerateRequest
• type UploadRequest

Functions

func Generate

func Generate(request GenerateRequest) (string, error)

Generate generates an incident report for the specified team and time range. It fetches incidents from Datadog, pages from PagerDuty, and then associates pages with incidents and generates a markdown report.

func Upload

func Upload(request UploadRequest) error

Upload creates a new Confluence page with the given details

Types

type GenerateRequest

type GenerateRequest struct {
	// Name of Datadog teams
	Teams []string
	// Name of PagerDuty teams
	PdTeams []string
	// Start date of the report, in the format "YYYY-MM-DD" i.e. time.DateOnly
	Since string
	// End date of the report, in the format "YYYY-MM-DD" i.e. time.DateOnly
	Until string
	// Tag filters to use when fetching PagerDuty pages
	TagFilters []string
	// PagerDuty API token to use when fetching pages
	AuthToken string
	// PagerDuty page urgency
	Urgency string
	// Replacement regex to apply to PagerDuty page titles
	Replace []string
	// Datadog API key to use when fetching incidents
	DdApiKey string
	// Datadog application key to use when fetching incidents
	DdAppKey string
}

type UploadRequest

type UploadRequest struct {
	ConfluenceSubdomain string
	ConfluenceUsername  string
	ConfluenceToken     string
	SpaceKey            string
	ParentId            string
	MarkdownContent     string
}