formatters

package

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

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 CheckCondition(code *gojq.Code, e *EventMsg) (bool, error)
func DecodeConfig(src, dst interface{}) error
func Register(name string, initFn Initializer)
func ResponsesFlat(msgs ...proto.Message) (map[string]interface{}, error)
type BaseProcessor
type EventMsg
- func (e *EventMsg) String() string
- func (e *EventMsg) ToMap() map[string]interface{}
type EventProcessor
- func MakeEventProcessors(logger *log.Logger, processorNames []string, ...) ([]EventProcessor, error)
type Initializer
type MarshalOptions
type Option

Constants ¶

This section is empty.

Variables ¶

View Source

var EventProcessorTypes = []string{
	"event-add-tag",
	"event-allow",
	"event-combine",
	"event-convert",
	"event-data-convert",
	"event-date-string",
	"event-delete",
	"event-drop",
	"event-duration-convert",
	"event-extract-tags",
	"event-group-by",
	"event-ieeefloat32",
	"event-jq",
	"event-merge",
	"event-override-ts",
	"event-rate-limit",
	"event-starlark",
	"event-strings",
	"event-time-epoch",
	"event-to-tag",
	"event-trigger",
	"event-value-tag",
	"event-value-tag-v2",
	"event-write",
}

View Source

var EventProcessors = map[string]Initializer{}

Functions ¶

func CheckCondition ¶

func CheckCondition(code *gojq.Code, e *EventMsg) (bool, error)

func DecodeConfig ¶

func DecodeConfig(src, dst interface{}) error

func Register ¶

func Register(name string, initFn Initializer)

func ResponsesFlat ¶

func ResponsesFlat(msgs ...proto.Message) (map[string]interface{}, error)

Types ¶

type BaseProcessor ¶ added in v0.42.1

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

func (*BaseProcessor) Apply ¶ added in v0.42.1

func (p *BaseProcessor) Apply(...*EventMsg) []*EventMsg

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

func (p *BaseProcessor) Init(interface{}, ...Option) error

func (*BaseProcessor) WithActions ¶ added in v0.42.1

func (p *BaseProcessor) WithActions(act map[string]map[string]interface{})

func (*BaseProcessor) WithLogger ¶ added in v0.42.1

func (p *BaseProcessor) WithLogger(l *log.Logger)

func (*BaseProcessor) WithProcessors ¶ added in v0.42.1

func (p *BaseProcessor) WithProcessors(procs map[string]map[string]any)

func (*BaseProcessor) WithTargets ¶ added in v0.42.1

func (p *BaseProcessor) WithTargets(map[string]*types.TargetConfig)

type EventMsg ¶

type EventMsg struct {
	Name      string                 `json:"name,omitempty"`
	Timestamp int64                  `json:"timestamp,omitempty"`
	Tags      map[string]string      `json:"tags,omitempty"`
	Values    map[string]interface{} `json:"values,omitempty"`
	Deletes   []string               `json:"deletes,omitempty"`
}

EventMsg represents a gNMI update message, The name is derived from the subscription in case the update was received in a subscribeResponse the tags are derived from the keys in gNMI path as well as some metadata from the subscription.

func EventFromMap ¶

func EventFromMap(m map[string]interface{}) (*EventMsg, error)

func GetResponseToEventMsgs ¶

func GetResponseToEventMsgs(rsp *gnmi.GetResponse, meta map[string]string, eps ...EventProcessor) ([]*EventMsg, error)

func ResponseToEventMsgs ¶

func ResponseToEventMsgs(name string, rsp *gnmi.SubscribeResponse, meta map[string]string, eps ...EventProcessor) ([]*EventMsg, error)

ResponseToEventMsgs //

func (*EventMsg) String ¶

func (e *EventMsg) String() string

func (*EventMsg) ToMap ¶

func (e *EventMsg) ToMap() map[string]interface{}

type EventProcessor ¶

type EventProcessor interface {
	Init(interface{}, ...Option) error
	Apply(...*EventMsg) []*EventMsg

	WithTargets(map[string]*types.TargetConfig)
	WithLogger(l *log.Logger)
	WithActions(act map[string]map[string]interface{})
	WithProcessors(procs map[string]map[string]any)
}

func MakeEventProcessors ¶

func MakeEventProcessors(
	logger *log.Logger,
	processorNames []string,
	ps map[string]map[string]interface{},
	tcs map[string]*types.TargetConfig,
	acts map[string]map[string]interface{},
) ([]EventProcessor, error)

type Initializer ¶

type Initializer func() EventProcessor

type MarshalOptions ¶

type MarshalOptions struct {
	Multiline        bool
	Indent           string
	Format           string
	OverrideTS       bool
	ValuesOnly       bool
	CalculateLatency bool
}

func (*MarshalOptions) FormatJSON ¶

func (o *MarshalOptions) FormatJSON(m proto.Message, meta map[string]string) ([]byte, error)

FormatJSON formats a proto.Message and returns a []byte and an error

func (*MarshalOptions) Marshal ¶

func (o *MarshalOptions) Marshal(msg proto.Message, meta map[string]string, eps ...EventProcessor) ([]byte, error)

Marshal //

func (*MarshalOptions) OverrideTimestamp ¶

func (o *MarshalOptions) OverrideTimestamp(msg proto.Message) proto.Message

type Option ¶

type Option func(EventProcessor)

func WithActions ¶

func WithActions(acts map[string]map[string]interface{}) Option

func WithLogger ¶

func WithLogger(l *log.Logger) Option

func WithProcessors ¶

func WithProcessors(procs map[string]map[string]interface{}) Option

func WithTargets ¶

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
all
event_add_tag
event_allow
event_combine
event_convert
event_data_convert
event_date_string
event_delete
event_drop
event_duration_convert
event_extract_tags
event_group_by
event_ieeefloat32
event_jq
event_merge
event_override_ts
event_plugin
event_rate_limit
event_starlark
event_strings
event_time_epoch
event_to_tag
event_trigger
event_value_tag
event_value_tag_v2
event_write
plugin_manager

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