Documentation
¶
Index ¶
- Variables
- type LogCategory
- type LogLevel
- type LogRecord
- func (*LogRecord) Descriptor() ([]byte, []int)
- func (this *LogRecord) Equal(that interface{}) bool
- func (m *LogRecord) GetCallerIpAddress() string
- func (m *LogRecord) GetCategory() LogCategory
- func (m *LogRecord) GetDetails() *OperationDetail
- func (m *LogRecord) GetEmitTime() *types.Timestamp
- func (m *LogRecord) GetLevel() LogLevel
- func (m *LogRecord) GetLogId() string
- func (m *LogRecord) GetOperation() string
- func (m *LogRecord) GetStatus() string
- func (m *LogRecord) GetUserEmail() string
- func (m *LogRecord) GetVersion() int32
- func (this *LogRecord) GoString() string
- func (m *LogRecord) Marshal() (dAtA []byte, err error)
- func (m *LogRecord) MarshalTo(dAtA []byte) (int, error)
- func (m *LogRecord) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*LogRecord) ProtoMessage()
- func (m *LogRecord) Reset()
- func (m *LogRecord) Size() (n int)
- func (this *LogRecord) String() string
- func (m *LogRecord) Unmarshal(dAtA []byte) error
- func (m *LogRecord) XXX_DiscardUnknown()
- func (m *LogRecord) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *LogRecord) XXX_Merge(src proto.Message)
- func (m *LogRecord) XXX_Size() int
- func (m *LogRecord) XXX_Unmarshal(b []byte) error
- type OperationDetail
- func (*OperationDetail) Descriptor() ([]byte, []int)
- func (this *OperationDetail) Equal(that interface{}) bool
- func (m *OperationDetail) GetAccountFeatures() []string
- func (m *OperationDetail) GetAdditionalMessage() string
- func (m *OperationDetail) GetClientCaFingerprints() []string
- func (m *OperationDetail) GetNamespace() string
- func (m *OperationDetail) GetRegion() string
- func (m *OperationDetail) GetRoles() []string
- func (m *OperationDetail) GetSearchAttributeUpdate() *SearchAttributeUpdate
- func (m *OperationDetail) GetTargetUsers() []string
- func (m *OperationDetail) GetThirdPartyDetails() *ThirdPartyLogDetail
- func (this *OperationDetail) GoString() string
- func (m *OperationDetail) Marshal() (dAtA []byte, err error)
- func (m *OperationDetail) MarshalTo(dAtA []byte) (int, error)
- func (m *OperationDetail) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*OperationDetail) ProtoMessage()
- func (m *OperationDetail) Reset()
- func (m *OperationDetail) Size() (n int)
- func (this *OperationDetail) String() string
- func (m *OperationDetail) Unmarshal(dAtA []byte) error
- func (m *OperationDetail) XXX_DiscardUnknown()
- func (m *OperationDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *OperationDetail) XXX_Merge(src proto.Message)
- func (m *OperationDetail) XXX_Size() int
- func (m *OperationDetail) XXX_Unmarshal(b []byte) error
- type SearchAttributeUpdate
- func (*SearchAttributeUpdate) Descriptor() ([]byte, []int)
- func (this *SearchAttributeUpdate) Equal(that interface{}) bool
- func (m *SearchAttributeUpdate) GetExistingAttribute() string
- func (m *SearchAttributeUpdate) GetNewAttribute() string
- func (this *SearchAttributeUpdate) GoString() string
- func (m *SearchAttributeUpdate) Marshal() (dAtA []byte, err error)
- func (m *SearchAttributeUpdate) MarshalTo(dAtA []byte) (int, error)
- func (m *SearchAttributeUpdate) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*SearchAttributeUpdate) ProtoMessage()
- func (m *SearchAttributeUpdate) Reset()
- func (m *SearchAttributeUpdate) Size() (n int)
- func (this *SearchAttributeUpdate) String() string
- func (m *SearchAttributeUpdate) Unmarshal(dAtA []byte) error
- func (m *SearchAttributeUpdate) XXX_DiscardUnknown()
- func (m *SearchAttributeUpdate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *SearchAttributeUpdate) XXX_Merge(src proto.Message)
- func (m *SearchAttributeUpdate) XXX_Size() int
- func (m *SearchAttributeUpdate) XXX_Unmarshal(b []byte) error
- type ThirdPartyLogDetail
- func (*ThirdPartyLogDetail) Descriptor() ([]byte, []int)
- func (this *ThirdPartyLogDetail) Equal(that interface{}) bool
- func (m *ThirdPartyLogDetail) GetId() string
- func (m *ThirdPartyLogDetail) GetRawMessage() string
- func (m *ThirdPartyLogDetail) GetSource() string
- func (this *ThirdPartyLogDetail) GoString() string
- func (m *ThirdPartyLogDetail) Marshal() (dAtA []byte, err error)
- func (m *ThirdPartyLogDetail) MarshalTo(dAtA []byte) (int, error)
- func (m *ThirdPartyLogDetail) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*ThirdPartyLogDetail) ProtoMessage()
- func (m *ThirdPartyLogDetail) Reset()
- func (m *ThirdPartyLogDetail) Size() (n int)
- func (this *ThirdPartyLogDetail) String() string
- func (m *ThirdPartyLogDetail) Unmarshal(dAtA []byte) error
- func (m *ThirdPartyLogDetail) XXX_DiscardUnknown()
- func (m *ThirdPartyLogDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ThirdPartyLogDetail) XXX_Merge(src proto.Message)
- func (m *ThirdPartyLogDetail) XXX_Size() int
- func (m *ThirdPartyLogDetail) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidLengthMessage = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowMessage = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroupMessage = fmt.Errorf("proto: unexpected end of group") )
View Source
var LogCategory_name = map[int32]string{
0: "Unspecified",
1: "Admin",
2: "System",
}
View Source
var LogCategory_value = map[string]int32{
"Unspecified": 0,
"Admin": 1,
"System": 2,
}
View Source
var LogLevel_name = map[int32]string{
0: "Unspecified",
1: "Info",
2: "Debug",
3: "Warn",
4: "Error",
5: "Fatal",
}
View Source
var LogLevel_value = map[string]int32{
"Unspecified": 0,
"Info": 1,
"Debug": 2,
"Warn": 3,
"Error": 4,
"Fatal": 5,
}
Functions ¶
This section is empty.
Types ¶
type LogCategory ¶
type LogCategory int32
const ( LOG_CATEGORY_UNSPECIFIED LogCategory = 0 LOG_CATEGORY_ADMIN LogCategory = 1 LOG_CATEGORY_SYSTEM LogCategory = 2 )
func (LogCategory) EnumDescriptor ¶
func (LogCategory) EnumDescriptor() ([]byte, []int)
func (LogCategory) String ¶
func (x LogCategory) String() string
type LogRecord ¶
type LogRecord struct {
// when does this log get generated from the source
EmitTime *types.Timestamp `protobuf:"bytes,1,opt,name=emit_time,json=emitTime,proto3" json:"emit_time,omitempty"`
// level of the log, i.e. info, warn, error etc
Level LogLevel `protobuf:"varint,2,opt,name=level,proto3,enum=api.auditlog.v2.LogLevel" json:"level,omitempty"`
// If it's customer/user's operator, use email address; if it's Temporal's support to run operation on behalf of
// the customer, use "support@temoral.io" instead
UserEmail string `protobuf:"bytes,3,opt,name=user_email,json=userEmail,proto3" json:"user_email,omitempty"`
// customer ip address or server name, if it's "Temporal Internal", the real ip address will be hidden.
CallerIpAddress string `protobuf:"bytes,4,opt,name=caller_ip_address,json=callerIpAddress,proto3" json:"caller_ip_address,omitempty"`
// what operation
Operation string `protobuf:"bytes,5,opt,name=operation,proto3" json:"operation,omitempty"`
// Detailed information about the operation. For example, it could be the invited user email for "InviteUser" operation,
// could be "enable audit logging" for UpdateAccount operation
Details *OperationDetail `protobuf:"bytes,6,opt,name=details,proto3" json:"details,omitempty"`
// operation status from API call
Status string `protobuf:"bytes,7,opt,name=status,proto3" json:"status,omitempty"`
// admin or system
Category LogCategory `protobuf:"varint,8,opt,name=category,proto3,enum=api.auditlog.v2.LogCategory" json:"category,omitempty"`
// Version of the log entry, starting from 0. The version will be updated when there is a backfill/resend of the same
// logs
Version int32 `protobuf:"varint,9,opt,name=version,proto3" json:"version,omitempty"`
// Unique ID for the log record.
LogId string `protobuf:"bytes,10,opt,name=log_id,json=logId,proto3" json:"log_id,omitempty"`
}
LogRecord is the top level audit log message. The logs from Temporal will be transformed into LogRecord and sent to user in some unmarshalled format, i.e. json. The message is structured following some common log formats. It has the order of emit_time | level | user_email | caller_ip | operation | operation_details | status | category | version. Example: 2022-10-24T15:09:25.744Z INFO xyz@temporal.io 127.0.0.1 DeleteNamespace test-auditlog.temporal-account OK Admin 0
func (*LogRecord) Descriptor ¶
func (*LogRecord) GetCallerIpAddress ¶
func (*LogRecord) GetCategory ¶
func (m *LogRecord) GetCategory() LogCategory
func (*LogRecord) GetDetails ¶
func (m *LogRecord) GetDetails() *OperationDetail
func (*LogRecord) GetEmitTime ¶
func (*LogRecord) GetOperation ¶
func (*LogRecord) GetUserEmail ¶
func (*LogRecord) GetVersion ¶
func (*LogRecord) MarshalToSizedBuffer ¶
func (*LogRecord) ProtoMessage ¶
func (*LogRecord) ProtoMessage()
func (*LogRecord) XXX_DiscardUnknown ¶
func (m *LogRecord) XXX_DiscardUnknown()
func (*LogRecord) XXX_Marshal ¶
func (*LogRecord) XXX_Unmarshal ¶
type OperationDetail ¶
type OperationDetail struct {
// the namespace the operation was performed on
Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
// the users the operation was performed on
TargetUsers []string `protobuf:"bytes,2,rep,name=target_users,json=targetUsers,proto3" json:"target_users,omitempty"`
// if any role is processed, we provide the role information
Roles []string `protobuf:"bytes,3,rep,name=roles,proto3" json:"roles,omitempty"`
// if client ca is included, we provide the fingerprints
ClientCaFingerprints []string `protobuf:"bytes,4,rep,name=client_ca_fingerprints,json=clientCaFingerprints,proto3" json:"client_ca_fingerprints,omitempty"`
// if search attribute is processed, we provide the search attributes
SearchAttributeUpdate *SearchAttributeUpdate `` /* 126-byte string literal not displayed */
// additional message if there is any
AdditionalMessage string `protobuf:"bytes,6,opt,name=additional_message,json=additionalMessage,proto3" json:"additional_message,omitempty"`
// namespace's region if available
Region string `protobuf:"bytes,7,opt,name=region,proto3" json:"region,omitempty"`
// if there are account features changed, i.e. external metrics, audit logging sink etc.
AccountFeatures []string `protobuf:"bytes,8,rep,name=account_features,json=accountFeatures,proto3" json:"account_features,omitempty"`
// some third party log details, i.e. auth0
ThirdPartyDetails *ThirdPartyLogDetail `protobuf:"bytes,9,opt,name=third_party_details,json=thirdPartyDetails,proto3" json:"third_party_details,omitempty"`
}
OperationDetails includes potential more detailed operation logs extracted from the different fields in the Temporal API logs or third party logs, e.g. auth0
func (*OperationDetail) Descriptor ¶
func (*OperationDetail) Descriptor() ([]byte, []int)
func (*OperationDetail) Equal ¶
func (this *OperationDetail) Equal(that interface{}) bool
func (*OperationDetail) GetAccountFeatures ¶
func (m *OperationDetail) GetAccountFeatures() []string
func (*OperationDetail) GetAdditionalMessage ¶
func (m *OperationDetail) GetAdditionalMessage() string
func (*OperationDetail) GetClientCaFingerprints ¶
func (m *OperationDetail) GetClientCaFingerprints() []string
func (*OperationDetail) GetNamespace ¶
func (m *OperationDetail) GetNamespace() string
func (*OperationDetail) GetRegion ¶
func (m *OperationDetail) GetRegion() string
func (*OperationDetail) GetRoles ¶
func (m *OperationDetail) GetRoles() []string
func (*OperationDetail) GetSearchAttributeUpdate ¶
func (m *OperationDetail) GetSearchAttributeUpdate() *SearchAttributeUpdate
func (*OperationDetail) GetTargetUsers ¶
func (m *OperationDetail) GetTargetUsers() []string
func (*OperationDetail) GetThirdPartyDetails ¶
func (m *OperationDetail) GetThirdPartyDetails() *ThirdPartyLogDetail
func (*OperationDetail) GoString ¶
func (this *OperationDetail) GoString() string
func (*OperationDetail) Marshal ¶
func (m *OperationDetail) Marshal() (dAtA []byte, err error)
func (*OperationDetail) MarshalToSizedBuffer ¶
func (m *OperationDetail) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*OperationDetail) ProtoMessage ¶
func (*OperationDetail) ProtoMessage()
func (*OperationDetail) Reset ¶
func (m *OperationDetail) Reset()
func (*OperationDetail) Size ¶
func (m *OperationDetail) Size() (n int)
func (*OperationDetail) String ¶
func (this *OperationDetail) String() string
func (*OperationDetail) Unmarshal ¶
func (m *OperationDetail) Unmarshal(dAtA []byte) error
func (*OperationDetail) XXX_DiscardUnknown ¶
func (m *OperationDetail) XXX_DiscardUnknown()
func (*OperationDetail) XXX_Marshal ¶
func (m *OperationDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*OperationDetail) XXX_Merge ¶
func (m *OperationDetail) XXX_Merge(src proto.Message)
func (*OperationDetail) XXX_Size ¶
func (m *OperationDetail) XXX_Size() int
func (*OperationDetail) XXX_Unmarshal ¶
func (m *OperationDetail) XXX_Unmarshal(b []byte) error
type SearchAttributeUpdate ¶
type SearchAttributeUpdate struct {
ExistingAttribute string `protobuf:"bytes,1,opt,name=existing_attribute,json=existingAttribute,proto3" json:"existing_attribute,omitempty"`
NewAttribute string `protobuf:"bytes,2,opt,name=new_attribute,json=newAttribute,proto3" json:"new_attribute,omitempty"`
}
func (*SearchAttributeUpdate) Descriptor ¶
func (*SearchAttributeUpdate) Descriptor() ([]byte, []int)
func (*SearchAttributeUpdate) Equal ¶
func (this *SearchAttributeUpdate) Equal(that interface{}) bool
func (*SearchAttributeUpdate) GetExistingAttribute ¶
func (m *SearchAttributeUpdate) GetExistingAttribute() string
func (*SearchAttributeUpdate) GetNewAttribute ¶
func (m *SearchAttributeUpdate) GetNewAttribute() string
func (*SearchAttributeUpdate) GoString ¶
func (this *SearchAttributeUpdate) GoString() string
func (*SearchAttributeUpdate) Marshal ¶
func (m *SearchAttributeUpdate) Marshal() (dAtA []byte, err error)
func (*SearchAttributeUpdate) MarshalTo ¶
func (m *SearchAttributeUpdate) MarshalTo(dAtA []byte) (int, error)
func (*SearchAttributeUpdate) MarshalToSizedBuffer ¶
func (m *SearchAttributeUpdate) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*SearchAttributeUpdate) ProtoMessage ¶
func (*SearchAttributeUpdate) ProtoMessage()
func (*SearchAttributeUpdate) Reset ¶
func (m *SearchAttributeUpdate) Reset()
func (*SearchAttributeUpdate) Size ¶
func (m *SearchAttributeUpdate) Size() (n int)
func (*SearchAttributeUpdate) String ¶
func (this *SearchAttributeUpdate) String() string
func (*SearchAttributeUpdate) Unmarshal ¶
func (m *SearchAttributeUpdate) Unmarshal(dAtA []byte) error
func (*SearchAttributeUpdate) XXX_DiscardUnknown ¶
func (m *SearchAttributeUpdate) XXX_DiscardUnknown()
func (*SearchAttributeUpdate) XXX_Marshal ¶
func (m *SearchAttributeUpdate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SearchAttributeUpdate) XXX_Merge ¶
func (m *SearchAttributeUpdate) XXX_Merge(src proto.Message)
func (*SearchAttributeUpdate) XXX_Size ¶
func (m *SearchAttributeUpdate) XXX_Size() int
func (*SearchAttributeUpdate) XXX_Unmarshal ¶
func (m *SearchAttributeUpdate) XXX_Unmarshal(b []byte) error
type ThirdPartyLogDetail ¶
type ThirdPartyLogDetail struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// the third party source, e.g. auth0
Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
// the raw log message from the third party app, e.g. the whole auth0 event log
RawMessage string `protobuf:"bytes,3,opt,name=raw_message,json=rawMessage,proto3" json:"raw_message,omitempty"`
}
func (*ThirdPartyLogDetail) Descriptor ¶
func (*ThirdPartyLogDetail) Descriptor() ([]byte, []int)
func (*ThirdPartyLogDetail) Equal ¶
func (this *ThirdPartyLogDetail) Equal(that interface{}) bool
func (*ThirdPartyLogDetail) GetId ¶
func (m *ThirdPartyLogDetail) GetId() string
func (*ThirdPartyLogDetail) GetRawMessage ¶
func (m *ThirdPartyLogDetail) GetRawMessage() string
func (*ThirdPartyLogDetail) GetSource ¶
func (m *ThirdPartyLogDetail) GetSource() string
func (*ThirdPartyLogDetail) GoString ¶
func (this *ThirdPartyLogDetail) GoString() string
func (*ThirdPartyLogDetail) Marshal ¶
func (m *ThirdPartyLogDetail) Marshal() (dAtA []byte, err error)
func (*ThirdPartyLogDetail) MarshalTo ¶
func (m *ThirdPartyLogDetail) MarshalTo(dAtA []byte) (int, error)
func (*ThirdPartyLogDetail) MarshalToSizedBuffer ¶
func (m *ThirdPartyLogDetail) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ThirdPartyLogDetail) ProtoMessage ¶
func (*ThirdPartyLogDetail) ProtoMessage()
func (*ThirdPartyLogDetail) Reset ¶
func (m *ThirdPartyLogDetail) Reset()
func (*ThirdPartyLogDetail) Size ¶
func (m *ThirdPartyLogDetail) Size() (n int)
func (*ThirdPartyLogDetail) String ¶
func (this *ThirdPartyLogDetail) String() string
func (*ThirdPartyLogDetail) Unmarshal ¶
func (m *ThirdPartyLogDetail) Unmarshal(dAtA []byte) error
func (*ThirdPartyLogDetail) XXX_DiscardUnknown ¶
func (m *ThirdPartyLogDetail) XXX_DiscardUnknown()
func (*ThirdPartyLogDetail) XXX_Marshal ¶
func (m *ThirdPartyLogDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ThirdPartyLogDetail) XXX_Merge ¶
func (m *ThirdPartyLogDetail) XXX_Merge(src proto.Message)
func (*ThirdPartyLogDetail) XXX_Size ¶
func (m *ThirdPartyLogDetail) XXX_Size() int
func (*ThirdPartyLogDetail) XXX_Unmarshal ¶
func (m *ThirdPartyLogDetail) XXX_Unmarshal(b []byte) error
Click to show internal directories.
Click to hide internal directories.