zpages

Documentation

Index

• func WriteHTMLComponentHeader(w io.Writer, chd ComponentHeaderData)
• func WriteHTMLExtensionsSummaryTable(w io.Writer, spd SummaryExtensionsTableData)
• func WriteHTMLFeaturesTable(w io.Writer, ftd FeatureGateTableData)
• func WriteHTMLPageFooter(w io.Writer)
• func WriteHTMLPageHeader(w io.Writer, hd HeaderData)
• func WriteHTMLPipelinesSummaryTable(w io.Writer, spd SummaryPipelinesTableData)
• func WriteHTMLPropertiesTable(w io.Writer, chd PropertiesTableData)
• type ComponentHeaderData
• type FeatureGateTableData
• type FeatureGateTableRowData
• type HeaderData
• type PropertiesTableData
• type SummaryExtensionsTableData
• type SummaryExtensionsTableRowData
• type SummaryPipelinesTableData
• type SummaryPipelinesTableRowData

Functions

func WriteHTMLComponentHeader

func WriteHTMLComponentHeader(w io.Writer, chd ComponentHeaderData)

WriteHTMLComponentHeader writes the header for components.

func WriteHTMLExtensionsSummaryTable

func WriteHTMLExtensionsSummaryTable(w io.Writer, spd SummaryExtensionsTableData)

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

func WriteHTMLFeaturesTable

func WriteHTMLFeaturesTable(w io.Writer, ftd FeatureGateTableData)

WriteHTMLFeaturesTable writes a table summarizing registered feature gates.

func WriteHTMLPageFooter

func WriteHTMLPageFooter(w io.Writer)

WriteHTMLPageFooter writes the footer.

func WriteHTMLPageHeader

func WriteHTMLPageHeader(w io.Writer, hd HeaderData)

WriteHTMLPageHeader writes the header.

func WriteHTMLPipelinesSummaryTable

func WriteHTMLPipelinesSummaryTable(w io.Writer, spd SummaryPipelinesTableData)

WriteHTMLPipelinesSummaryTable 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)

WriteHTMLPropertiesTable writes the HTML for properties table.

Types

type ComponentHeaderData

type ComponentHeaderData struct {
	Name              string
	ComponentEndpoint string
	Link              bool
}

ComponentHeaderData contains data for component header template.

type FeatureGateTableData

type FeatureGateTableData struct {
	Rows []FeatureGateTableRowData
}

FeatureGateTableData contains data for feature gate table template.

type FeatureGateTableRowData

type FeatureGateTableRowData struct {
	ID           string
	Enabled      bool
	Description  string
	Stage        string
	FromVersion  string
	ToVersion    string
	ReferenceURL string
}

FeatureGateTableRowData contains data for one row in feature gate table 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 {
	Rows []SummaryExtensionsTableRowData
}

SummaryExtensionsTableData contains data for extensions summary table template.

type SummaryExtensionsTableRowData

type SummaryExtensionsTableRowData struct {
	FullName string
	Enabled  bool
}

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

type SummaryPipelinesTableData

type SummaryPipelinesTableData struct {
	Rows []SummaryPipelinesTableRowData
}

SummaryPipelinesTableData contains data for pipelines summary table template.

type SummaryPipelinesTableRowData

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

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