audit

Documentation

Index

• Constants
• func ContextEntry(ctx context.Context, key string, val interface{})
• func ContextEntryMap(ctx context.Context, kv map[string]interface{})
• func ContextOptions(ctx context.Context, opts ...Option)
• func GetMethodFullName(method interface{}) string
• func GetMethodName(method interface{}) string
• type Auditor
  • func GetAuditor(ctx servicehub.Context) Auditor
• type GetScopeIDAndEntries
• type MethodAuditor
  • func Method(method interface{}, scope ScopeType, template string, ...) *MethodAuditor
  • func MethodWithError(method interface{}, scope ScopeType, template string, ...) *MethodAuditor
• type NopAuditor
  • func (a *NopAuditor) Audit(auditors ...*MethodAuditor) transport.ServiceOption
  • func (a *NopAuditor) Begin() Recorder
  • func (a *NopAuditor) GetApp(idObject interface{}) (*apistructs.ApplicationDTO, error)
  • func (a *NopAuditor) GetOrg(id interface{}) (*orgpb.Org, error)
  • func (a *NopAuditor) GetProject(id interface{}) (*apistructs.ProjectDTO, error)
  • func (a *NopAuditor) Record(ctx context.Context, scope ScopeType, scopeID interface{}, template string, ...)
  • func (a *NopAuditor) RecordError(ctx context.Context, scope ScopeType, scopeID interface{}, template string, ...)
• type Option
  • func Entries(h func(ctx context.Context) (map[string]interface{}, error)) Option
  • func Entry(key string, val interface{}) Option
  • func OrgID(id interface{}) Option
  • func UserID(id interface{}) Option
• type Recorder
• type ScopeQueryer
• type ScopeType
• type ValueFetcher
• type ValueFetcherWithContext

Constants

const (
	UserIDKey      = "userId"
	OrgIDKey       = "orgId"
	OrgNameKey     = "orgName"
	ProjectIDKey   = "projectId"
	ProjectNameKey = "projectName"
	AppIDKey       = "appId"
	AppNameKey     = "appName"
)

special keys

const AuditServiceName = "audit"

AuditServiceName .

Functions

func ContextEntry

func ContextEntry(ctx context.Context, key string, val interface{})

ContextEntry .

func ContextEntryMap

func ContextEntryMap(ctx context.Context, kv map[string]interface{})

func ContextOptions

func ContextOptions(ctx context.Context, opts ...Option)

ContextOptions .

func GetMethodFullName

func GetMethodFullName(method interface{}) string

func GetMethodName

func GetMethodName(method interface{}) string

Types

type Auditor

type Auditor interface {
	Recorder
	Begin() Recorder
	ScopeQueryer
	Audit(auditors ...*MethodAuditor) transport.ServiceOption
}

Auditor .

func GetAuditor

func GetAuditor(ctx servicehub.Context) Auditor

GetAuditor .

type GetScopeIDAndEntries

type GetScopeIDAndEntries func(ctx context.Context, req, resp interface{}, err error) (interface{}, map[string]interface{}, error)

GetScopeIDAndEntries .

type MethodAuditor

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

MethodAuditor .

func Method

func Method(method interface{}, scope ScopeType, template string, getter GetScopeIDAndEntries, options ...Option) *MethodAuditor

Method .

func MethodWithError

func MethodWithError(method interface{}, scope ScopeType, template string, getter GetScopeIDAndEntries, options ...Option) *MethodAuditor

MethodWithError .

type NopAuditor

type NopAuditor struct{}

NopAuditor .

func (*NopAuditor) Audit

func (a *NopAuditor) Audit(auditors ...*MethodAuditor) transport.ServiceOption

Audit .

func (*NopAuditor) Begin

func (a *NopAuditor) Begin() Recorder

Begin .

func (*NopAuditor) GetApp

func (a *NopAuditor) GetApp(idObject interface{}) (*apistructs.ApplicationDTO, error)

GetApp .

func (*NopAuditor) GetOrg

func (a *NopAuditor) GetOrg(id interface{}) (*orgpb.Org, error)

GetOrg .

func (*NopAuditor) GetProject

func (a *NopAuditor) GetProject(id interface{}) (*apistructs.ProjectDTO, error)

GetProject .

func (*NopAuditor) Record

func (a *NopAuditor) Record(ctx context.Context, scope ScopeType, scopeID interface{}, template string, options ...Option)

Record .

func (*NopAuditor) RecordError

func (a *NopAuditor) RecordError(ctx context.Context, scope ScopeType, scopeID interface{}, template string, options ...Option)

RecordError .

type Option

type Option func(opts *options)

Option .

func Entries

func Entries(h func(ctx context.Context) (map[string]interface{}, error)) Option

Entries .

func Entry

func Entry(key string, val interface{}) Option

Entry .

func OrgID

func OrgID(id interface{}) Option

OrgID .

func UserID

func UserID(id interface{}) Option

UserID .

type Recorder

type Recorder interface {
	Record(ctx context.Context, scope ScopeType, scopeID interface{}, template string, options ...Option)
	RecordError(ctx context.Context, scope ScopeType, scopeID interface{}, template string, options ...Option)
}

Recorder .

type ScopeQueryer

type ScopeQueryer interface {
	GetOrg(id interface{}) (*orgpb.Org, error)
	GetProject(id interface{}) (*apistructs.ProjectDTO, error)
	GetApp(idObject interface{}) (*apistructs.ApplicationDTO, error)
}

ScopeQueryer .

type ScopeType

type ScopeType string

ScopeType .

const (
	SysScope       ScopeType = "sys"
	OrgScope       ScopeType = "org"
	ProjectScope   ScopeType = "project"
	AppScope       ScopeType = "app"
	PublisherScope ScopeType = "publisher"
)

ScopeType values

type ValueFetcher

type ValueFetcher func() interface{}

ValueFetcher .

type ValueFetcherWithContext

type ValueFetcherWithContext func(ctx context.Context) (interface{}, error)

ValueFetcherWithContext .