logger

Documentation

Index

• Variables
• func Logger() observability.StructuredLogger
• func SanitizeFieldValue(key string, value any) any
• func SanitizeJSON(jsonBytes []byte) string
• func SanitizeJSONValue(jsonBytes []byte) any
• func SanitizeLogString(value string) string
• func SanitizeXML(xmlString string, patterns []sanitization.XMLSanitizationPattern) string
• func SetLogger(next observability.StructuredLogger)
• type RawJSON

Variables

var PaymentXMLPatterns = sanitization.PaymentXMLPatterns

PaymentXMLPatterns are pre-configured XML patterns for payment payloads.

var RapidConnectXMLPatterns = sanitization.RapidConnectXMLPatterns

RapidConnectXMLPatterns are aliases for PaymentXMLPatterns.

Functions

func Logger

func Logger() observability.StructuredLogger

Logger returns the global structured logger singleton.

func SanitizeFieldValue

func SanitizeFieldValue(key string, value any) any

SanitizeFieldValue applies deterministic redaction rules to a field value.

func SanitizeJSON

func SanitizeJSON(jsonBytes []byte) string

SanitizeJSON returns a sanitized JSON string for safe logging.

func SanitizeJSONValue

func SanitizeJSONValue(jsonBytes []byte) any

SanitizeJSONValue returns a sanitized JSON structure for structured logging.

Prefer this over SanitizeJSON when using a JSON logger; it avoids escaping JSON as a string.

func SanitizeLogString

func SanitizeLogString(value string) string

SanitizeLogString removes control characters that could enable log forging.

func SanitizeXML

func SanitizeXML(xmlString string, patterns []sanitization.XMLSanitizationPattern) string

SanitizeXML masks sensitive data in XML using the provided patterns.

func SetLogger

func SetLogger(next observability.StructuredLogger)

SetLogger replaces the global structured logger singleton.

Passing nil resets the logger to a no-op implementation.

Types

type RawJSON

type RawJSON = sanitization.RawJSON

RawJSON is a marker type for JSON payloads that should be sanitized and logged as structured JSON.