outputs

package

v0.42.1 Latest Latest Go to latest Published: Oct 20, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/openconfig/gnmic

Links

Documentation ¶

Index ¶

Variables
func AddSubscriptionTarget(msg proto.Message, meta Meta, addTarget string, tpl *template.Template) (*gnmi.SubscribeResponse, error)
func DecodeConfig(src, dst interface{}) error
func ExecTemplate(content []byte, tpl *template.Template) ([]byte, error)
func Marshal(pmsg protoreflect.ProtoMessage, meta map[string]string, ...) ([][]byte, error)
func Register(name string, initFn Initializer)
type BaseOutput
type Initializer
type Meta
type Option
type Output
type OutputOptions
type ProtoMsg
- func NewProtoMsg(m proto.Message, meta Meta) *ProtoMsg
- func (m *ProtoMsg) GetMeta() Meta
- func (m *ProtoMsg) GetMsg() proto.Message

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	DefaultTargetTemplate = template.Must(
		template.New("target-template").
			Funcs(TemplateFuncs).
			Parse(defaultTargetTemplateString))

	TemplateFuncs = template.FuncMap{
		"host": utils.GetHost,
	}
)

View Source

var OutputTypes = map[string]struct{}{
	"file":             {},
	"influxdb":         {},
	"kafka":            {},
	"nats":             {},
	"prometheus":       {},
	"prometheus_write": {},
	"stan":             {},
	"tcp":              {},
	"udp":              {},
	"gnmi":             {},
	"jetstream":        {},
	"snmp":             {},
	"asciigraph":       {},
}

View Source

var Outputs = map[string]Initializer{}

Functions ¶

func AddSubscriptionTarget ¶

func AddSubscriptionTarget(msg proto.Message, meta Meta, addTarget string, tpl *template.Template) (*gnmi.SubscribeResponse, error)

func DecodeConfig ¶

func DecodeConfig(src, dst interface{}) error

func ExecTemplate ¶

func ExecTemplate(content []byte, tpl *template.Template) ([]byte, error)

func Marshal ¶

func Marshal(pmsg protoreflect.ProtoMessage, meta map[string]string, mo *formatters.MarshalOptions, splitEvents bool, evps ...formatters.EventProcessor) ([][]byte, error)

func Register ¶

func Register(name string, initFn Initializer)

Types ¶

type BaseOutput ¶ added in v0.42.1

type BaseOutput struct {
}

func (*BaseOutput) Close ¶ added in v0.42.1

func (b *BaseOutput) Close() error

func (*BaseOutput) Init ¶ added in v0.42.1

func (b *BaseOutput) Init(context.Context, string, map[string]any, ...Option) error

func (*BaseOutput) RegisterMetrics ¶ added in v0.42.1

func (b *BaseOutput) RegisterMetrics(*prometheus.Registry)

func (*BaseOutput) String ¶ added in v0.42.1

func (b *BaseOutput) String() string

func (*BaseOutput) Write ¶ added in v0.42.1

func (b *BaseOutput) Write(context.Context, proto.Message, Meta)

func (*BaseOutput) WriteEvent ¶ added in v0.42.1

func (b *BaseOutput) WriteEvent(context.Context, *formatters.EventMsg)

type Initializer ¶

type Initializer func() Output

type Meta ¶

type Meta map[string]string

type Option ¶

type Option func(*OutputOptions) error

func WithClusterName ¶

func WithClusterName(name string) Option

func WithEventProcessors ¶

func WithEventProcessors(eps map[string]map[string]any, acts map[string]map[string]any) Option

func WithLogger ¶

func WithLogger(logger *log.Logger) Option

func WithName ¶

func WithName(name string) Option

func WithRegistry ¶

func WithRegistry(reg *prometheus.Registry) Option

func WithTargetsConfig ¶

func WithTargetsConfig(tcs map[string]*types.TargetConfig) Option

type Output ¶

type Output interface {
	Init(context.Context, string, map[string]any, ...Option) error
	Write(context.Context, proto.Message, Meta)
	WriteEvent(context.Context, *formatters.EventMsg)
	Close() error
	String() string
}

type OutputOptions ¶ added in v0.42.1

type OutputOptions struct {
	Name            string
	ClusterName     string
	Logger          *log.Logger
	EventProcessors map[string]map[string]any
	TargetsConfig   map[string]*types.TargetConfig
	Actions         map[string]map[string]any
	Registry        *prometheus.Registry
}

type ProtoMsg ¶

type ProtoMsg struct {
	// contains filtered or unexported fields
}

func NewProtoMsg ¶

func NewProtoMsg(m proto.Message, meta Meta) *ProtoMsg

func (*ProtoMsg) GetMeta ¶

func (m *ProtoMsg) GetMeta() Meta

func (*ProtoMsg) GetMsg ¶

func (m *ProtoMsg) GetMsg() proto.Message

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
all
asciigraph_output
file
gnmi_output
influxdb_output
kafka_output
nats_outputs
jetstream
nats
prometheus_output
prometheus_write_output
snmp_output
tcp_output
udp_output

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