metadatav1

Documentation

Index

• Constants
• Variables
• func ApplyAnnotationsTemplate(templateAnn string, dst map[string]string) bool
• type Alignment
• type DataSource
• type EllipsisType
• type Field
• type GadgetMetadata

Constants

const (
	ColumnsWidthAnnotation     = "columns.width"
	ColumnsMaxWidthAnnotation  = "columns.maxwidth"
	ColumnsMinWidthAnnotation  = "columns.minwidth"
	ColumnsAlignmentAnnotation = "columns.alignment"
	ColumnsEllipsisAnnotation  = "columns.ellipsis"
	ColumnsHiddenAnnotation    = "columns.hidden"
	ColumnsFixedAnnotation     = "columns.fixed"
	ColumnsHexAnnotation       = "columns.hex"
	ColumnsAliasAnnotation     = "columns.alias"

	DescriptionAnnotation = "description"
	TemplateAnnotation    = "template"
)

const (
	DefaultColumnWidth = 16
)

Variables

var AnnotationsTemplates = map[string]map[string]string{
	"timestamp": {
		ColumnsWidthAnnotation:    "35",
		ColumnsMaxWidthAnnotation: "35",
		ColumnsEllipsisAnnotation: "end",
		ColumnsHiddenAnnotation:   "true",
		DescriptionAnnotation:     "Microseconds since Unix epoch",
	},
	"bytes": {
		ColumnsWidthAnnotation:     "10",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"duration": {
		ColumnsWidthAnnotation:     "20",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"node": {
		ColumnsWidthAnnotation:    "30",
		ColumnsEllipsisAnnotation: string(EllipsisMiddle),
	},
	"pod": {
		ColumnsWidthAnnotation:    "30",
		ColumnsEllipsisAnnotation: string(EllipsisMiddle),
	},
	"container": {
		ColumnsWidthAnnotation: "30",
	},
	"namespace": {
		ColumnsWidthAnnotation: "30",
	},
	"containerImageName": {
		ColumnsWidthAnnotation: "30",
	},
	"containerPid": {
		ColumnsWidthAnnotation:     "6",
		ColumnsHiddenAnnotation:    "true",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"containerImageDigest": {
		ColumnsWidthAnnotation: "30",
	},
	"containerStartedAt": {
		ColumnsHiddenAnnotation: "true",
		ColumnsWidthAnnotation:  "35",
	},
	"comm": {
		DescriptionAnnotation:     "Process name",
		ColumnsMaxWidthAnnotation: "16",
	},
	"pcomm": {
		DescriptionAnnotation:     "Parent process name",
		ColumnsMaxWidthAnnotation: "16",
		ColumnsHiddenAnnotation:   "true",
	},
	"pid": {
		DescriptionAnnotation:      "Process ID",
		ColumnsMinWidthAnnotation:  "7",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"ppid": {
		DescriptionAnnotation:      "Parent process ID",
		ColumnsMinWidthAnnotation:  "7",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
		ColumnsHiddenAnnotation:    "true",
	},
	"tid": {
		DescriptionAnnotation:      "Thread ID",
		ColumnsMinWidthAnnotation:  "7",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"uid": {
		DescriptionAnnotation:      "User ID",
		ColumnsMinWidthAnnotation:  "8",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"gid": {
		DescriptionAnnotation:      "Group ID",
		ColumnsMinWidthAnnotation:  "8",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"ns": {
		ColumnsHiddenAnnotation:    "true",
		ColumnsWidthAnnotation:     "12",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"mntns_id": {
		DescriptionAnnotation:      "Mount namespace ID",
		ColumnsHiddenAnnotation:    "true",
		ColumnsWidthAnnotation:     "12",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"netns_id": {
		DescriptionAnnotation:      "Network namespace ID",
		ColumnsHiddenAnnotation:    "true",
		ColumnsWidthAnnotation:     "12",
		ColumnsAlignmentAnnotation: string(AlignmentRight),
	},
	"l4endpoint": {
		ColumnsMinWidthAnnotation: "22",
		ColumnsWidthAnnotation:    "40",
		ColumnsMaxWidthAnnotation: "52",
	},
	"syscall": {
		ColumnsWidthAnnotation:    "18",
		ColumnsMaxWidthAnnotation: "28",
	},
	"errorString": {
		ColumnsWidthAnnotation: "12",
	},
}

Functions

func ApplyAnnotationsTemplate

func ApplyAnnotationsTemplate(templateAnn string, dst map[string]string) bool

Types

type Alignment

type Alignment string

const (
	AlignmenNone   Alignment = ""
	AlignmentLeft  Alignment = "left"
	AlignmentRight Alignment = "right"
)

type DataSource

type DataSource struct {
	Annotations map[string]string `yaml:"annotations,omitempty"`
	Fields      map[string]Field  `yaml:"fields"`
}

type EllipsisType

type EllipsisType string

const (
	EllipsisNone   EllipsisType = ""
	EllipsisStart  EllipsisType = "start"
	EllipsisMiddle EllipsisType = "middle"
	EllipsisEnd    EllipsisType = "end"
)

type Field

type Field struct {
	Annotations map[string]string `yaml:"annotations,omitempty"`
}

type GadgetMetadata

type GadgetMetadata struct {
	// Gadget name
	Name string `yaml:"name"`
	// Gadget description
	Description string `yaml:"description,omitempty"`
	// HomepageURL is the URL to the gadget's homepage
	HomepageURL string `yaml:"homepageURL,omitempty"`
	// DocumentationURL is the URL to the gadget's documentation
	DocumentationURL string `yaml:"documentationURL,omitempty"`
	// SourceURL is the URL to the gadget's source code repository
	SourceURL string `yaml:"sourceURL,omitempty"`
	// Annotations is a map of key-value pairs that provide additional information about the gadget
	Annotations map[string]string `yaml:"annotations,omitempty"`
	// DataSources exposed by the gadget
	DataSources map[string]*DataSource `yaml:"datasources,omitempty"`
	// Params exposed by this gadget. It includes params for different operators
	Params map[string]map[string]params.ParamDesc `yaml:"params,omitempty"`
}