plugin_host_logs

package
v0.57.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package plugin_host_logs contains structured plugin log schema types.

Index

Constants

This section is empty.

Variables

View Source
var (
	StructuredLogLevel_name = map[int32]string{
		0: "STRUCTURED_LOG_LEVEL_UNSPECIFIED",
		1: "STRUCTURED_LOG_LEVEL_TRACE",
		2: "STRUCTURED_LOG_LEVEL_DEBUG",
		3: "STRUCTURED_LOG_LEVEL_INFO",
		4: "STRUCTURED_LOG_LEVEL_WARN",
		5: "STRUCTURED_LOG_LEVEL_ERROR",
		6: "STRUCTURED_LOG_LEVEL_FATAL",
	}
	StructuredLogLevel_value = map[string]int32{
		"STRUCTURED_LOG_LEVEL_UNSPECIFIED": 0,
		"STRUCTURED_LOG_LEVEL_TRACE":       1,
		"STRUCTURED_LOG_LEVEL_DEBUG":       2,
		"STRUCTURED_LOG_LEVEL_INFO":        3,
		"STRUCTURED_LOG_LEVEL_WARN":        4,
		"STRUCTURED_LOG_LEVEL_ERROR":       5,
		"STRUCTURED_LOG_LEVEL_FATAL":       6,
	}
)

Enum value maps for StructuredLogLevel.

View Source
var (
	StructuredLogStream_name = map[int32]string{
		0: "STRUCTURED_LOG_STREAM_UNSPECIFIED",
		1: "STRUCTURED_LOG_STREAM_LOGGER",
		2: "STRUCTURED_LOG_STREAM_STDOUT",
		3: "STRUCTURED_LOG_STREAM_STDERR",
	}
	StructuredLogStream_value = map[string]int32{
		"STRUCTURED_LOG_STREAM_UNSPECIFIED": 0,
		"STRUCTURED_LOG_STREAM_LOGGER":      1,
		"STRUCTURED_LOG_STREAM_STDOUT":      2,
		"STRUCTURED_LOG_STREAM_STDERR":      3,
	}
)

Enum value maps for StructuredLogStream.

Functions

func AttachHostLogrusHook

func AttachHostLogrusHook(
	b bus.Bus,
	logger *logrus.Logger,
	hub *Hub,
) func()

AttachHostLogrusHook attaches the host logrus hook once for the bus.

Types

type EmitStructuredLogRequest

type EmitStructuredLogRequest struct {

	// Event is the structured event to append.
	Event *StructuredLogEvent `protobuf:"bytes,1,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

EmitStructuredLogRequest appends a structured log event.

func (*EmitStructuredLogRequest) CloneMessageVT

func (*EmitStructuredLogRequest) CloneVT

func (*EmitStructuredLogRequest) EqualMessageVT

func (this *EmitStructuredLogRequest) EqualMessageVT(thatMsg any) bool

func (*EmitStructuredLogRequest) EqualVT

func (*EmitStructuredLogRequest) GetEvent

func (*EmitStructuredLogRequest) MarshalJSON

func (x *EmitStructuredLogRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the EmitStructuredLogRequest to JSON.

func (*EmitStructuredLogRequest) MarshalProtoJSON

func (x *EmitStructuredLogRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the EmitStructuredLogRequest message to JSON.

func (*EmitStructuredLogRequest) MarshalProtoText

func (x *EmitStructuredLogRequest) MarshalProtoText() string

func (*EmitStructuredLogRequest) MarshalToSizedBufferVT

func (m *EmitStructuredLogRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*EmitStructuredLogRequest) MarshalToVT

func (m *EmitStructuredLogRequest) MarshalToVT(dAtA []byte) (int, error)

func (*EmitStructuredLogRequest) MarshalVT

func (m *EmitStructuredLogRequest) MarshalVT() (dAtA []byte, err error)

func (*EmitStructuredLogRequest) ProtoMessage

func (*EmitStructuredLogRequest) ProtoMessage()

func (*EmitStructuredLogRequest) Reset

func (x *EmitStructuredLogRequest) Reset()

func (*EmitStructuredLogRequest) SizeVT

func (m *EmitStructuredLogRequest) SizeVT() (n int)

func (*EmitStructuredLogRequest) String

func (x *EmitStructuredLogRequest) String() string

func (*EmitStructuredLogRequest) UnmarshalJSON

func (x *EmitStructuredLogRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the EmitStructuredLogRequest from JSON.

func (*EmitStructuredLogRequest) UnmarshalProtoJSON

func (x *EmitStructuredLogRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the EmitStructuredLogRequest message from JSON.

func (*EmitStructuredLogRequest) UnmarshalVT

func (m *EmitStructuredLogRequest) UnmarshalVT(dAtA []byte) error

type EmitStructuredLogResponse

type EmitStructuredLogResponse struct {

	// Sequence is the assigned event sequence.
	Sequence uint64 `protobuf:"varint,1,opt,name=sequence,proto3" json:"sequence,omitempty"`
	// Timestamp is the assigned observation timestamp.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

EmitStructuredLogResponse returns the owner-assigned event metadata.

func (*EmitStructuredLogResponse) CloneMessageVT

func (*EmitStructuredLogResponse) CloneVT

func (*EmitStructuredLogResponse) EqualMessageVT

func (this *EmitStructuredLogResponse) EqualMessageVT(thatMsg any) bool

func (*EmitStructuredLogResponse) EqualVT

func (*EmitStructuredLogResponse) GetSequence

func (x *EmitStructuredLogResponse) GetSequence() uint64

func (*EmitStructuredLogResponse) GetTimestamp

func (x *EmitStructuredLogResponse) GetTimestamp() *timestamppb.Timestamp

func (*EmitStructuredLogResponse) MarshalJSON

func (x *EmitStructuredLogResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the EmitStructuredLogResponse to JSON.

func (*EmitStructuredLogResponse) MarshalProtoJSON

func (x *EmitStructuredLogResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the EmitStructuredLogResponse message to JSON.

func (*EmitStructuredLogResponse) MarshalProtoText

func (x *EmitStructuredLogResponse) MarshalProtoText() string

func (*EmitStructuredLogResponse) MarshalToSizedBufferVT

func (m *EmitStructuredLogResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*EmitStructuredLogResponse) MarshalToVT

func (m *EmitStructuredLogResponse) MarshalToVT(dAtA []byte) (int, error)

func (*EmitStructuredLogResponse) MarshalVT

func (m *EmitStructuredLogResponse) MarshalVT() (dAtA []byte, err error)

func (*EmitStructuredLogResponse) ProtoMessage

func (*EmitStructuredLogResponse) ProtoMessage()

func (*EmitStructuredLogResponse) Reset

func (x *EmitStructuredLogResponse) Reset()

func (*EmitStructuredLogResponse) SizeVT

func (m *EmitStructuredLogResponse) SizeVT() (n int)

func (*EmitStructuredLogResponse) String

func (x *EmitStructuredLogResponse) String() string

func (*EmitStructuredLogResponse) UnmarshalJSON

func (x *EmitStructuredLogResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the EmitStructuredLogResponse from JSON.

func (*EmitStructuredLogResponse) UnmarshalProtoJSON

func (x *EmitStructuredLogResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the EmitStructuredLogResponse message from JSON.

func (*EmitStructuredLogResponse) UnmarshalVT

func (m *EmitStructuredLogResponse) UnmarshalVT(dAtA []byte) error

type Hub

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

Hub owns structured plugin log events for a host process.

func NewHub

func NewHub(opts ...HubOption) *Hub

NewHub constructs a structured log hub.

func (*Hub) Emit

Emit appends an event and fills in the metadata Hub assigns.

func (*Hub) OpenView

func (h *Hub) OpenView(filter *StructuredLogFilter, rng *StructuredLogRange) *View

OpenView opens a mutable structured-log view.

func (*Hub) Snapshot

func (h *Hub) Snapshot(filter *StructuredLogFilter, rng *StructuredLogRange) *StructuredLogState

Snapshot returns the current retained state for a filter and range.

type HubOption

type HubOption func(*Hub)

HubOption configures a Hub.

func WithClock

func WithClock(now func() time.Time) HubOption

WithClock sets the clock Hub reads when it timestamps an event.

func WithRetainedEventLimit

func WithRetainedEventLimit(limit uint32) HubOption

WithRetainedEventLimit sets the maximum number of retained events.

type OpenStructuredLogsRequest

type OpenStructuredLogsRequest struct {

	// Filter selects the events included in the view.
	Filter *StructuredLogFilter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Range selects the initial retained window and follow behavior.
	Range *StructuredLogRange `protobuf:"bytes,2,opt,name=range,proto3" json:"range,omitempty"`
	// contains filtered or unexported fields
}

OpenStructuredLogsRequest opens a structured-log view.

func (*OpenStructuredLogsRequest) CloneMessageVT

func (*OpenStructuredLogsRequest) CloneVT

func (*OpenStructuredLogsRequest) EqualMessageVT

func (this *OpenStructuredLogsRequest) EqualMessageVT(thatMsg any) bool

func (*OpenStructuredLogsRequest) EqualVT

func (*OpenStructuredLogsRequest) GetFilter

func (*OpenStructuredLogsRequest) GetRange

func (*OpenStructuredLogsRequest) MarshalJSON

func (x *OpenStructuredLogsRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the OpenStructuredLogsRequest to JSON.

func (*OpenStructuredLogsRequest) MarshalProtoJSON

func (x *OpenStructuredLogsRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the OpenStructuredLogsRequest message to JSON.

func (*OpenStructuredLogsRequest) MarshalProtoText

func (x *OpenStructuredLogsRequest) MarshalProtoText() string

func (*OpenStructuredLogsRequest) MarshalToSizedBufferVT

func (m *OpenStructuredLogsRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*OpenStructuredLogsRequest) MarshalToVT

func (m *OpenStructuredLogsRequest) MarshalToVT(dAtA []byte) (int, error)

func (*OpenStructuredLogsRequest) MarshalVT

func (m *OpenStructuredLogsRequest) MarshalVT() (dAtA []byte, err error)

func (*OpenStructuredLogsRequest) ProtoMessage

func (*OpenStructuredLogsRequest) ProtoMessage()

func (*OpenStructuredLogsRequest) Reset

func (x *OpenStructuredLogsRequest) Reset()

func (*OpenStructuredLogsRequest) SizeVT

func (m *OpenStructuredLogsRequest) SizeVT() (n int)

func (*OpenStructuredLogsRequest) String

func (x *OpenStructuredLogsRequest) String() string

func (*OpenStructuredLogsRequest) UnmarshalJSON

func (x *OpenStructuredLogsRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the OpenStructuredLogsRequest from JSON.

func (*OpenStructuredLogsRequest) UnmarshalProtoJSON

func (x *OpenStructuredLogsRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the OpenStructuredLogsRequest message from JSON.

func (*OpenStructuredLogsRequest) UnmarshalVT

func (m *OpenStructuredLogsRequest) UnmarshalVT(dAtA []byte) error

type OpenStructuredLogsResponse

type OpenStructuredLogsResponse struct {

	// ResourceId is the resource ID for the opened structured-log view.
	ResourceId uint32 `protobuf:"varint,1,opt,name=resource_id,json=resourceId,proto3" json:"resourceId,omitempty"`
	// State is the initial state of the opened view.
	State *StructuredLogState `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

OpenStructuredLogsResponse returns the resource and initial view state.

func (*OpenStructuredLogsResponse) CloneMessageVT

func (*OpenStructuredLogsResponse) CloneVT

func (*OpenStructuredLogsResponse) EqualMessageVT

func (this *OpenStructuredLogsResponse) EqualMessageVT(thatMsg any) bool

func (*OpenStructuredLogsResponse) EqualVT

func (*OpenStructuredLogsResponse) GetResourceId

func (x *OpenStructuredLogsResponse) GetResourceId() uint32

func (*OpenStructuredLogsResponse) GetState

func (*OpenStructuredLogsResponse) MarshalJSON

func (x *OpenStructuredLogsResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the OpenStructuredLogsResponse to JSON.

func (*OpenStructuredLogsResponse) MarshalProtoJSON

func (x *OpenStructuredLogsResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the OpenStructuredLogsResponse message to JSON.

func (*OpenStructuredLogsResponse) MarshalProtoText

func (x *OpenStructuredLogsResponse) MarshalProtoText() string

func (*OpenStructuredLogsResponse) MarshalToSizedBufferVT

func (m *OpenStructuredLogsResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*OpenStructuredLogsResponse) MarshalToVT

func (m *OpenStructuredLogsResponse) MarshalToVT(dAtA []byte) (int, error)

func (*OpenStructuredLogsResponse) MarshalVT

func (m *OpenStructuredLogsResponse) MarshalVT() (dAtA []byte, err error)

func (*OpenStructuredLogsResponse) ProtoMessage

func (*OpenStructuredLogsResponse) ProtoMessage()

func (*OpenStructuredLogsResponse) Reset

func (x *OpenStructuredLogsResponse) Reset()

func (*OpenStructuredLogsResponse) SizeVT

func (m *OpenStructuredLogsResponse) SizeVT() (n int)

func (*OpenStructuredLogsResponse) String

func (x *OpenStructuredLogsResponse) String() string

func (*OpenStructuredLogsResponse) UnmarshalJSON

func (x *OpenStructuredLogsResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the OpenStructuredLogsResponse from JSON.

func (*OpenStructuredLogsResponse) UnmarshalProtoJSON

func (x *OpenStructuredLogsResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the OpenStructuredLogsResponse message from JSON.

func (*OpenStructuredLogsResponse) UnmarshalVT

func (m *OpenStructuredLogsResponse) UnmarshalVT(dAtA []byte) error

type SetStructuredLogViewRequest

type SetStructuredLogViewRequest struct {

	// Filter selects the events included in the view.
	Filter *StructuredLogFilter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Range selects the retained window and follow behavior.
	Range *StructuredLogRange `protobuf:"bytes,2,opt,name=range,proto3" json:"range,omitempty"`
	// contains filtered or unexported fields
}

SetStructuredLogViewRequest updates an open structured-log view.

func (*SetStructuredLogViewRequest) CloneMessageVT

func (*SetStructuredLogViewRequest) CloneVT

func (*SetStructuredLogViewRequest) EqualMessageVT

func (this *SetStructuredLogViewRequest) EqualMessageVT(thatMsg any) bool

func (*SetStructuredLogViewRequest) EqualVT

func (*SetStructuredLogViewRequest) GetFilter

func (*SetStructuredLogViewRequest) GetRange

func (*SetStructuredLogViewRequest) MarshalJSON

func (x *SetStructuredLogViewRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the SetStructuredLogViewRequest to JSON.

func (*SetStructuredLogViewRequest) MarshalProtoJSON

func (x *SetStructuredLogViewRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the SetStructuredLogViewRequest message to JSON.

func (*SetStructuredLogViewRequest) MarshalProtoText

func (x *SetStructuredLogViewRequest) MarshalProtoText() string

func (*SetStructuredLogViewRequest) MarshalToSizedBufferVT

func (m *SetStructuredLogViewRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*SetStructuredLogViewRequest) MarshalToVT

func (m *SetStructuredLogViewRequest) MarshalToVT(dAtA []byte) (int, error)

func (*SetStructuredLogViewRequest) MarshalVT

func (m *SetStructuredLogViewRequest) MarshalVT() (dAtA []byte, err error)

func (*SetStructuredLogViewRequest) ProtoMessage

func (*SetStructuredLogViewRequest) ProtoMessage()

func (*SetStructuredLogViewRequest) Reset

func (x *SetStructuredLogViewRequest) Reset()

func (*SetStructuredLogViewRequest) SizeVT

func (m *SetStructuredLogViewRequest) SizeVT() (n int)

func (*SetStructuredLogViewRequest) String

func (x *SetStructuredLogViewRequest) String() string

func (*SetStructuredLogViewRequest) UnmarshalJSON

func (x *SetStructuredLogViewRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the SetStructuredLogViewRequest from JSON.

func (*SetStructuredLogViewRequest) UnmarshalProtoJSON

func (x *SetStructuredLogViewRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the SetStructuredLogViewRequest message from JSON.

func (*SetStructuredLogViewRequest) UnmarshalVT

func (m *SetStructuredLogViewRequest) UnmarshalVT(dAtA []byte) error

type SetStructuredLogViewResponse

type SetStructuredLogViewResponse struct {

	// State is the current state after applying the view change.
	State *StructuredLogState `protobuf:"bytes,1,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

SetStructuredLogViewResponse returns the updated view state.

func (*SetStructuredLogViewResponse) CloneMessageVT

func (*SetStructuredLogViewResponse) CloneVT

func (*SetStructuredLogViewResponse) EqualMessageVT

func (this *SetStructuredLogViewResponse) EqualMessageVT(thatMsg any) bool

func (*SetStructuredLogViewResponse) EqualVT

func (*SetStructuredLogViewResponse) GetState

func (*SetStructuredLogViewResponse) MarshalJSON

func (x *SetStructuredLogViewResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the SetStructuredLogViewResponse to JSON.

func (*SetStructuredLogViewResponse) MarshalProtoJSON

func (x *SetStructuredLogViewResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the SetStructuredLogViewResponse message to JSON.

func (*SetStructuredLogViewResponse) MarshalProtoText

func (x *SetStructuredLogViewResponse) MarshalProtoText() string

func (*SetStructuredLogViewResponse) MarshalToSizedBufferVT

func (m *SetStructuredLogViewResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*SetStructuredLogViewResponse) MarshalToVT

func (m *SetStructuredLogViewResponse) MarshalToVT(dAtA []byte) (int, error)

func (*SetStructuredLogViewResponse) MarshalVT

func (m *SetStructuredLogViewResponse) MarshalVT() (dAtA []byte, err error)

func (*SetStructuredLogViewResponse) ProtoMessage

func (*SetStructuredLogViewResponse) ProtoMessage()

func (*SetStructuredLogViewResponse) Reset

func (x *SetStructuredLogViewResponse) Reset()

func (*SetStructuredLogViewResponse) SizeVT

func (m *SetStructuredLogViewResponse) SizeVT() (n int)

func (*SetStructuredLogViewResponse) String

func (*SetStructuredLogViewResponse) UnmarshalJSON

func (x *SetStructuredLogViewResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the SetStructuredLogViewResponse from JSON.

func (*SetStructuredLogViewResponse) UnmarshalProtoJSON

func (x *SetStructuredLogViewResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the SetStructuredLogViewResponse message from JSON.

func (*SetStructuredLogViewResponse) UnmarshalVT

func (m *SetStructuredLogViewResponse) UnmarshalVT(dAtA []byte) error

type StructuredLogEvent

type StructuredLogEvent struct {

	// Sequence is assigned by the log owner and is monotonically increasing
	// within that owner.
	Sequence uint64 `protobuf:"varint,1,opt,name=sequence,proto3" json:"sequence,omitempty"`
	// Timestamp is when the event was observed by the log owner.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// PluginId is the manifest plugin identifier.
	PluginId string `protobuf:"bytes,3,opt,name=plugin_id,json=pluginId,proto3" json:"pluginId,omitempty"`
	// InstanceKey is the optional key for instanced plugins.
	InstanceKey string `protobuf:"bytes,4,opt,name=instance_key,json=instanceKey,proto3" json:"instanceKey,omitempty"`
	// Stream identifies the source stream for the event.
	Stream StructuredLogStream `protobuf:"varint,5,opt,name=stream,proto3" json:"stream,omitempty"`
	// Level is the event severity.
	Level StructuredLogLevel `protobuf:"varint,6,opt,name=level,proto3" json:"level,omitempty"`
	// Message is the human-readable log text.
	Message string `protobuf:"bytes,7,opt,name=message,proto3" json:"message,omitempty"`
	// Fields are structured key/value attributes attached to the event.
	Fields map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

StructuredLogEvent is one log event emitted by a plugin instance.

func (*StructuredLogEvent) CloneMessageVT

func (m *StructuredLogEvent) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*StructuredLogEvent) CloneVT

func (m *StructuredLogEvent) CloneVT() *StructuredLogEvent

func (*StructuredLogEvent) EqualMessageVT

func (this *StructuredLogEvent) EqualMessageVT(thatMsg any) bool

func (*StructuredLogEvent) EqualVT

func (this *StructuredLogEvent) EqualVT(that *StructuredLogEvent) bool

func (*StructuredLogEvent) GetFields

func (x *StructuredLogEvent) GetFields() map[string]string

func (*StructuredLogEvent) GetInstanceKey

func (x *StructuredLogEvent) GetInstanceKey() string

func (*StructuredLogEvent) GetLevel

func (x *StructuredLogEvent) GetLevel() StructuredLogLevel

func (*StructuredLogEvent) GetMessage

func (x *StructuredLogEvent) GetMessage() string

func (*StructuredLogEvent) GetPluginId

func (x *StructuredLogEvent) GetPluginId() string

func (*StructuredLogEvent) GetSequence

func (x *StructuredLogEvent) GetSequence() uint64

func (*StructuredLogEvent) GetStream

func (x *StructuredLogEvent) GetStream() StructuredLogStream

func (*StructuredLogEvent) GetTimestamp

func (x *StructuredLogEvent) GetTimestamp() *timestamppb.Timestamp

func (*StructuredLogEvent) MarshalJSON

func (x *StructuredLogEvent) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogEvent to JSON.

func (*StructuredLogEvent) MarshalProtoJSON

func (x *StructuredLogEvent) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogEvent message to JSON.

func (*StructuredLogEvent) MarshalProtoText

func (x *StructuredLogEvent) MarshalProtoText() string

func (*StructuredLogEvent) MarshalToSizedBufferVT

func (m *StructuredLogEvent) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*StructuredLogEvent) MarshalToVT

func (m *StructuredLogEvent) MarshalToVT(dAtA []byte) (int, error)

func (*StructuredLogEvent) MarshalVT

func (m *StructuredLogEvent) MarshalVT() (dAtA []byte, err error)

func (*StructuredLogEvent) ProtoMessage

func (*StructuredLogEvent) ProtoMessage()

func (*StructuredLogEvent) Reset

func (x *StructuredLogEvent) Reset()

func (*StructuredLogEvent) SizeVT

func (m *StructuredLogEvent) SizeVT() (n int)

func (*StructuredLogEvent) String

func (x *StructuredLogEvent) String() string

func (*StructuredLogEvent) UnmarshalJSON

func (x *StructuredLogEvent) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogEvent from JSON.

func (*StructuredLogEvent) UnmarshalProtoJSON

func (x *StructuredLogEvent) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogEvent message from JSON.

func (*StructuredLogEvent) UnmarshalVT

func (m *StructuredLogEvent) UnmarshalVT(dAtA []byte) error

type StructuredLogEvent_FieldsEntry

type StructuredLogEvent_FieldsEntry struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*StructuredLogEvent_FieldsEntry) GetKey

func (*StructuredLogEvent_FieldsEntry) GetValue

func (x *StructuredLogEvent_FieldsEntry) GetValue() string

func (*StructuredLogEvent_FieldsEntry) MarshalJSON

func (x *StructuredLogEvent_FieldsEntry) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogEvent_FieldsEntry to JSON.

func (*StructuredLogEvent_FieldsEntry) MarshalProtoJSON

func (x *StructuredLogEvent_FieldsEntry) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogEvent_FieldsEntry message to JSON.

func (*StructuredLogEvent_FieldsEntry) MarshalProtoText

func (x *StructuredLogEvent_FieldsEntry) MarshalProtoText() string

func (*StructuredLogEvent_FieldsEntry) ProtoMessage

func (*StructuredLogEvent_FieldsEntry) ProtoMessage()

func (*StructuredLogEvent_FieldsEntry) Reset

func (x *StructuredLogEvent_FieldsEntry) Reset()

func (*StructuredLogEvent_FieldsEntry) String

func (*StructuredLogEvent_FieldsEntry) UnmarshalJSON

func (x *StructuredLogEvent_FieldsEntry) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogEvent_FieldsEntry from JSON.

func (*StructuredLogEvent_FieldsEntry) UnmarshalProtoJSON

func (x *StructuredLogEvent_FieldsEntry) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogEvent_FieldsEntry message from JSON.

type StructuredLogFilter

type StructuredLogFilter struct {

	// PluginIds restricts events to the listed plugin identifiers.
	PluginIds []string `protobuf:"bytes,1,rep,name=plugin_ids,json=pluginIds,proto3" json:"pluginIds,omitempty"`
	// InstanceKeys restricts events to the listed plugin instance keys.
	InstanceKeys []string `protobuf:"bytes,2,rep,name=instance_keys,json=instanceKeys,proto3" json:"instanceKeys,omitempty"`
	// Streams restricts events to the listed streams.
	Streams []StructuredLogStream `protobuf:"varint,3,rep,packed,name=streams,proto3" json:"streams,omitempty"`
	// MinLevel restricts events to this severity and above.
	MinLevel StructuredLogLevel `protobuf:"varint,4,opt,name=min_level,json=minLevel,proto3" json:"minLevel,omitempty"`
	// SearchText restricts events to messages or fields containing this text.
	SearchText string `protobuf:"bytes,5,opt,name=search_text,json=searchText,proto3" json:"searchText,omitempty"`
	// Fields restricts events to exact key/value field matches.
	Fields map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

StructuredLogFilter selects a subset of structured plugin log events.

func (*StructuredLogFilter) CloneMessageVT

func (*StructuredLogFilter) CloneVT

func (*StructuredLogFilter) EqualMessageVT

func (this *StructuredLogFilter) EqualMessageVT(thatMsg any) bool

func (*StructuredLogFilter) EqualVT

func (this *StructuredLogFilter) EqualVT(that *StructuredLogFilter) bool

func (*StructuredLogFilter) GetFields

func (x *StructuredLogFilter) GetFields() map[string]string

func (*StructuredLogFilter) GetInstanceKeys

func (x *StructuredLogFilter) GetInstanceKeys() []string

func (*StructuredLogFilter) GetMinLevel

func (x *StructuredLogFilter) GetMinLevel() StructuredLogLevel

func (*StructuredLogFilter) GetPluginIds

func (x *StructuredLogFilter) GetPluginIds() []string

func (*StructuredLogFilter) GetSearchText

func (x *StructuredLogFilter) GetSearchText() string

func (*StructuredLogFilter) GetStreams

func (x *StructuredLogFilter) GetStreams() []StructuredLogStream

func (*StructuredLogFilter) MarshalJSON

func (x *StructuredLogFilter) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogFilter to JSON.

func (*StructuredLogFilter) MarshalProtoJSON

func (x *StructuredLogFilter) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogFilter message to JSON.

func (*StructuredLogFilter) MarshalProtoText

func (x *StructuredLogFilter) MarshalProtoText() string

func (*StructuredLogFilter) MarshalToSizedBufferVT

func (m *StructuredLogFilter) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*StructuredLogFilter) MarshalToVT

func (m *StructuredLogFilter) MarshalToVT(dAtA []byte) (int, error)

func (*StructuredLogFilter) MarshalVT

func (m *StructuredLogFilter) MarshalVT() (dAtA []byte, err error)

func (*StructuredLogFilter) ProtoMessage

func (*StructuredLogFilter) ProtoMessage()

func (*StructuredLogFilter) Reset

func (x *StructuredLogFilter) Reset()

func (*StructuredLogFilter) SizeVT

func (m *StructuredLogFilter) SizeVT() (n int)

func (*StructuredLogFilter) String

func (x *StructuredLogFilter) String() string

func (*StructuredLogFilter) UnmarshalJSON

func (x *StructuredLogFilter) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogFilter from JSON.

func (*StructuredLogFilter) UnmarshalProtoJSON

func (x *StructuredLogFilter) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogFilter message from JSON.

func (*StructuredLogFilter) UnmarshalVT

func (m *StructuredLogFilter) UnmarshalVT(dAtA []byte) error

type StructuredLogFilter_FieldsEntry

type StructuredLogFilter_FieldsEntry struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*StructuredLogFilter_FieldsEntry) GetKey

func (*StructuredLogFilter_FieldsEntry) GetValue

func (*StructuredLogFilter_FieldsEntry) MarshalJSON

func (x *StructuredLogFilter_FieldsEntry) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogFilter_FieldsEntry to JSON.

func (*StructuredLogFilter_FieldsEntry) MarshalProtoJSON

func (x *StructuredLogFilter_FieldsEntry) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogFilter_FieldsEntry message to JSON.

func (*StructuredLogFilter_FieldsEntry) MarshalProtoText

func (x *StructuredLogFilter_FieldsEntry) MarshalProtoText() string

func (*StructuredLogFilter_FieldsEntry) ProtoMessage

func (*StructuredLogFilter_FieldsEntry) ProtoMessage()

func (*StructuredLogFilter_FieldsEntry) Reset

func (*StructuredLogFilter_FieldsEntry) String

func (*StructuredLogFilter_FieldsEntry) UnmarshalJSON

func (x *StructuredLogFilter_FieldsEntry) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogFilter_FieldsEntry from JSON.

func (*StructuredLogFilter_FieldsEntry) UnmarshalProtoJSON

func (x *StructuredLogFilter_FieldsEntry) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogFilter_FieldsEntry message from JSON.

type StructuredLogLevel

type StructuredLogLevel int32

StructuredLogLevel is the severity of a structured plugin log event.

const (
	// STRUCTURED_LOG_LEVEL_UNSPECIFIED preserves the proto3 default.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_UNSPECIFIED StructuredLogLevel = 0
	// STRUCTURED_LOG_LEVEL_TRACE is the most detailed diagnostic level.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_TRACE StructuredLogLevel = 1
	// STRUCTURED_LOG_LEVEL_DEBUG is for development diagnostics.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_DEBUG StructuredLogLevel = 2
	// STRUCTURED_LOG_LEVEL_INFO is for normal operational messages.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_INFO StructuredLogLevel = 3
	// STRUCTURED_LOG_LEVEL_WARN is for recoverable problems.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_WARN StructuredLogLevel = 4
	// STRUCTURED_LOG_LEVEL_ERROR is for failed operations.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_ERROR StructuredLogLevel = 5
	// STRUCTURED_LOG_LEVEL_FATAL is for terminal plugin failures.
	StructuredLogLevel_STRUCTURED_LOG_LEVEL_FATAL StructuredLogLevel = 6
)

func (StructuredLogLevel) Enum

func (StructuredLogLevel) MarshalJSON

func (x StructuredLogLevel) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogLevel to JSON.

func (StructuredLogLevel) MarshalProtoJSON

func (x StructuredLogLevel) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogLevel to JSON.

func (StructuredLogLevel) MarshalProtoText

func (x StructuredLogLevel) MarshalProtoText() string

func (StructuredLogLevel) MarshalText

func (x StructuredLogLevel) MarshalText() ([]byte, error)

MarshalText marshals the StructuredLogLevel to text.

func (StructuredLogLevel) String

func (x StructuredLogLevel) String() string

func (*StructuredLogLevel) UnmarshalJSON

func (x *StructuredLogLevel) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogLevel from JSON.

func (*StructuredLogLevel) UnmarshalProtoJSON

func (x *StructuredLogLevel) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogLevel from JSON.

func (*StructuredLogLevel) UnmarshalText

func (x *StructuredLogLevel) UnmarshalText(b []byte) error

UnmarshalText unmarshals the StructuredLogLevel from text.

type StructuredLogRange

type StructuredLogRange struct {

	// AfterSequence starts the window after this sequence. Zero starts at the
	// beginning of retained events unless Tail is set.
	AfterSequence uint64 `protobuf:"varint,1,opt,name=after_sequence,json=afterSequence,proto3" json:"afterSequence,omitempty"`
	// Limit is the maximum number of retained events to return.
	Limit uint32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Tail selects the newest retained events before following updates.
	Tail bool `protobuf:"varint,3,opt,name=tail,proto3" json:"tail,omitempty"`
	// Follow keeps the stream open for new events after the retained window.
	Follow bool `protobuf:"varint,4,opt,name=follow,proto3" json:"follow,omitempty"`
	// contains filtered or unexported fields
}

StructuredLogRange selects a sequence window.

func (*StructuredLogRange) CloneMessageVT

func (m *StructuredLogRange) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*StructuredLogRange) CloneVT

func (m *StructuredLogRange) CloneVT() *StructuredLogRange

func (*StructuredLogRange) EqualMessageVT

func (this *StructuredLogRange) EqualMessageVT(thatMsg any) bool

func (*StructuredLogRange) EqualVT

func (this *StructuredLogRange) EqualVT(that *StructuredLogRange) bool

func (*StructuredLogRange) GetAfterSequence

func (x *StructuredLogRange) GetAfterSequence() uint64

func (*StructuredLogRange) GetFollow

func (x *StructuredLogRange) GetFollow() bool

func (*StructuredLogRange) GetLimit

func (x *StructuredLogRange) GetLimit() uint32

func (*StructuredLogRange) GetTail

func (x *StructuredLogRange) GetTail() bool

func (*StructuredLogRange) MarshalJSON

func (x *StructuredLogRange) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogRange to JSON.

func (*StructuredLogRange) MarshalProtoJSON

func (x *StructuredLogRange) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogRange message to JSON.

func (*StructuredLogRange) MarshalProtoText

func (x *StructuredLogRange) MarshalProtoText() string

func (*StructuredLogRange) MarshalToSizedBufferVT

func (m *StructuredLogRange) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*StructuredLogRange) MarshalToVT

func (m *StructuredLogRange) MarshalToVT(dAtA []byte) (int, error)

func (*StructuredLogRange) MarshalVT

func (m *StructuredLogRange) MarshalVT() (dAtA []byte, err error)

func (*StructuredLogRange) ProtoMessage

func (*StructuredLogRange) ProtoMessage()

func (*StructuredLogRange) Reset

func (x *StructuredLogRange) Reset()

func (*StructuredLogRange) SizeVT

func (m *StructuredLogRange) SizeVT() (n int)

func (*StructuredLogRange) String

func (x *StructuredLogRange) String() string

func (*StructuredLogRange) UnmarshalJSON

func (x *StructuredLogRange) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogRange from JSON.

func (*StructuredLogRange) UnmarshalProtoJSON

func (x *StructuredLogRange) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogRange message from JSON.

func (*StructuredLogRange) UnmarshalVT

func (m *StructuredLogRange) UnmarshalVT(dAtA []byte) error

type StructuredLogState

type StructuredLogState struct {

	// Filter is the active filter.
	Filter *StructuredLogFilter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Range is the active sequence window.
	Range *StructuredLogRange `protobuf:"bytes,2,opt,name=range,proto3" json:"range,omitempty"`
	// Events are the retained events currently visible in the view.
	Events []*StructuredLogEvent `protobuf:"bytes,3,rep,name=events,proto3" json:"events,omitempty"`
	// DroppedEventCount is the number of matching events dropped before Events.
	DroppedEventCount uint64 `protobuf:"varint,4,opt,name=dropped_event_count,json=droppedEventCount,proto3" json:"droppedEventCount,omitempty"`
	// Closed indicates the producer will not emit more events for this view.
	Closed bool `protobuf:"varint,5,opt,name=closed,proto3" json:"closed,omitempty"`
	// contains filtered or unexported fields
}

StructuredLogState is the current snapshot for an open structured-log view.

func (*StructuredLogState) CloneMessageVT

func (m *StructuredLogState) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*StructuredLogState) CloneVT

func (m *StructuredLogState) CloneVT() *StructuredLogState

func (*StructuredLogState) EqualMessageVT

func (this *StructuredLogState) EqualMessageVT(thatMsg any) bool

func (*StructuredLogState) EqualVT

func (this *StructuredLogState) EqualVT(that *StructuredLogState) bool

func (*StructuredLogState) GetClosed

func (x *StructuredLogState) GetClosed() bool

func (*StructuredLogState) GetDroppedEventCount

func (x *StructuredLogState) GetDroppedEventCount() uint64

func (*StructuredLogState) GetEvents

func (x *StructuredLogState) GetEvents() []*StructuredLogEvent

func (*StructuredLogState) GetFilter

func (x *StructuredLogState) GetFilter() *StructuredLogFilter

func (*StructuredLogState) GetRange

func (x *StructuredLogState) GetRange() *StructuredLogRange

func (*StructuredLogState) MarshalJSON

func (x *StructuredLogState) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogState to JSON.

func (*StructuredLogState) MarshalProtoJSON

func (x *StructuredLogState) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogState message to JSON.

func (*StructuredLogState) MarshalProtoText

func (x *StructuredLogState) MarshalProtoText() string

func (*StructuredLogState) MarshalToSizedBufferVT

func (m *StructuredLogState) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*StructuredLogState) MarshalToVT

func (m *StructuredLogState) MarshalToVT(dAtA []byte) (int, error)

func (*StructuredLogState) MarshalVT

func (m *StructuredLogState) MarshalVT() (dAtA []byte, err error)

func (*StructuredLogState) ProtoMessage

func (*StructuredLogState) ProtoMessage()

func (*StructuredLogState) Reset

func (x *StructuredLogState) Reset()

func (*StructuredLogState) SizeVT

func (m *StructuredLogState) SizeVT() (n int)

func (*StructuredLogState) String

func (x *StructuredLogState) String() string

func (*StructuredLogState) UnmarshalJSON

func (x *StructuredLogState) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogState from JSON.

func (*StructuredLogState) UnmarshalProtoJSON

func (x *StructuredLogState) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogState message from JSON.

func (*StructuredLogState) UnmarshalVT

func (m *StructuredLogState) UnmarshalVT(dAtA []byte) error

type StructuredLogStream

type StructuredLogStream int32

StructuredLogStream identifies where an event came from.

const (
	// STRUCTURED_LOG_STREAM_UNSPECIFIED preserves the proto3 default.
	StructuredLogStream_STRUCTURED_LOG_STREAM_UNSPECIFIED StructuredLogStream = 0
	// STRUCTURED_LOG_STREAM_LOGGER is an application logger event.
	StructuredLogStream_STRUCTURED_LOG_STREAM_LOGGER StructuredLogStream = 1
	// STRUCTURED_LOG_STREAM_STDOUT is captured stdout.
	StructuredLogStream_STRUCTURED_LOG_STREAM_STDOUT StructuredLogStream = 2
	// STRUCTURED_LOG_STREAM_STDERR is captured stderr.
	StructuredLogStream_STRUCTURED_LOG_STREAM_STDERR StructuredLogStream = 3
)

func (StructuredLogStream) Enum

func (StructuredLogStream) MarshalJSON

func (x StructuredLogStream) MarshalJSON() ([]byte, error)

MarshalJSON marshals the StructuredLogStream to JSON.

func (StructuredLogStream) MarshalProtoJSON

func (x StructuredLogStream) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the StructuredLogStream to JSON.

func (StructuredLogStream) MarshalProtoText

func (x StructuredLogStream) MarshalProtoText() string

func (StructuredLogStream) MarshalText

func (x StructuredLogStream) MarshalText() ([]byte, error)

MarshalText marshals the StructuredLogStream to text.

func (StructuredLogStream) String

func (x StructuredLogStream) String() string

func (*StructuredLogStream) UnmarshalJSON

func (x *StructuredLogStream) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the StructuredLogStream from JSON.

func (*StructuredLogStream) UnmarshalProtoJSON

func (x *StructuredLogStream) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the StructuredLogStream from JSON.

func (*StructuredLogStream) UnmarshalText

func (x *StructuredLogStream) UnmarshalText(b []byte) error

UnmarshalText unmarshals the StructuredLogStream from text.

type View

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

View is an open structured-log view.

func (*View) Release

func (v *View) Release()

Release closes the view.

func (*View) Set

Set updates the view filter and range and returns the new state.

func (*View) Snapshot

func (v *View) Snapshot() *StructuredLogState

Snapshot returns the view's current state.

func (*View) Updates

func (v *View) Updates() <-chan struct{}

Updates returns a channel signaled when the view state changes.

Jump to

Keyboard shortcuts

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