topics

Documentation

Overview

Package topics defines several canonical ControlZ topics.

Index

• func ArgsTopic() fw.Topic
• func EnvTopic() fw.Topic
• func MemTopic() fw.Topic
• func MetricsTopic() fw.Topic
• func NewCollectionTopic(title string, prefix string, collections ...ReadableCollection) fw.Topic
• func ProcTopic() fw.Topic
• func ScopeTopic() fw.Topic
• func SignalsTopic() fw.Topic
• func VersionTopic() fw.Topic
• type ReadableCollection
  • func NewStaticCollection(name string, items map[string]interface{}) ReadableCollection

Functions

func ArgsTopic

func ArgsTopic() fw.Topic

ArgsTopic returns a ControlZ topic that allows visualization of process command-line arguments.

func EnvTopic

func EnvTopic() fw.Topic

EnvTopic returns a ControlZ topic that allows visualization of process environment variables.

func MemTopic

func MemTopic() fw.Topic

MemTopic returns a ControlZ topic that allows visualization of process memory usage.

func MetricsTopic

func MetricsTopic() fw.Topic

MetricsTopic returns a ControlZ topic that allows visualization of process metrics.

func NewCollectionTopic

func NewCollectionTopic(title string, prefix string, collections ...ReadableCollection) fw.Topic

NewCollectionTopic creates a new custom topic that exposes the provided collections.

func ProcTopic

func ProcTopic() fw.Topic

ProcTopic returns a ControlZ topic that allows visualization of process state.

func ScopeTopic

func ScopeTopic() fw.Topic

ScopeTopic returns a ControlZ topic that allows visualization of process logging scopes.

func SignalsTopic

func SignalsTopic() fw.Topic

SignalsTopic returns a ControlZ topic that sends command signals to the process

func VersionTopic

func VersionTopic() fw.Topic

VersionTopic returns a ControlZ topic that allows visualization of versioning info.

Types

type ReadableCollection

type ReadableCollection interface {
	Name() string
	Keys() (keys []string, err error)
	Get(id string) (interface{}, error)
}

ReadableCollection is a staticCollection collection of entries to be exposed via CtrlZ.

func NewStaticCollection

func NewStaticCollection(name string, items map[string]interface{}) ReadableCollection

NewStaticCollection creates a static collection from the given set of items.