examples

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

README

Purpose of the examples

This directory contains various examples of SLOs compliant to the OpenSLO specification with additional context. You can use it as a supplement for spec to explain more sophisticated features with concrete examples and additional goal oriented description. It provides additional context to show how specific features can be used in real-world scenarios. It can provide practical knowledge and inspiration for defining own SLOs.

Note: the example YAML files in examples are from github.com/OpenSLO/OpenSLO which is available under the Apache 2.0 license. This moduel adds Go representations with automated tests.

Contribution guildline

Present real-world use cases with additional context. Please include not only definitions but also a detailed description.

In the description at least try to answer the following questions.

  • What do you measure?
  • Why do you measure this?
  • How it helps you/team/company/users, etc?

Links to other resources like literature are highly appreciated.

Table of contents

  • Budgeting method - compares Occurrences, Timeslices and RatioTimeslices in terms of burned budget for hypothetical situation

  • Treat low traffic equally important - some systems have to maintain high reliability no matter if a handful or hundreds of people actively use it.

Documentation

Index

Constants

View Source
const (
	SetAIAgents        = "ai-agents"
	SetBudgetingMethod = "budgeting-method"
	SetREDMetrics      = "red-metrics"
	SetSAASCRM         = "saas-crm"
	SetLowTraffic      = "treat-low-traffic-as-equally-important"
	SetUSEMetrics      = "use-metrics"
)

Variables

This section is empty.

Functions

func ExampleSLOsByDirectory

func ExampleSLOsByDirectory() map[string][]v1.SLO

func SLOsByDirAndFileSlug added in v0.3.0

func SLOsByDirAndFileSlug() map[string]map[string][]v1.SLO

func WriteExampleJSONAndYAMLFiles added in v0.3.0

func WriteExampleJSONAndYAMLFiles(examplesDir string) error

Types

This section is empty.

Jump to

Keyboard shortcuts

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