internal

Documentation

Index

• func Dir(useLocal bool, name string) http.FileSystem
• func FS(useLocal bool) http.FileSystem
• func FSByte(useLocal bool, name string) ([]byte, error)
• func FSMustByte(useLocal bool, name string) []byte
• func FSMustString(useLocal bool, name string) string
• func FSString(useLocal bool, name string) (string, error)
• func WriteHTMLComponentHeader(w io.Writer, chd ComponentHeaderData)
• func WriteHTMLExtensionsSummaryTable(w io.Writer, spd SummaryExtensionsTableData)
• func WriteHTMLFooter(w io.Writer)
• func WriteHTMLHeader(w io.Writer, hd HeaderData)
• func WriteHTMLPipelinesSummaryTable(w io.Writer, spd SummaryPipelinesTableData)
• func WriteHTMLPropertiesTable(w io.Writer, chd PropertiesTableData)
• type ComponentHeaderData
• type HeaderData
• type PropertiesTableData
• type SummaryExtensionsTableData
• type SummaryExtensionsTableRowData
• type SummaryPipelinesTableData
• type SummaryPipelinesTableRowData

Functions

func Dir

func Dir(useLocal bool, name string) http.FileSystem

Dir returns a http.Filesystem for the embedded assets on a given prefix dir. If useLocal is true, the filesystem's contents are instead used.

func FS

func FS(useLocal bool) http.FileSystem

FS returns a http.Filesystem for the embedded assets. If useLocal is true, the filesystem's contents are instead used.

func FSByte

func FSByte(useLocal bool, name string) ([]byte, error)

FSByte returns the named file from the embedded assets. If useLocal is true, the filesystem's contents are instead used.

func FSMustByte

func FSMustByte(useLocal bool, name string) []byte

FSMustByte is the same as FSByte, but panics if name is not present.

func FSMustString

func FSMustString(useLocal bool, name string) string

FSMustString is the string version of FSMustByte.

func FSString

func FSString(useLocal bool, name string) (string, error)

FSString is the string version of FSByte.

func WriteHTMLComponentHeader

func WriteHTMLComponentHeader(w io.Writer, chd ComponentHeaderData)

WriteHTMLFooter writes the footer.

func WriteHTMLExtensionsSummaryTable

func WriteHTMLExtensionsSummaryTable(w io.Writer, spd SummaryExtensionsTableData)

WriteHTMLSummaryTable writes the summary table for one component type (receivers, processors, exporters). Id does not write the header or footer.

func WriteHTMLFooter

func WriteHTMLFooter(w io.Writer)

WriteHTMLFooter writes the footer.

func WriteHTMLHeader

func WriteHTMLHeader(w io.Writer, hd HeaderData)

WriteHTMLFooter writes the header.

func WriteHTMLPipelinesSummaryTable

func WriteHTMLPipelinesSummaryTable(w io.Writer, spd SummaryPipelinesTableData)

WriteHTMLSummaryTable writes the summary table for one component type (receivers, processors, exporters). Id does not write the header or footer.

func WriteHTMLPropertiesTable

func WriteHTMLPropertiesTable(w io.Writer, chd PropertiesTableData)

WriteHTMLFooter writes the footer.

Types

type ComponentHeaderData

type ComponentHeaderData struct {
	Name              string
	ComponentEndpoint string
	Link              bool
}

ComponentHeaderData contains data for component header template.

type HeaderData

type HeaderData struct {
	Title string
}

HeaderData contains data for the header template.

type PropertiesTableData

type PropertiesTableData struct {
	Name       string
	Properties [][2]string
}

PropertiesTableData contains data for properties table template.

type SummaryExtensionsTableData

type SummaryExtensionsTableData struct {
	ComponentEndpoint string
	Rows              []SummaryExtensionsTableRowData
}

SummaryExtensionsTableData contains data for extensions summary table template.

type SummaryExtensionsTableRowData

type SummaryExtensionsTableRowData struct {
	FullName string
	Enabled  bool
}

SummaryExtensionsTableData contains data for one row in extensions summary table template.

type SummaryPipelinesTableData

type SummaryPipelinesTableData struct {
	ComponentEndpoint string
	Rows              []SummaryPipelinesTableRowData
}

SummaryPipelinesTableData contains data for pipelines summary table template.

type SummaryPipelinesTableRowData

type SummaryPipelinesTableRowData struct {
	FullName            string
	InputType           string
	MutatesConsumedData bool
	Receivers           []string
	Processors          []string
	Exporters           []string
}

SummaryPipelinesTableRowData contains data for one row in pipelines summary table template.