docs

package

v0.0.0-...-09a8804 Latest Latest Go to latest Published: Nov 12, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/avlitman/operator-observability

Links

Open Source Insights

Documentation ¶

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

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.

Types ¶

This section is empty.

Source Files ¶

View all Source files

metrics.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL