audit

Documentation

Index

• Constants
• type Entry
  • func NewEntry(deploymentID string) Entry
  • func ToEntry(w http.ResponseWriter, r *http.Request, reqClaims map[string]interface{}, ...) Entry
• type ObjectVersion

Constants

const Version = "1"

Version - represents the current version of audit log structure.

Types

type Entry

type Entry struct {
	Version      string    `json:"version"`
	DeploymentID string    `json:"deploymentid,omitempty"`
	Time         time.Time `json:"time"`
	Trigger      string    `json:"trigger"`
	API          struct {
		Path            string `json:"path,omitempty"`
		Status          string `json:"status,omitempty"`
		Method          string `json:"method"`
		StatusCode      int    `json:"statusCode,omitempty"`
		InputBytes      int64  `json:"rx"`
		OutputBytes     int64  `json:"tx"`
		TimeToFirstByte string `json:"timeToFirstByte,omitempty"`
		TimeToResponse  string `json:"timeToResponse,omitempty"`
	} `json:"api"`
	RemoteHost string                 `json:"remotehost,omitempty"`
	RequestID  string                 `json:"requestID,omitempty"`
	SessionID  string                 `json:"sessionID,omitempty"`
	UserAgent  string                 `json:"userAgent,omitempty"`
	ReqClaims  map[string]interface{} `json:"requestClaims,omitempty"`
	ReqQuery   map[string]string      `json:"requestQuery,omitempty"`
	ReqHeader  map[string]string      `json:"requestHeader,omitempty"`
	RespHeader map[string]string      `json:"responseHeader,omitempty"`
	Tags       map[string]interface{} `json:"tags,omitempty"`
}

Entry - audit entry logs.

func NewEntry

func NewEntry(deploymentID string) Entry

NewEntry - constructs an audit entry object with some fields filled

func ToEntry

func ToEntry(w http.ResponseWriter, r *http.Request, reqClaims map[string]interface{}, deploymentID string) Entry

ToEntry - constructs an audit entry from a http request

type ObjectVersion

type ObjectVersion struct {
	ObjectName string `json:"objectName"`
	VersionID  string `json:"versionId,omitempty"`
}

ObjectVersion object version key/versionId