entitygraph

README

Entity Graph

Expose application state as a connected graph of entities for visualization.

Introduction

The Entity Graph is a common format for application components to expose their internal state for monitoring in the form of a graph of entities.

• Entities can be shared between components, identified by common identifiers
• Links between entities form edges in the graph.
• Properties on entities and links describe instantaneous metric values.

At runtime, any visualization frameworks can create a CollectEntityGraph directive to collect all active entities exposed by running controllers.

Support

Please open a GitHub issue with any questions / issues.

... or feel free to reach out on Matrix Chat or Discord.

License

Apache 2.0

Documentation

Index

• type CollectEntityGraph
• type ObserveEntityGraph
  • func NewObserveEntityGraph() ObserveEntityGraph

Types

type CollectEntityGraph

type CollectEntityGraph interface {
	// Directive indicates CollectEntityGraph is a directive.
	directive.Directive

	// CollectEntityGraphDirective is a marker function.
	// noop
	CollectEntityGraphDirective()
}

CollectEntityGraph is a directive to collect entity graph entities.

type ObserveEntityGraph

type ObserveEntityGraph interface {
	// Directive indicates CollectEntityGraph is a directive.
	directive.Directive

	// ObserveEntityGraphDirective is a marker function.
	// noop
	ObserveEntityGraphDirective()
}

ObserveEntityGraph is a directive to observe the entity graph.

func NewObserveEntityGraph

func NewObserveEntityGraph() ObserveEntityGraph

NewObserveEntityGraph constructs a new ObserveEntityGraph directive.