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

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
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