log

package
v2.0.9+incompatible Latest Latest
Warning

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

 Go to latest Published: Jun 11, 2020 License: AGPL-3.0 Imports: 6 Imported by: 63

Documentation

Overview

Package log is a generated protocol buffer package.

It is generated from these files: 

log.proto

It has these top-level messages: 

RecorderPutResponse
Log
LogMessage
ListLogRequest
ListLogResponse
DeleteLogsResponse
TimeRangeResponse
TimeRangeResult
TimeRangeRequest
TimeRangeCursor

Package log is a generated protocol buffer package.

It is generated from these files: 

log.proto

It has these top-level messages: 

RecorderPutResponse
Log
LogMessage
ListLogRequest
ListLogResponse
DeleteLogsResponse
TimeRangeResponse
TimeRangeResult
TimeRangeRequest
TimeRangeCursor

Index

Constants

This section is empty.

Variables

View Source 
var ListLogRequest_LogFormat_name = map[int32]string{
	0: "JSON",
	1: "CSV",
	2: "XLSX",
}
View Source 
var ListLogRequest_LogFormat_value = map[string]int32{
	"JSON": 0,
	"CSV":  1,
	"XLSX": 2,
}
View Source 
var RelType_name = map[int32]string{
	0: "NONE",
	1: "FIRST",
	2: "PREV",
	3: "NEXT",
	4: "LAST",
}
View Source 
var RelType_value = map[string]int32{
	"NONE":  0,
	"FIRST": 1,
	"PREV":  2,
	"NEXT":  3,
	"LAST":  4,
}

Functions

func RegisterLogRecorderHandler 

func RegisterLogRecorderHandler(s server.Server, hdlr LogRecorderHandler, opts ...server.HandlerOption)

Types

type DeleteLogsResponse added in v1.4.0 

type DeleteLogsResponse struct {
	Deleted int64 `protobuf:"varint,1,opt,name=Deleted" json:"Deleted,omitempty"`
}

func (*DeleteLogsResponse) Descriptor added in v1.4.0 

func (*DeleteLogsResponse) Descriptor() ([]byte, []int)

func (*DeleteLogsResponse) GetDeleted added in v1.4.0 

func (m *DeleteLogsResponse) GetDeleted() int64

func (*DeleteLogsResponse) ProtoMessage added in v1.4.0 

func (*DeleteLogsResponse) ProtoMessage()

func (*DeleteLogsResponse) Reset added in v1.4.0 

func (m *DeleteLogsResponse) Reset()

func (*DeleteLogsResponse) String added in v1.4.0 

func (m *DeleteLogsResponse) String() string

type ListLogRequest 

type ListLogRequest struct {
	// Bleve-type Query stsring
	Query string `protobuf:"bytes,1,opt,name=Query" json:"Query,omitempty"`
	// Start at page
	Page int32 `protobuf:"varint,2,opt,name=Page" json:"Page,omitempty"`
	// Number of results
	Size   int32                    `protobuf:"varint,3,opt,name=Size" json:"Size,omitempty"`
	Format ListLogRequest_LogFormat `protobuf:"varint,4,opt,name=Format,enum=log.ListLogRequest_LogFormat" json:"Format,omitempty"`
}

ListLogRequest launches a parameterised query in the log repository and streams the results.

func (*ListLogRequest) Descriptor 

func (*ListLogRequest) Descriptor() ([]byte, []int)

func (*ListLogRequest) GetFormat 

func (m *ListLogRequest) GetFormat() ListLogRequest_LogFormat

func (*ListLogRequest) GetPage 

func (m *ListLogRequest) GetPage() int32

func (*ListLogRequest) GetQuery 

func (m *ListLogRequest) GetQuery() string

func (*ListLogRequest) GetSize 

func (m *ListLogRequest) GetSize() int32

func (*ListLogRequest) ProtoMessage 

func (*ListLogRequest) ProtoMessage()

func (*ListLogRequest) Reset 

func (m *ListLogRequest) Reset()

func (*ListLogRequest) String 

func (m *ListLogRequest) String() string

type ListLogRequest_LogFormat 

type ListLogRequest_LogFormat int32

Output Format 

const (
	ListLogRequest_JSON ListLogRequest_LogFormat = 0
	ListLogRequest_CSV  ListLogRequest_LogFormat = 1
	ListLogRequest_XLSX ListLogRequest_LogFormat = 2
)

func (ListLogRequest_LogFormat) EnumDescriptor 

func (ListLogRequest_LogFormat) EnumDescriptor() ([]byte, []int)

func (ListLogRequest_LogFormat) String 

func (x ListLogRequest_LogFormat) String() string

type ListLogResponse 

type ListLogResponse struct {
	LogMessage *LogMessage `protobuf:"bytes,1,opt,name=LogMessage" json:"LogMessage,omitempty"`
}

func (*ListLogResponse) Descriptor 

func (*ListLogResponse) Descriptor() ([]byte, []int)

func (*ListLogResponse) GetLogMessage 

func (m *ListLogResponse) GetLogMessage() *LogMessage

func (*ListLogResponse) ProtoMessage 

func (*ListLogResponse) ProtoMessage()

func (*ListLogResponse) Reset 

func (m *ListLogResponse) Reset()

func (*ListLogResponse) String 

func (m *ListLogResponse) String() string

type Log 

type Log struct {
	Message map[string]string `` /* 134-byte string literal not displayed */
}

Log is a generic message format used by the sync service to publish log messages to the various log repositories (typically, bleve).

func (*Log) Descriptor 

func (*Log) Descriptor() ([]byte, []int)

func (*Log) GetMessage 

func (m *Log) GetMessage() map[string]string

func (*Log) ProtoMessage 

func (*Log) ProtoMessage()

func (*Log) Reset 

func (m *Log) Reset()

func (*Log) String 

func (m *Log) String() string

type LogMessage 

type LogMessage struct {
	// Generic zap fields
	Ts     int32  `protobuf:"varint,1,opt,name=Ts" json:"Ts,omitempty"`
	Level  string `protobuf:"bytes,2,opt,name=Level" json:"Level,omitempty"`
	Logger string `protobuf:"bytes,3,opt,name=Logger" json:"Logger,omitempty"`
	Msg    string `protobuf:"bytes,4,opt,name=Msg" json:"Msg,omitempty"`
	// Pydio specific
	MsgId string `protobuf:"bytes,5,opt,name=MsgId" json:"MsgId,omitempty"`
	// User Info
	UserName  string   `protobuf:"bytes,6,opt,name=UserName" json:"UserName,omitempty"`
	UserUuid  string   `protobuf:"bytes,7,opt,name=UserUuid" json:"UserUuid,omitempty"`
	GroupPath string   `protobuf:"bytes,8,opt,name=GroupPath" json:"GroupPath,omitempty"`
	Profile   string   `protobuf:"bytes,16,opt,name=Profile" json:"Profile,omitempty"`
	RoleUuids []string `protobuf:"bytes,9,rep,name=RoleUuids" json:"RoleUuids,omitempty"`
	// Client info
	RemoteAddress string `protobuf:"bytes,10,opt,name=RemoteAddress" json:"RemoteAddress,omitempty"`
	UserAgent     string `protobuf:"bytes,11,opt,name=UserAgent" json:"UserAgent,omitempty"`
	HttpProtocol  string `protobuf:"bytes,12,opt,name=HttpProtocol" json:"HttpProtocol,omitempty"`
	// Tree Info
	NodeUuid string `protobuf:"bytes,13,opt,name=NodeUuid" json:"NodeUuid,omitempty"`
	NodePath string `protobuf:"bytes,14,opt,name=NodePath" json:"NodePath,omitempty"`
	WsUuid   string `protobuf:"bytes,15,opt,name=WsUuid" json:"WsUuid,omitempty"`
	WsScope  string `protobuf:"bytes,17,opt,name=WsScope" json:"WsScope,omitempty"`
	// Span Info
	SpanUuid       string `protobuf:"bytes,18,opt,name=SpanUuid" json:"SpanUuid,omitempty"`
	SpanParentUuid string `protobuf:"bytes,19,opt,name=SpanParentUuid" json:"SpanParentUuid,omitempty"`
	SpanRootUuid   string `protobuf:"bytes,20,opt,name=SpanRootUuid" json:"SpanRootUuid,omitempty"`
	// High Level Operation Info
	OperationUuid  string `protobuf:"bytes,21,opt,name=OperationUuid" json:"OperationUuid,omitempty"`
	OperationLabel string `protobuf:"bytes,22,opt,name=OperationLabel" json:"OperationLabel,omitempty"`
}

LogMessage is the format used to transmit log messages to clients via the REST API.

func (*LogMessage) Descriptor 

func (*LogMessage) Descriptor() ([]byte, []int)

func (*LogMessage) GetGroupPath 

func (m *LogMessage) GetGroupPath() string

func (*LogMessage) GetHttpProtocol 

func (m *LogMessage) GetHttpProtocol() string

func (*LogMessage) GetLevel 

func (m *LogMessage) GetLevel() string

func (*LogMessage) GetLogger 

func (m *LogMessage) GetLogger() string

func (*LogMessage) GetMsg 

func (m *LogMessage) GetMsg() string

func (*LogMessage) GetMsgId 

func (m *LogMessage) GetMsgId() string

func (*LogMessage) GetNodePath 

func (m *LogMessage) GetNodePath() string

func (*LogMessage) GetNodeUuid 

func (m *LogMessage) GetNodeUuid() string

func (*LogMessage) GetOperationLabel added in v1.4.0 

func (m *LogMessage) GetOperationLabel() string

func (*LogMessage) GetOperationUuid added in v1.4.0 

func (m *LogMessage) GetOperationUuid() string

func (*LogMessage) GetProfile 

func (m *LogMessage) GetProfile() string

func (*LogMessage) GetRemoteAddress 

func (m *LogMessage) GetRemoteAddress() string

func (*LogMessage) GetRoleUuids 

func (m *LogMessage) GetRoleUuids() []string

func (*LogMessage) GetSpanParentUuid 

func (m *LogMessage) GetSpanParentUuid() string

func (*LogMessage) GetSpanRootUuid 

func (m *LogMessage) GetSpanRootUuid() string

func (*LogMessage) GetSpanUuid 

func (m *LogMessage) GetSpanUuid() string

func (*LogMessage) GetTs 

func (m *LogMessage) GetTs() int32

func (*LogMessage) GetUserAgent 

func (m *LogMessage) GetUserAgent() string

func (*LogMessage) GetUserName 

func (m *LogMessage) GetUserName() string

func (*LogMessage) GetUserUuid 

func (m *LogMessage) GetUserUuid() string

func (*LogMessage) GetWsScope 

func (m *LogMessage) GetWsScope() string

func (*LogMessage) GetWsUuid 

func (m *LogMessage) GetWsUuid() string

func (*LogMessage) ProtoMessage 

func (*LogMessage) ProtoMessage()

func (*LogMessage) Reset 

func (m *LogMessage) Reset()

func (*LogMessage) String 

func (m *LogMessage) String() string

type LogRecorder 

type LogRecorder struct {
	LogRecorderHandler
}

func (*LogRecorder) AggregatedLogs 

func (h *LogRecorder) AggregatedLogs(ctx context.Context, stream server.Streamer) error

func (*LogRecorder) DeleteLogs added in v1.4.0 

func (h *LogRecorder) DeleteLogs(ctx context.Context, in *ListLogRequest, out *DeleteLogsResponse) error

func (*LogRecorder) ListLogs 

func (h *LogRecorder) ListLogs(ctx context.Context, stream server.Streamer) error

func (*LogRecorder) PutLog 

func (h *LogRecorder) PutLog(ctx context.Context, stream server.Streamer) error

type LogRecorderClient 

type LogRecorderClient interface {
	// PutLog adds received log messages to the corresponding log repository.
	PutLog(ctx context.Context, opts ...client.CallOption) (LogRecorder_PutLogClient, error)
	// ListLogs performs a paginated search query in the log repository.
	ListLogs(ctx context.Context, in *ListLogRequest, opts ...client.CallOption) (LogRecorder_ListLogsClient, error)
	// DeleteLogs deletes logs based on a request (cannot be empty)
	DeleteLogs(ctx context.Context, in *ListLogRequest, opts ...client.CallOption) (*DeleteLogsResponse, error)
	// AggregatedLogs performs a query to retrieve log events of the given type, faceted by time range.
	AggregatedLogs(ctx context.Context, in *TimeRangeRequest, opts ...client.CallOption) (LogRecorder_AggregatedLogsClient, error)
}

func NewLogRecorderClient 

func NewLogRecorderClient(serviceName string, c client.Client) LogRecorderClient

type LogRecorderHandler 

type LogRecorderHandler interface {
	// PutLog adds received log messages to the corresponding log repository.
	PutLog(context.Context, LogRecorder_PutLogStream) error
	// ListLogs performs a paginated search query in the log repository.
	ListLogs(context.Context, *ListLogRequest, LogRecorder_ListLogsStream) error
	// DeleteLogs deletes logs based on a request (cannot be empty)
	DeleteLogs(context.Context, *ListLogRequest, *DeleteLogsResponse) error
	// AggregatedLogs performs a query to retrieve log events of the given type, faceted by time range.
	AggregatedLogs(context.Context, *TimeRangeRequest, LogRecorder_AggregatedLogsStream) error
}

type LogRecorder_AggregatedLogsClient 

type LogRecorder_AggregatedLogsClient interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Recv() (*TimeRangeResponse, error)
}

type LogRecorder_AggregatedLogsStream 

type LogRecorder_AggregatedLogsStream interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*TimeRangeResponse) error
}

type LogRecorder_ListLogsClient 

type LogRecorder_ListLogsClient interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Recv() (*ListLogResponse, error)
}

type LogRecorder_ListLogsStream 

type LogRecorder_ListLogsStream interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*ListLogResponse) error
}

type LogRecorder_PutLogClient 

type LogRecorder_PutLogClient interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*Log) error
}

type LogRecorder_PutLogStream 

type LogRecorder_PutLogStream interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Recv() (*Log, error)
}

type RecorderPutResponse 

type RecorderPutResponse struct {
}

func (*RecorderPutResponse) Descriptor 

func (*RecorderPutResponse) Descriptor() ([]byte, []int)

func (*RecorderPutResponse) ProtoMessage 

func (*RecorderPutResponse) ProtoMessage()

func (*RecorderPutResponse) Reset 

func (m *RecorderPutResponse) Reset()

func (*RecorderPutResponse) String 

func (m *RecorderPutResponse) String() string

type RelType 

type RelType int32

Relative links types. Note that First is time.Now() and last time.Unix(0). We added an unused NONE enum with value 0 to workaround 0 issues between JSON and proto3. 

const (
	RelType_NONE  RelType = 0
	RelType_FIRST RelType = 1
	RelType_PREV  RelType = 2
	RelType_NEXT  RelType = 3
	RelType_LAST  RelType = 4
)

func (RelType) EnumDescriptor 

func (RelType) EnumDescriptor() ([]byte, []int)

func (RelType) String 

func (x RelType) String() string

type TimeRangeCursor 

type TimeRangeCursor struct {
	Rel     RelType `protobuf:"varint,1,opt,name=Rel,enum=log.RelType" json:"Rel,omitempty"`
	RefTime int32   `protobuf:"varint,2,opt,name=RefTime" json:"RefTime,omitempty"`
	Count   int32   `protobuf:"varint,3,opt,name=Count" json:"Count,omitempty"`
}

Ease implementation of data navigation for a chart.

func (*TimeRangeCursor) Descriptor 

func (*TimeRangeCursor) Descriptor() ([]byte, []int)

func (*TimeRangeCursor) GetCount 

func (m *TimeRangeCursor) GetCount() int32

func (*TimeRangeCursor) GetRefTime 

func (m *TimeRangeCursor) GetRefTime() int32

func (*TimeRangeCursor) GetRel 

func (m *TimeRangeCursor) GetRel() RelType

func (*TimeRangeCursor) ProtoMessage 

func (*TimeRangeCursor) ProtoMessage()

func (*TimeRangeCursor) Reset 

func (m *TimeRangeCursor) Reset()

func (*TimeRangeCursor) String 

func (m *TimeRangeCursor) String() string

type TimeRangeRequest 

type TimeRangeRequest struct {
	// Type of event we are auditing
	MsgId string `protobuf:"bytes,1,opt,name=MsgId" json:"MsgId,omitempty"`
	// Known types: H, D, W, M or Y
	TimeRangeType string `protobuf:"bytes,2,opt,name=TimeRangeType" json:"TimeRangeType,omitempty"`
	// Upper bound for our request
	RefTime int32 `protobuf:"varint,3,opt,name=RefTime" json:"RefTime,omitempty"`
}

TimeRangeRequest contains the parameter to configure the query to retrieve the number of audit events of this type for a given time range defined by last timestamp and a range type.

func (*TimeRangeRequest) Descriptor 

func (*TimeRangeRequest) Descriptor() ([]byte, []int)

func (*TimeRangeRequest) GetMsgId 

func (m *TimeRangeRequest) GetMsgId() string

func (*TimeRangeRequest) GetRefTime 

func (m *TimeRangeRequest) GetRefTime() int32

func (*TimeRangeRequest) GetTimeRangeType 

func (m *TimeRangeRequest) GetTimeRangeType() string

func (*TimeRangeRequest) ProtoMessage 

func (*TimeRangeRequest) ProtoMessage()

func (*TimeRangeRequest) Reset 

func (m *TimeRangeRequest) Reset()

func (*TimeRangeRequest) String 

func (m *TimeRangeRequest) String() string

type TimeRangeResponse 

type TimeRangeResponse struct {
	TimeRangeResult *TimeRangeResult `protobuf:"bytes,1,opt,name=TimeRangeResult" json:"TimeRangeResult,omitempty"`
	TimeRangeCursor *TimeRangeCursor `protobuf:"bytes,2,opt,name=TimeRangeCursor" json:"TimeRangeCursor,omitempty"`
}

TimeRangeResponse contains either one aggregated result of a facetted request OR a time range cursor.

func (*TimeRangeResponse) Descriptor 

func (*TimeRangeResponse) Descriptor() ([]byte, []int)

func (*TimeRangeResponse) GetTimeRangeCursor 

func (m *TimeRangeResponse) GetTimeRangeCursor() *TimeRangeCursor

func (*TimeRangeResponse) GetTimeRangeResult 

func (m *TimeRangeResponse) GetTimeRangeResult() *TimeRangeResult

func (*TimeRangeResponse) ProtoMessage 

func (*TimeRangeResponse) ProtoMessage()

func (*TimeRangeResponse) Reset 

func (m *TimeRangeResponse) Reset()

func (*TimeRangeResponse) String 

func (m *TimeRangeResponse) String() string

type TimeRangeResult 

type TimeRangeResult struct {
	// a label for this time range
	Name string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"`
	// begin timestamp
	Start int32 `protobuf:"varint,2,opt,name=Start" json:"Start,omitempty"`
	// end timestamp
	End int32 `protobuf:"varint,3,opt,name=End" json:"End,omitempty"`
	// nb of occurrences found within this range
	Count int32 `protobuf:"varint,4,opt,name=Count" json:"Count,omitempty"`
	// a score between 1 and 100 that gives the relevance of this result:
	// if End > now, we ponderate the returned count with the duration of the last time range
	// for instance for a hour range if now is 6PM, last count will be
	// multiplied by 4/3 and have a relevance of 75.
	// Relevance will be almost always equals to 100
	Relevance int32 `protobuf:"varint,5,opt,name=Relevance" json:"Relevance,omitempty"`
}

TimeRangeResult represents one point of a graph.

func (*TimeRangeResult) Descriptor 

func (*TimeRangeResult) Descriptor() ([]byte, []int)

func (*TimeRangeResult) GetCount 

func (m *TimeRangeResult) GetCount() int32

func (*TimeRangeResult) GetEnd 

func (m *TimeRangeResult) GetEnd() int32

func (*TimeRangeResult) GetName 

func (m *TimeRangeResult) GetName() string

func (*TimeRangeResult) GetRelevance 

func (m *TimeRangeResult) GetRelevance() int32

func (*TimeRangeResult) GetStart 

func (m *TimeRangeResult) GetStart() int32

func (*TimeRangeResult) ProtoMessage 

func (*TimeRangeResult) ProtoMessage()

func (*TimeRangeResult) Reset 

func (m *TimeRangeResult) Reset()

func (*TimeRangeResult) String 

func (m *TimeRangeResult) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.