logging

package
v1.28.0 Latest Latest
Warning

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

 Go to latest Published: Sep 27, 2022 License: Apache-2.0 Imports: 7 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Annotation 

type Annotation struct {
	// Time annotation was created (epoch microsecond value)
	Timestamp safelong.SafeLong `conjure-docs:"Time annotation was created (epoch microsecond value)" json:"timestamp"`
	// Value encapsulated by this annotation
	Value    string   `conjure-docs:"Value encapsulated by this annotation" json:"value"`
	Endpoint Endpoint `json:"endpoint"`
}

A Zipkin-compatible Annotation object.

func (Annotation) MarshalYAML added in v1.2.1 

func (o Annotation) MarshalYAML() (interface{}, error)

func (*Annotation) UnmarshalYAML added in v1.2.1 

func (o *Annotation) UnmarshalYAML(unmarshal func(interface{}) error) error

type AuditLogV2 

type AuditLogV2 struct {
	// "audit.2"
	Type string            `conjure-docs:"\"audit.2\"" json:"type"`
	Time datetime.DateTime `json:"time"`
	// User id (if available). This is the most downstream caller.
	Uid *UserId `conjure-docs:"User id (if available). This is the most downstream caller." json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Zipkin trace id (if available)
	TraceId *TraceId `conjure-docs:"Zipkin trace id (if available)" json:"traceId"`
	// All users upstream of the user currently taking an action. The first element in this list is the uid of the most upstream caller. This list does not include the `uid`.
	OtherUids []UserId `` /* 201-byte string literal not displayed */
	/*
	   Best-effort identifier of the originating machine, e.g. an IP address, a Kubernetes node identifier,
	   or similar
	*/
	Origin *string `` /* 141-byte string literal not displayed */
	// Name of the audit event, e.g. PUT_FILE
	Name string `conjure-docs:"Name of the audit event, e.g. PUT_FILE" json:"name"`
	// Indicates whether the request was successful or the type of failure, e.g. ERROR or UNAUTHORIZED
	Result AuditResult `conjure-docs:"Indicates whether the request was successful or the type of failure, e.g. ERROR or UNAUTHORIZED" json:"result"`
	// The parameters known at method invocation time.
	RequestParams map[string]interface{} `conjure-docs:"The parameters known at method invocation time." json:"requestParams"`
	// Information derived within a method, commonly parts of the return value.
	ResultParams map[string]interface{} `conjure-docs:"Information derived within a method, commonly parts of the return value." json:"resultParams"`
}

Definition of the audit.2 format.

func (AuditLogV2) MarshalJSON 

func (o AuditLogV2) MarshalJSON() ([]byte, error)

func (AuditLogV2) MarshalYAML 

func (o AuditLogV2) MarshalYAML() (interface{}, error)

func (*AuditLogV2) UnmarshalJSON 

func (o *AuditLogV2) UnmarshalJSON(data []byte) error

func (*AuditLogV2) UnmarshalYAML 

func (o *AuditLogV2) UnmarshalYAML(unmarshal func(interface{}) error) error

type AuditResult 

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

func New_AuditResult added in v1.10.0 

func New_AuditResult(value AuditResult_Value) AuditResult

func (AuditResult) IsUnknown added in v1.10.0 

func (e AuditResult) IsUnknown() bool

IsUnknown returns false for all known variants of AuditResult and true otherwise.

func (AuditResult) MarshalText added in v1.10.0 

func (e AuditResult) MarshalText() ([]byte, error)

func (AuditResult) String added in v1.10.0 

func (e AuditResult) String() string

func (*AuditResult) UnmarshalText added in v1.2.1 

func (e *AuditResult) UnmarshalText(data []byte) error

func (AuditResult) Value added in v1.10.0 

func (e AuditResult) Value() AuditResult_Value

type AuditResult_Value added in v1.10.0 

type AuditResult_Value string
const (
	AuditResult_SUCCESS      AuditResult_Value = "SUCCESS"
	AuditResult_UNAUTHORIZED AuditResult_Value = "UNAUTHORIZED"
	AuditResult_ERROR        AuditResult_Value = "ERROR"
	AuditResult_UNKNOWN      AuditResult_Value = "UNKNOWN"
)

func AuditResult_Values added in v1.10.0 

func AuditResult_Values() []AuditResult_Value

AuditResult_Values returns all known variants of AuditResult.

type BeaconLogV1 

type BeaconLogV1 struct {
	Type string            `json:"type"`
	Time datetime.DateTime `json:"time"`
	// Dot-delimited name for the structure of the params block, e.g. `compass.SearchEvent.v1`
	EventType string `conjure-docs:"Dot-delimited name for the structure of the params block, e.g. \"compass.SearchEvent.v1\"" json:"eventType"`
	// Name of the application that created the log
	AppName string `conjure-docs:"Name of the application that created the log" json:"appName"`
	// Version of the application that created the log
	AppVersion string `conjure-docs:"Version of the application that created the log" json:"appVersion"`
	// Known-safe parameters (redaction may be used to make params knowably safe, but is not required)
	Params map[string]interface{} `conjure-docs:"Known-safe parameters (redaction may be used to make params knowably safe, but is not required)" json:"params"`
	// Browser identifier (if available)
	BrowserId *string `conjure-docs:"Browser identifier (if available)" json:"browserId"`
	// User id (if available)
	Uid *UserId `conjure-docs:"User id (if available)" json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// Zipkin trace id (if available)
	TraceId *TraceId `conjure-docs:"Zipkin trace id (if available)" json:"traceId"`
	// Unredacted parameters
	UnsafeParams map[string]interface{} `conjure-docs:"Unredacted parameters" json:"unsafeParams"`
}

Definition of the beacon.1 format.

func (BeaconLogV1) MarshalJSON 

func (o BeaconLogV1) MarshalJSON() ([]byte, error)

func (BeaconLogV1) MarshalYAML 

func (o BeaconLogV1) MarshalYAML() (interface{}, error)

func (*BeaconLogV1) UnmarshalJSON 

func (o *BeaconLogV1) UnmarshalJSON(data []byte) error

func (*BeaconLogV1) UnmarshalYAML 

func (o *BeaconLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type Diagnostic 

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

func NewDiagnosticFromGeneric 

func NewDiagnosticFromGeneric(v GenericDiagnostic) Diagnostic

func NewDiagnosticFromThreadDump 

func NewDiagnosticFromThreadDump(v ThreadDumpV1) Diagnostic

func (*Diagnostic) Accept 

func (u *Diagnostic) Accept(v DiagnosticVisitor) error

func (*Diagnostic) AcceptFuncs added in v1.17.0 

func (u *Diagnostic) AcceptFuncs(genericFunc func(GenericDiagnostic) error, threadDumpFunc func(ThreadDumpV1) error, unknownFunc func(string) error) error

func (*Diagnostic) AcceptWithContext added in v1.8.0 

func (u *Diagnostic) AcceptWithContext(ctx context.Context, v DiagnosticVisitorWithContext) error

func (*Diagnostic) ErrorOnUnknown added in v1.17.0 

func (u *Diagnostic) ErrorOnUnknown(typeName string) error

func (*Diagnostic) GenericNoopSuccess added in v1.17.0 

func (u *Diagnostic) GenericNoopSuccess(GenericDiagnostic) error

func (Diagnostic) MarshalJSON 

func (u Diagnostic) MarshalJSON() ([]byte, error)

func (Diagnostic) MarshalYAML 

func (u Diagnostic) MarshalYAML() (interface{}, error)

func (*Diagnostic) ThreadDumpNoopSuccess added in v1.17.0 

func (u *Diagnostic) ThreadDumpNoopSuccess(ThreadDumpV1) error

func (*Diagnostic) UnmarshalJSON 

func (u *Diagnostic) UnmarshalJSON(data []byte) error

func (*Diagnostic) UnmarshalYAML 

func (u *Diagnostic) UnmarshalYAML(unmarshal func(interface{}) error) error

type DiagnosticLogV1 

type DiagnosticLogV1 struct {
	// "diagnostic.1"
	Type string            `conjure-docs:"\"diagnostic.1\"" json:"type"`
	Time datetime.DateTime `json:"time"`
	// The diagnostic being logged.
	Diagnostic Diagnostic `conjure-docs:"The diagnostic being logged." json:"diagnostic"`
	// Unredacted parameters
	UnsafeParams map[string]interface{} `conjure-docs:"Unredacted parameters" json:"unsafeParams"`
}

Definition of the diagnostic.1 format.

func (DiagnosticLogV1) MarshalJSON 

func (o DiagnosticLogV1) MarshalJSON() ([]byte, error)

func (DiagnosticLogV1) MarshalYAML 

func (o DiagnosticLogV1) MarshalYAML() (interface{}, error)

func (*DiagnosticLogV1) UnmarshalJSON 

func (o *DiagnosticLogV1) UnmarshalJSON(data []byte) error

func (*DiagnosticLogV1) UnmarshalYAML 

func (o *DiagnosticLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type DiagnosticVisitor 

type DiagnosticVisitor interface {
	VisitGeneric(v GenericDiagnostic) error
	VisitThreadDump(v ThreadDumpV1) error
	VisitUnknown(typeName string) error
}

type DiagnosticVisitorWithContext added in v1.8.0 

type DiagnosticVisitorWithContext interface {
	VisitGenericWithContext(ctx context.Context, v GenericDiagnostic) error
	VisitThreadDumpWithContext(ctx context.Context, v ThreadDumpV1) error
	VisitUnknownWithContext(ctx context.Context, typeName string) error
}

type DiagnosticVisitorWithT added in v1.28.0 

type DiagnosticVisitorWithT[T any] interface {
	VisitGeneric(ctx context.Context, v GenericDiagnostic) (T, error)
	VisitThreadDump(ctx context.Context, v ThreadDumpV1) (T, error)
	VisitUnknown(ctx context.Context, typ string) (T, error)
}

type DiagnosticWithT added in v1.28.0 

type DiagnosticWithT[T any] Diagnostic

func (*DiagnosticWithT[T]) Accept added in v1.28.0 

func (u *DiagnosticWithT[T]) Accept(ctx context.Context, v DiagnosticVisitorWithT[T]) (T, error)

type Endpoint 

type Endpoint struct {
	// Name of the service that generated the annotation
	ServiceName string `conjure-docs:"Name of the service that generated the annotation" json:"serviceName"`
	// IPv4 address of the machine that generated this annotation (`xxx.xxx.xxx.xxx`)
	Ipv4 *string `conjure-docs:"IPv4 address of the machine that generated this annotation (\"xxx.xxx.xxx.xxx\")" json:"ipv4"`
	// IPv6 address of the machine that generated this annotation (standard hextet form)
	Ipv6 *string `conjure-docs:"IPv6 address of the machine that generated this annotation (standard hextet form)" json:"ipv6"`
}

func (Endpoint) MarshalYAML added in v1.2.1 

func (o Endpoint) MarshalYAML() (interface{}, error)

func (*Endpoint) UnmarshalYAML added in v1.2.1 

func (o *Endpoint) UnmarshalYAML(unmarshal func(interface{}) error) error

type EventLogV1 

type EventLogV1 struct {
	Type string            `json:"type"`
	Time datetime.DateTime `json:"time"`
	// Dot-delimited name of event, e.g. `com.foundry.compass.api.Compass.http.ping.failures`
	EventName string `conjure-docs:"Dot-delimited name of event, e.g. \"com.foundry.compass.api.Compass.http.ping.failures\"" json:"eventName"`
	// Type of event being represented, e.g. `gauge`, `histogram`, `counter`
	EventType string `conjure-docs:"Type of event being represented, e.g. \"gauge\", \"histogram\", \"counter\"" json:"eventType"`
	// Observations, measurements and context associated with the event
	Values map[string]interface{} `conjure-docs:"Observations, measurements and context associated with the event" json:"values"`
	// User id (if available)
	Uid *UserId `conjure-docs:"User id (if available)" json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Unsafe metadata describing the event
	UnsafeParams map[string]interface{} `conjure-docs:"Unsafe metadata describing the event" json:"unsafeParams"`
}

Definition of the event.1 format.

func (EventLogV1) MarshalJSON 

func (o EventLogV1) MarshalJSON() ([]byte, error)

func (EventLogV1) MarshalYAML 

func (o EventLogV1) MarshalYAML() (interface{}, error)

func (*EventLogV1) UnmarshalJSON 

func (o *EventLogV1) UnmarshalJSON(data []byte) error

func (*EventLogV1) UnmarshalYAML 

func (o *EventLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type EventLogV2 

type EventLogV2 struct {
	Type string            `json:"type"`
	Time datetime.DateTime `json:"time"`
	// Dot-delimited name of event, e.g. `com.foundry.compass.api.Compass.http.ping.failures`
	EventName string `conjure-docs:"Dot-delimited name of event, e.g. \"com.foundry.compass.api.Compass.http.ping.failures\"" json:"eventName"`
	// Observations, measurements and context associated with the event
	Values map[string]interface{} `conjure-docs:"Observations, measurements and context associated with the event" json:"values"`
	// User id (if available)
	Uid *UserId `conjure-docs:"User id (if available)" json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Zipkin trace id (if available)
	TraceId *TraceId `conjure-docs:"Zipkin trace id (if available)" json:"traceId"`
	// Unsafe metadata describing the event
	UnsafeParams map[string]interface{} `conjure-docs:"Unsafe metadata describing the event" json:"unsafeParams"`
	// Additional dimensions that describe the instance of the log event
	Tags map[string]string `conjure-docs:"Additional dimensions that describe the instance of the log event" json:"tags"`
}

Definition of the event.2 format.

func (EventLogV2) MarshalJSON 

func (o EventLogV2) MarshalJSON() ([]byte, error)

func (EventLogV2) MarshalYAML 

func (o EventLogV2) MarshalYAML() (interface{}, error)

func (*EventLogV2) UnmarshalJSON 

func (o *EventLogV2) UnmarshalJSON(data []byte) error

func (*EventLogV2) UnmarshalYAML 

func (o *EventLogV2) UnmarshalYAML(unmarshal func(interface{}) error) error

type GenericDiagnostic 

type GenericDiagnostic struct {
	// An identifier for the type of diagnostic represented.
	DiagnosticType string `conjure-docs:"An identifier for the type of diagnostic represented." json:"diagnosticType"`
	// Observations, measurements and context associated with the diagnostic.
	Value interface{} `conjure-docs:"Observations, measurements and context associated with the diagnostic." json:"value"`
}

func (GenericDiagnostic) MarshalYAML added in v1.2.1 

func (o GenericDiagnostic) MarshalYAML() (interface{}, error)

func (*GenericDiagnostic) UnmarshalYAML added in v1.2.1 

func (o *GenericDiagnostic) UnmarshalYAML(unmarshal func(interface{}) error) error

type LogLevel 

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

func New_LogLevel added in v1.10.0 

func New_LogLevel(value LogLevel_Value) LogLevel

func (LogLevel) IsUnknown added in v1.10.0 

func (e LogLevel) IsUnknown() bool

IsUnknown returns false for all known variants of LogLevel and true otherwise.

func (LogLevel) MarshalText added in v1.10.0 

func (e LogLevel) MarshalText() ([]byte, error)

func (LogLevel) String added in v1.10.0 

func (e LogLevel) String() string

func (*LogLevel) UnmarshalText added in v1.2.1 

func (e *LogLevel) UnmarshalText(data []byte) error

func (LogLevel) Value added in v1.10.0 

func (e LogLevel) Value() LogLevel_Value

type LogLevel_Value added in v1.10.0 

type LogLevel_Value string
const (
	LogLevel_FATAL   LogLevel_Value = "FATAL"
	LogLevel_ERROR   LogLevel_Value = "ERROR"
	LogLevel_WARN    LogLevel_Value = "WARN"
	LogLevel_INFO    LogLevel_Value = "INFO"
	LogLevel_DEBUG   LogLevel_Value = "DEBUG"
	LogLevel_TRACE   LogLevel_Value = "TRACE"
	LogLevel_UNKNOWN LogLevel_Value = "UNKNOWN"
)

func LogLevel_Values added in v1.10.0 

func LogLevel_Values() []LogLevel_Value

LogLevel_Values returns all known variants of LogLevel.

type MetricLogV1 

type MetricLogV1 struct {
	Type string            `json:"type"`
	Time datetime.DateTime `json:"time"`
	// Dot-delimited name of metric, e.g. `com.foundry.compass.api.Compass.http.ping.failures`
	MetricName string `conjure-docs:"Dot-delimited name of metric, e.g. \"com.foundry.compass.api.Compass.http.ping.failures\"" json:"metricName"`
	// Type of metric being represented, e.g. `gauge`, `histogram`, `counter`
	MetricType string `conjure-docs:"Type of metric being represented, e.g. \"gauge\", \"histogram\", \"counter\"" json:"metricType"`
	// Observations, measurements and context associated with the metric
	Values map[string]interface{} `conjure-docs:"Observations, measurements and context associated with the metric" json:"values"`
	// Additional dimensions that describe the instance of the metric
	Tags map[string]string `conjure-docs:"Additional dimensions that describe the instance of the metric" json:"tags"`
	// User id (if available)
	Uid *UserId `conjure-docs:"User id (if available)" json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Unsafe metadata describing the event
	UnsafeParams map[string]interface{} `conjure-docs:"Unsafe metadata describing the event" json:"unsafeParams"`
}

Definition of the metric.1 format.

func (MetricLogV1) MarshalJSON 

func (o MetricLogV1) MarshalJSON() ([]byte, error)

func (MetricLogV1) MarshalYAML 

func (o MetricLogV1) MarshalYAML() (interface{}, error)

func (*MetricLogV1) UnmarshalJSON 

func (o *MetricLogV1) UnmarshalJSON(data []byte) error

func (*MetricLogV1) UnmarshalYAML 

func (o *MetricLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type RequestLog 

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

func NewRequestLogFromV1 

func NewRequestLogFromV1(v RequestLogV1) RequestLog

func NewRequestLogFromV2 

func NewRequestLogFromV2(v RequestLogV2) RequestLog

func (*RequestLog) Accept 

func (u *RequestLog) Accept(v RequestLogVisitor) error

func (*RequestLog) AcceptFuncs added in v1.17.0 

func (u *RequestLog) AcceptFuncs(v1Func func(RequestLogV1) error, v2Func func(RequestLogV2) error, unknownFunc func(string) error) error

func (*RequestLog) AcceptWithContext added in v1.8.0 

func (u *RequestLog) AcceptWithContext(ctx context.Context, v RequestLogVisitorWithContext) error

func (*RequestLog) ErrorOnUnknown added in v1.17.0 

func (u *RequestLog) ErrorOnUnknown(typeName string) error

func (RequestLog) MarshalJSON 

func (u RequestLog) MarshalJSON() ([]byte, error)

func (RequestLog) MarshalYAML 

func (u RequestLog) MarshalYAML() (interface{}, error)

func (*RequestLog) UnmarshalJSON 

func (u *RequestLog) UnmarshalJSON(data []byte) error

func (*RequestLog) UnmarshalYAML 

func (u *RequestLog) UnmarshalYAML(unmarshal func(interface{}) error) error

func (*RequestLog) V1NoopSuccess added in v1.17.0 

func (u *RequestLog) V1NoopSuccess(RequestLogV1) error

func (*RequestLog) V2NoopSuccess added in v1.17.0 

func (u *RequestLog) V2NoopSuccess(RequestLogV2) error

type RequestLogV1 

type RequestLogV1 struct {
	Type string            `json:"type"`
	Time datetime.DateTime `json:"time"`
	// HTTP method of request
	Method *string `conjure-docs:"HTTP method of request" json:"method"`
	// Protocol, e.g. `HTTP/1.1`, `HTTP/2`
	Protocol string `conjure-docs:"Protocol, e.g. \"HTTP/1.1\", \"HTTP/2\"" json:"protocol"`
	// Path of request. If templated, the unrendered path, e.g.: `/catalog/dataset/{datasetId}`, `/{rid}/paths/contents/{path:.*}`.
	Path string `` /* 155-byte string literal not displayed */
	// Known-safe path parameters
	PathParams map[string]interface{} `conjure-docs:"Known-safe path parameters" json:"pathParams"`
	// Known-safe query parameters
	QueryParams map[string]interface{} `conjure-docs:"Known-safe query parameters" json:"queryParams"`
	// Known-safe header parameters
	HeaderParams map[string]interface{} `conjure-docs:"Known-safe header parameters" json:"headerParams"`
	// Known-safe body parameters
	BodyParams map[string]interface{} `conjure-docs:"Known-safe body parameters" json:"bodyParams"`
	// HTTP status code of response
	Status int `conjure-docs:"HTTP status code of response" json:"status"`
	// Size of request (bytes). string to allow large numbers.
	RequestSize string `conjure-docs:"Size of request (bytes). string to allow large numbers." json:"requestSize"`
	// Size of response (bytes). string to allow large numbers.
	ResponseSize string `conjure-docs:"Size of response (bytes). string to allow large numbers." json:"responseSize"`
	// Amount of time spent handling request (microseconds)
	Duration int `conjure-docs:"Amount of time spent handling request (microseconds)" json:"duration"`
	// User id (if available)
	Uid *UserId `conjure-docs:"User id (if available)" json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Zipkin trace id (if available)
	TraceId *TraceId `conjure-docs:"Zipkin trace id (if available)" json:"traceId"`
	// Unredacted parameters such as path, query and header parameters
	UnsafeParams map[string]interface{} `conjure-docs:"Unredacted parameters such as path, query and header parameters" json:"unsafeParams"`
}

Definition of the request.1 format.

func (RequestLogV1) MarshalJSON 

func (o RequestLogV1) MarshalJSON() ([]byte, error)

func (RequestLogV1) MarshalYAML 

func (o RequestLogV1) MarshalYAML() (interface{}, error)

func (*RequestLogV1) UnmarshalJSON 

func (o *RequestLogV1) UnmarshalJSON(data []byte) error

func (*RequestLogV1) UnmarshalYAML 

func (o *RequestLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type RequestLogV2 

type RequestLogV2 struct {
	Type string            `json:"type"`
	Time datetime.DateTime `json:"time"`
	// HTTP method of request
	Method *string `conjure-docs:"HTTP method of request" json:"method"`
	// Protocol, e.g. `HTTP/1.1`, `HTTP/2`
	Protocol string `conjure-docs:"Protocol, e.g. \"HTTP/1.1\", \"HTTP/2\"" json:"protocol"`
	// Path of request. If templated, the unrendered path, e.g.: `/catalog/dataset/{datasetId}`, `/{rid}/paths/contents/{path:.*}`.
	Path string `` /* 155-byte string literal not displayed */
	// Known-safe parameters
	Params map[string]interface{} `conjure-docs:"Known-safe parameters" json:"params"`
	// HTTP status code of response
	Status int `conjure-docs:"HTTP status code of response" json:"status"`
	// Size of request (bytes)
	RequestSize safelong.SafeLong `conjure-docs:"Size of request (bytes)" json:"requestSize"`
	// Size of response (bytes)
	ResponseSize safelong.SafeLong `conjure-docs:"Size of response (bytes)" json:"responseSize"`
	// Amount of time spent handling request (microseconds)
	Duration safelong.SafeLong `conjure-docs:"Amount of time spent handling request (microseconds)" json:"duration"`
	// User id (if available)
	Uid *UserId `conjure-docs:"User id (if available)" json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Zipkin trace id (if available)
	TraceId *TraceId `conjure-docs:"Zipkin trace id (if available)" json:"traceId"`
	// Unredacted parameters such as path, query and header parameters
	UnsafeParams map[string]interface{} `conjure-docs:"Unredacted parameters such as path, query and header parameters" json:"unsafeParams"`
}

Definition of the request.2 format.

func (RequestLogV2) MarshalJSON 

func (o RequestLogV2) MarshalJSON() ([]byte, error)

func (RequestLogV2) MarshalYAML 

func (o RequestLogV2) MarshalYAML() (interface{}, error)

func (*RequestLogV2) UnmarshalJSON 

func (o *RequestLogV2) UnmarshalJSON(data []byte) error

func (*RequestLogV2) UnmarshalYAML 

func (o *RequestLogV2) UnmarshalYAML(unmarshal func(interface{}) error) error

type RequestLogVisitor 

type RequestLogVisitor interface {
	VisitV1(v RequestLogV1) error
	VisitV2(v RequestLogV2) error
	VisitUnknown(typeName string) error
}

type RequestLogVisitorWithContext added in v1.8.0 

type RequestLogVisitorWithContext interface {
	VisitV1WithContext(ctx context.Context, v RequestLogV1) error
	VisitV2WithContext(ctx context.Context, v RequestLogV2) error
	VisitUnknownWithContext(ctx context.Context, typeName string) error
}

type RequestLogVisitorWithT added in v1.28.0 

type RequestLogVisitorWithT[T any] interface {
	VisitV1(ctx context.Context, v RequestLogV1) (T, error)
	VisitV2(ctx context.Context, v RequestLogV2) (T, error)
	VisitUnknown(ctx context.Context, typ string) (T, error)
}

type RequestLogWithT added in v1.28.0 

type RequestLogWithT[T any] RequestLog

func (*RequestLogWithT[T]) Accept added in v1.28.0 

func (u *RequestLogWithT[T]) Accept(ctx context.Context, v RequestLogVisitorWithT[T]) (T, error)

type ServiceLogV1 

type ServiceLogV1 struct {
	// "service.1"
	Type string `conjure-docs:"\"service.1\"" json:"type"`
	// The logger output level. One of {FATAL,ERROR,WARN,INFO,DEBUG,TRACE}.
	Level LogLevel `conjure-docs:"The logger output level. One of {FATAL,ERROR,WARN,INFO,DEBUG,TRACE}." json:"level"`
	// RFC3339Nano UTC datetime string when the log event was emitted
	Time datetime.DateTime `conjure-docs:"RFC3339Nano UTC datetime string when the log event was emitted" json:"time"`
	// Class or file name. May include line number.
	Origin *string `conjure-docs:"Class or file name. May include line number." json:"origin"`
	// Thread name
	Thread *string `conjure-docs:"Thread name" json:"thread"`
	// Log message. Palantir Java services using slf4j should not use slf4j placeholders ({}). Logs obtained from 3rd party libraries or services that use slf4j and contain slf4j placeholders will always produce `unsafeParams` with numeric indexes corresponding to the zero-indexed order of placeholders. Renderers should substitute numeric parameters from `unsafeParams` and may leave placeholders that do not match indexes as the original placeholder text.
	Message string `` /* 485-byte string literal not displayed */
	// Known-safe parameters (redaction may be used to make params knowably safe, but is not required).
	Params map[string]interface{} `conjure-docs:"Known-safe parameters (redaction may be used to make params knowably safe, but is not required)." json:"params"`
	// User id (if available).
	Uid *UserId `conjure-docs:"User id (if available)." json:"uid"`
	// Session id (if available)
	Sid *SessionId `conjure-docs:"Session id (if available)" json:"sid"`
	// API token id (if available)
	TokenId *TokenId `conjure-docs:"API token id (if available)" json:"tokenId"`
	// Zipkin trace id (if available)
	TraceId *TraceId `conjure-docs:"Zipkin trace id (if available)" json:"traceId"`
	// Language-specific stack trace. Content is knowably safe. Renderers should substitute named placeholders ({name}, for name as a key) with keyed value from unsafeParams and leave non-matching keys as the original placeholder text.
	Stacktrace *string `` /* 261-byte string literal not displayed */
	// Unredacted parameters
	UnsafeParams map[string]interface{} `conjure-docs:"Unredacted parameters" json:"unsafeParams"`
	// Additional dimensions that describe the instance of the log event
	Tags map[string]string `conjure-docs:"Additional dimensions that describe the instance of the log event" json:"tags"`
}

Definition of the service.1 format.

func (ServiceLogV1) MarshalJSON 

func (o ServiceLogV1) MarshalJSON() ([]byte, error)

func (ServiceLogV1) MarshalYAML 

func (o ServiceLogV1) MarshalYAML() (interface{}, error)

func (*ServiceLogV1) UnmarshalJSON 

func (o *ServiceLogV1) UnmarshalJSON(data []byte) error

func (*ServiceLogV1) UnmarshalYAML 

func (o *ServiceLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type SessionId 

type SessionId string

type Span 

type Span struct {
	// 16-digit hex trace identifier
	TraceId string `conjure-docs:"16-digit hex trace identifier" json:"traceId"`
	// 16-digit hex span identifier
	Id string `conjure-docs:"16-digit hex span identifier" json:"id"`
	// Name of the span (typically the operation/RPC/method name for corresponding to this span)
	Name string `conjure-docs:"Name of the span (typically the operation/RPC/method name for corresponding to this span)" json:"name"`
	// 16-digit hex identifer of the parent span
	ParentId *string `conjure-docs:"16-digit hex identifer of the parent span" json:"parentId"`
	// Timestamp of the start of this span (epoch microsecond value)
	Timestamp safelong.SafeLong `conjure-docs:"Timestamp of the start of this span (epoch microsecond value)" json:"timestamp"`
	// Duration of this span (microseconds)
	Duration    safelong.SafeLong `conjure-docs:"Duration of this span (microseconds)" json:"duration"`
	Annotations []Annotation      `json:"annotations"`
	// Additional dimensions that describe the instance of the trace span
	Tags map[string]string `conjure-docs:"Additional dimensions that describe the instance of the trace span" json:"tags"`
}

A Zipkin-compatible Span object.

func (Span) MarshalJSON 

func (o Span) MarshalJSON() ([]byte, error)

func (Span) MarshalYAML 

func (o Span) MarshalYAML() (interface{}, error)

func (*Span) UnmarshalJSON 

func (o *Span) UnmarshalJSON(data []byte) error

func (*Span) UnmarshalYAML 

func (o *Span) UnmarshalYAML(unmarshal func(interface{}) error) error

type StackFrameV1 

type StackFrameV1 struct {
	// The address of the execution point of this stack frame. This is a string because a safelong can't represent the full 64 bit address space.
	Address *string `` /* 168-byte string literal not displayed */
	// The identifier of the procedure containing the execution point of this stack frame. This is a fully qualified method name in Java and a demangled symbol name in native code, for example. Note that procedure names may include unsafe information if a service is, for exmaple, running user-defined code. It must be safely redacted.
	Procedure *string `` /* 360-byte string literal not displayed */
	// The name of the file containing the source location of the execution point of this stack frame. Note that file names may include unsafe information if a service is, for example, running user-defined code. It must be safely redacted.
	File *string `` /* 259-byte string literal not displayed */
	// The line number of the source location of the execution point of this stack frame.
	Line *int `conjure-docs:"The line number of the source location of the execution point of this stack frame." json:"line"`
	// Other frame-level information.
	Params map[string]interface{} `conjure-docs:"Other frame-level information." json:"params"`
}

func (StackFrameV1) MarshalJSON 

func (o StackFrameV1) MarshalJSON() ([]byte, error)

func (StackFrameV1) MarshalYAML 

func (o StackFrameV1) MarshalYAML() (interface{}, error)

func (*StackFrameV1) UnmarshalJSON 

func (o *StackFrameV1) UnmarshalJSON(data []byte) error

func (*StackFrameV1) UnmarshalYAML 

func (o *StackFrameV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type ThreadDumpV1 

type ThreadDumpV1 struct {
	// Information about each of the threads in the thread dump. "Thread" may refer to a userland thread such as a goroutine, or an OS-level thread.
	Threads []ThreadInfoV1 `` /* 173-byte string literal not displayed */
}

func (ThreadDumpV1) MarshalJSON 

func (o ThreadDumpV1) MarshalJSON() ([]byte, error)

func (ThreadDumpV1) MarshalYAML 

func (o ThreadDumpV1) MarshalYAML() (interface{}, error)

func (*ThreadDumpV1) UnmarshalJSON 

func (o *ThreadDumpV1) UnmarshalJSON(data []byte) error

func (*ThreadDumpV1) UnmarshalYAML 

func (o *ThreadDumpV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type ThreadInfoV1 

type ThreadInfoV1 struct {
	// The ID of the thread.
	Id *safelong.SafeLong `conjure-docs:"The ID of the thread." json:"id"`
	// The name of the thread. Note that thread names may include unsafe information such as the path of the HTTP request being processed. It must be safely redacted.
	Name *string `` /* 186-byte string literal not displayed */
	// A list of stack frames for the thread, ordered with the current frame first.
	StackTrace []StackFrameV1 `conjure-docs:"A list of stack frames for the thread, ordered with the current frame first." json:"stackTrace"`
	// Other thread-level information.
	Params map[string]interface{} `conjure-docs:"Other thread-level information." json:"params"`
}

func (ThreadInfoV1) MarshalJSON 

func (o ThreadInfoV1) MarshalJSON() ([]byte, error)

func (ThreadInfoV1) MarshalYAML 

func (o ThreadInfoV1) MarshalYAML() (interface{}, error)

func (*ThreadInfoV1) UnmarshalJSON 

func (o *ThreadInfoV1) UnmarshalJSON(data []byte) error

func (*ThreadInfoV1) UnmarshalYAML 

func (o *ThreadInfoV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type TokenId 

type TokenId string

type TraceId 

type TraceId string

type TraceLogV1 

type TraceLogV1 struct {
	Type         string                 `json:"type"`
	Time         datetime.DateTime      `json:"time"`
	Uid          *UserId                `json:"uid"`
	Sid          *SessionId             `json:"sid"`
	TokenId      *TokenId               `json:"tokenId"`
	UnsafeParams map[string]interface{} `json:"unsafeParams"`
	Span         Span                   `json:"span"`
}

Definition of the trace.1 format.

func (TraceLogV1) MarshalJSON 

func (o TraceLogV1) MarshalJSON() ([]byte, error)

func (TraceLogV1) MarshalYAML 

func (o TraceLogV1) MarshalYAML() (interface{}, error)

func (*TraceLogV1) UnmarshalJSON 

func (o *TraceLogV1) UnmarshalJSON(data []byte) error

func (*TraceLogV1) UnmarshalYAML 

func (o *TraceLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type UnionEventLog 

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

Union type containing log types that are logged to event.log.

func NewUnionEventLogFromBeaconLog 

func NewUnionEventLogFromBeaconLog(v BeaconLogV1) UnionEventLog

func NewUnionEventLogFromEventLog 

func NewUnionEventLogFromEventLog(v EventLogV1) UnionEventLog

func NewUnionEventLogFromEventLogV2 

func NewUnionEventLogFromEventLogV2(v EventLogV2) UnionEventLog

func (*UnionEventLog) Accept 

func (u *UnionEventLog) Accept(v UnionEventLogVisitor) error

func (*UnionEventLog) AcceptFuncs added in v1.17.0 

func (u *UnionEventLog) AcceptFuncs(eventLogFunc func(EventLogV1) error, eventLogV2Func func(EventLogV2) error, beaconLogFunc func(BeaconLogV1) error, unknownFunc func(string) error) error

func (*UnionEventLog) AcceptWithContext added in v1.8.0 

func (u *UnionEventLog) AcceptWithContext(ctx context.Context, v UnionEventLogVisitorWithContext) error

func (*UnionEventLog) BeaconLogNoopSuccess added in v1.17.0 

func (u *UnionEventLog) BeaconLogNoopSuccess(BeaconLogV1) error

func (*UnionEventLog) ErrorOnUnknown added in v1.17.0 

func (u *UnionEventLog) ErrorOnUnknown(typeName string) error

func (*UnionEventLog) EventLogNoopSuccess added in v1.17.0 

func (u *UnionEventLog) EventLogNoopSuccess(EventLogV1) error

func (*UnionEventLog) EventLogV2NoopSuccess added in v1.17.0 

func (u *UnionEventLog) EventLogV2NoopSuccess(EventLogV2) error

func (UnionEventLog) MarshalJSON 

func (u UnionEventLog) MarshalJSON() ([]byte, error)

func (UnionEventLog) MarshalYAML 

func (u UnionEventLog) MarshalYAML() (interface{}, error)

func (*UnionEventLog) UnmarshalJSON 

func (u *UnionEventLog) UnmarshalJSON(data []byte) error

func (*UnionEventLog) UnmarshalYAML 

func (u *UnionEventLog) UnmarshalYAML(unmarshal func(interface{}) error) error

type UnionEventLogVisitor 

type UnionEventLogVisitor interface {
	VisitEventLog(v EventLogV1) error
	VisitEventLogV2(v EventLogV2) error
	VisitBeaconLog(v BeaconLogV1) error
	VisitUnknown(typeName string) error
}

type UnionEventLogVisitorWithContext added in v1.8.0 

type UnionEventLogVisitorWithContext interface {
	VisitEventLogWithContext(ctx context.Context, v EventLogV1) error
	VisitEventLogV2WithContext(ctx context.Context, v EventLogV2) error
	VisitBeaconLogWithContext(ctx context.Context, v BeaconLogV1) error
	VisitUnknownWithContext(ctx context.Context, typeName string) error
}

type UnionEventLogVisitorWithT added in v1.28.0 

type UnionEventLogVisitorWithT[T any] interface {
	VisitEventLog(ctx context.Context, v EventLogV1) (T, error)
	VisitEventLogV2(ctx context.Context, v EventLogV2) (T, error)
	VisitBeaconLog(ctx context.Context, v BeaconLogV1) (T, error)
	VisitUnknown(ctx context.Context, typ string) (T, error)
}

type UnionEventLogWithT added in v1.28.0 

type UnionEventLogWithT[T any] UnionEventLog

func (*UnionEventLogWithT[T]) Accept added in v1.28.0 

func (u *UnionEventLogWithT[T]) Accept(ctx context.Context, v UnionEventLogVisitorWithT[T]) (T, error)

type UserId 

type UserId string

type WrappedLogV1 

type WrappedLogV1 struct {
	// "wrapped.1"
	Type    string              `conjure-docs:"\"wrapped.1\"" json:"type"`
	Payload WrappedLogV1Payload `json:"payload"`
	// Artifact part of entity's maven coordinate
	EntityName    string `conjure-docs:"Artifact part of entity's maven coordinate" json:"entityName"`
	EntityVersion string `json:"entityVersion"`
}

Wraps a log entry with entity information.

func (WrappedLogV1) MarshalYAML added in v1.2.1 

func (o WrappedLogV1) MarshalYAML() (interface{}, error)

func (*WrappedLogV1) UnmarshalYAML added in v1.2.1 

func (o *WrappedLogV1) UnmarshalYAML(unmarshal func(interface{}) error) error

type WrappedLogV1Payload 

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

func NewWrappedLogV1PayloadFromAuditLogV2 

func NewWrappedLogV1PayloadFromAuditLogV2(v AuditLogV2) WrappedLogV1Payload

func NewWrappedLogV1PayloadFromDiagnosticLogV1 

func NewWrappedLogV1PayloadFromDiagnosticLogV1(v DiagnosticLogV1) WrappedLogV1Payload

func NewWrappedLogV1PayloadFromEventLogV2 

func NewWrappedLogV1PayloadFromEventLogV2(v EventLogV2) WrappedLogV1Payload

func NewWrappedLogV1PayloadFromMetricLogV1 

func NewWrappedLogV1PayloadFromMetricLogV1(v MetricLogV1) WrappedLogV1Payload

func NewWrappedLogV1PayloadFromRequestLogV2 

func NewWrappedLogV1PayloadFromRequestLogV2(v RequestLogV2) WrappedLogV1Payload

func NewWrappedLogV1PayloadFromServiceLogV1 

func NewWrappedLogV1PayloadFromServiceLogV1(v ServiceLogV1) WrappedLogV1Payload

func NewWrappedLogV1PayloadFromTraceLogV1 

func NewWrappedLogV1PayloadFromTraceLogV1(v TraceLogV1) WrappedLogV1Payload

func (*WrappedLogV1Payload) Accept 

func (u *WrappedLogV1Payload) Accept(v WrappedLogV1PayloadVisitor) error

func (*WrappedLogV1Payload) AcceptFuncs added in v1.17.0 

func (u *WrappedLogV1Payload) AcceptFuncs(serviceLogV1Func func(ServiceLogV1) error, requestLogV2Func func(RequestLogV2) error, traceLogV1Func func(TraceLogV1) error, eventLogV2Func func(EventLogV2) error, metricLogV1Func func(MetricLogV1) error, auditLogV2Func func(AuditLogV2) error, diagnosticLogV1Func func(DiagnosticLogV1) error, unknownFunc func(string) error) error

func (*WrappedLogV1Payload) AcceptWithContext added in v1.8.0 

func (u *WrappedLogV1Payload) AcceptWithContext(ctx context.Context, v WrappedLogV1PayloadVisitorWithContext) error

func (*WrappedLogV1Payload) AuditLogV2NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) AuditLogV2NoopSuccess(AuditLogV2) error

func (*WrappedLogV1Payload) DiagnosticLogV1NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) DiagnosticLogV1NoopSuccess(DiagnosticLogV1) error

func (*WrappedLogV1Payload) ErrorOnUnknown added in v1.17.0 

func (u *WrappedLogV1Payload) ErrorOnUnknown(typeName string) error

func (*WrappedLogV1Payload) EventLogV2NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) EventLogV2NoopSuccess(EventLogV2) error

func (WrappedLogV1Payload) MarshalJSON 

func (u WrappedLogV1Payload) MarshalJSON() ([]byte, error)

func (WrappedLogV1Payload) MarshalYAML 

func (u WrappedLogV1Payload) MarshalYAML() (interface{}, error)

func (*WrappedLogV1Payload) MetricLogV1NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) MetricLogV1NoopSuccess(MetricLogV1) error

func (*WrappedLogV1Payload) RequestLogV2NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) RequestLogV2NoopSuccess(RequestLogV2) error

func (*WrappedLogV1Payload) ServiceLogV1NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) ServiceLogV1NoopSuccess(ServiceLogV1) error

func (*WrappedLogV1Payload) TraceLogV1NoopSuccess added in v1.17.0 

func (u *WrappedLogV1Payload) TraceLogV1NoopSuccess(TraceLogV1) error

func (*WrappedLogV1Payload) UnmarshalJSON 

func (u *WrappedLogV1Payload) UnmarshalJSON(data []byte) error

func (*WrappedLogV1Payload) UnmarshalYAML 

func (u *WrappedLogV1Payload) UnmarshalYAML(unmarshal func(interface{}) error) error

type WrappedLogV1PayloadVisitor 

type WrappedLogV1PayloadVisitor interface {
	VisitServiceLogV1(v ServiceLogV1) error
	VisitRequestLogV2(v RequestLogV2) error
	VisitTraceLogV1(v TraceLogV1) error
	VisitEventLogV2(v EventLogV2) error
	VisitMetricLogV1(v MetricLogV1) error
	VisitAuditLogV2(v AuditLogV2) error
	VisitDiagnosticLogV1(v DiagnosticLogV1) error
	VisitUnknown(typeName string) error
}

type WrappedLogV1PayloadVisitorWithContext added in v1.8.0 

type WrappedLogV1PayloadVisitorWithContext interface {
	VisitServiceLogV1WithContext(ctx context.Context, v ServiceLogV1) error
	VisitRequestLogV2WithContext(ctx context.Context, v RequestLogV2) error
	VisitTraceLogV1WithContext(ctx context.Context, v TraceLogV1) error
	VisitEventLogV2WithContext(ctx context.Context, v EventLogV2) error
	VisitMetricLogV1WithContext(ctx context.Context, v MetricLogV1) error
	VisitAuditLogV2WithContext(ctx context.Context, v AuditLogV2) error
	VisitDiagnosticLogV1WithContext(ctx context.Context, v DiagnosticLogV1) error
	VisitUnknownWithContext(ctx context.Context, typeName string) error
}

type WrappedLogV1PayloadVisitorWithT added in v1.28.0 

type WrappedLogV1PayloadVisitorWithT[T any] interface {
	VisitServiceLogV1(ctx context.Context, v ServiceLogV1) (T, error)
	VisitRequestLogV2(ctx context.Context, v RequestLogV2) (T, error)
	VisitTraceLogV1(ctx context.Context, v TraceLogV1) (T, error)
	VisitEventLogV2(ctx context.Context, v EventLogV2) (T, error)
	VisitMetricLogV1(ctx context.Context, v MetricLogV1) (T, error)
	VisitAuditLogV2(ctx context.Context, v AuditLogV2) (T, error)
	VisitDiagnosticLogV1(ctx context.Context, v DiagnosticLogV1) (T, error)
	VisitUnknown(ctx context.Context, typ string) (T, error)
}

type WrappedLogV1PayloadWithT added in v1.28.0 

type WrappedLogV1PayloadWithT[T any] WrappedLogV1Payload

func (*WrappedLogV1PayloadWithT[T]) Accept added in v1.28.0 

func (u *WrappedLogV1PayloadWithT[T]) Accept(ctx context.Context, v WrappedLogV1PayloadVisitorWithT[T]) (T, error)

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.