diagnostic

Documentation

Overview

Package diagnostic publishes Ramen's machine-readable diagnostic catalog.

This package is experimental in Ramen v0.1; CLI diagnostic codes remain documented separately from this Go package's compatibility status.

Index

• Constants
• type Catalog
  • func CatalogV1() Catalog
• type Entry

Constants

const CatalogVersion = "ramen.diagnostics.v1"

Types

type Catalog

type Catalog struct {
	Version string  `json:"version"`
	Entries []Entry `json:"entries"`
}

func CatalogV1

func CatalogV1() Catalog

type Entry

type Entry struct {
	Code        string `json:"code"`
	Severity    string `json:"severity"`
	Meaning     string `json:"meaning"`
	LikelyCause string `json:"likely_cause"`
	Repair      string `json:"repair"`
}