Documentation
¶
Index ¶
- Constants
- func AsDevLogger(f any) any
- func AsSystemLogger(f any) any
- func AuditEvent(l *zap.Logger, msg, outcome string, fields ...zap.Field)
- func AuditEventType(job *models.AppRunnerJob) string
- func IsAuditable(job *models.AppRunnerJob) bool
- func NewAudit(l *zap.Logger, job *models.AppRunnerJob) *zap.Logger
- func NewDev(cfg *runnerconfig.Config) (*zap.Logger, error)
- func NewFXLog(params FXParams) fxevent.Logger
- func NewHClog(l *zap.Logger) hclog.Logger
- func NewOTELJobLogger(cfg *runnerconfig.Config, lp *log.LoggerProvider) (*zap.Logger, error)
- func NewSystem(params SystemParams) *zap.Logger
- func SystemHclog(params Params) hclog.Logger
- type FXParams
- type Params
- type SystemParams
Constants ¶
const ( AuditAttr = "nuon.audit" AuditAttrValue = "true" AuditEventAttr = "nuon.audit.event" AuditOutcomeAttr = "nuon.audit.outcome" )
AuditAttr tags records the bundled collector forwards to the customer's backend. Its filter drops anything where the log record attribute nuon.audit != "true", so the value must be this exact string and must be a record attribute rather than a resource attribute.
const ( OutcomeStarted = "started" OutcomeSucceeded = "succeeded" OutcomeFailed = "failed" )
Variables ¶
This section is empty.
Functions ¶
func AsDevLogger ¶
func AsSystemLogger ¶
func AuditEvent ¶ added in v0.19.1097
AuditEvent emits one audit record, and does nothing when l is nil so callers can pass the result of NewAudit straight through without branching on whether the job was auditable.
func AuditEventType ¶ added in v0.19.1097
func AuditEventType(job *models.AppRunnerJob) string
func IsAuditable ¶ added in v0.19.1097
func IsAuditable(job *models.AppRunnerJob) bool
func NewAudit ¶ added in v0.19.1097
NewAudit derives an audit logger from a job logger. It returns nil for jobs whose group is not auditable, so callers must nil-check before emitting; tagging every job would send the runner's entire log volume to the customer.
func NewFXLog ¶ added in v0.19.1090
Lifecycle events log at debug, keeping the dependency graph out of the default info-level logs while leaving it available under LOG_LEVEL=debug. Errors keep fx's default error level.
func NewOTELJobLogger ¶
func NewOTELJobLogger(cfg *runnerconfig.Config, lp *log.LoggerProvider) (*zap.Logger, error)
func NewSystem ¶
func NewSystem(params SystemParams) *zap.Logger
func SystemHclog ¶
NOTE(jm): this will be deprecated once rolled out to each job
Types ¶
type SystemParams ¶
type SystemParams struct {
fx.In
Cfg *runnerconfig.Config
LP *log.LoggerProvider `name:"system"`
Settings *settings.Settings
}
the system logger is used to log all things that should not be sent to our API via OTEL
Source Files