docs

Documentation

Index

• func BuildAlertsDocs(alerts []promv1.Rule) string
• func BuildAlertsDocsWithCustomTemplate(alerts []promv1.Rule, tplString string) string
• func BuildMetricsDocs(metrics []operatormetrics.Metric, recordingRules []operatorrules.RecordingRule) string
• func BuildMetricsDocsWithCustomTemplate(metrics []operatormetrics.Metric, recordingRules []operatorrules.RecordingRule, ...) string

Functions

func BuildAlertsDocs

func BuildAlertsDocs(alerts []promv1.Rule) string

BuildAlertsDocs returns a string with the documentation for the given metrics.

func BuildAlertsDocsWithCustomTemplate

func BuildAlertsDocsWithCustomTemplate(
	alerts []promv1.Rule,
	tplString string,
) string

BuildAlertsDocsWithCustomTemplate returns a string with the documentation for the given alerts, using the given template.

func BuildMetricsDocs

func BuildMetricsDocs(metrics []operatormetrics.Metric, recordingRules []operatorrules.RecordingRule) string

BuildMetricsDocs returns a string with the documentation for the given metrics.

func BuildMetricsDocsWithCustomTemplate

func BuildMetricsDocsWithCustomTemplate(
	metrics []operatormetrics.Metric,
	recordingRules []operatorrules.RecordingRule,
	tplString string,
) string

BuildMetricsDocsWithCustomTemplate returns a string with the documentation for the given metrics, using the given template.