logging

Documentation

Overview

Package logging holds the implementation for adapter logs.

Index

• Constants
• type ErrorDetails
  • func PrintError(code int, severity string, message string, args ...interface{}) ErrorDetails
• type Log
  • func InitPackageLogger(pkgName string) Log
  • func (l *Log) ErrorC(e ErrorDetails)

Constants

const (
	TEXT = "TEXT"
	JSON = "JSON"
)

Log Formalization Constants

const (
	SEVERITY  = "severity"
	ERRORCODE = "error_code"
)

Error Log attribute name constants

const (
	BLOCKER  = "Blocker"
	CRITICAL = "Critical"
	MAJOR    = "Major"
	MINOR    = "Minor"
	TRIVIAL  = "Trivial"
	DEFAULT  = "Default"
)

Log (Error) severity level constants

const (
	Error1000 = 1000
	Error1001 = 1001
	Error1002 = 1002
)

Error Log Internal Configuration(1000-1099) Config Constants - loggerConfig

const (
	Error1100 = 1100
	Error1101 = 1101
	Error1102 = 1102
	Error1103 = 1103
	Error1104 = 1104
	Error1105 = 1105
)

Error Log Internal Adapter(1100-1199) Constants - LoggerAPK

const (
	Error1400 = 1400
	Error1401 = 1401
	Error1402 = 1402
	Error1403 = 1403
	Error1410 = 1410
	Error1411 = 1411
	Error1413 = 1413
	Error1414 = 1414
)

Error Log Internal discovery(1400-1499) Config Constants - LoggerXds

const (
	Error1700 = 1700
	Error1701 = 1701
	Error1702 = 1702
	Error1703 = 1703
	Error1704 = 1704
	Error1705 = 1705
	Error1706 = 1706
	Error1707 = 1707
	Error1709 = 1709
	Error1710 = 1710
	Error1711 = 1711
	Error1712 = 1712
	Error1713 = 1713
	Error1714 = 1714
	Error1715 = 1715
	Error1716 = 1716
	Error1717 = 1717
	Error1718 = 1718
	Error1719 = 1719
	Error1720 = 1720
	Error1721 = 1721
	Error1722 = 1722
	Error1723 = 1723
	Error1724 = 1724
)

Error Log Internal XDS(1700-1799) Config Constants - LoggerXds

const (
	Error2600 = 2600
	Error2601 = 2601
	Error2602 = 2602
	Error2603 = 2603
	Error2604 = 2604
	Error2605 = 2605
	Error2606 = 2606
	Error2607 = 2607
	Error2608 = 2608
	Error2609 = 2609
	Error2610 = 2610
	Error2611 = 2611
	Error2612 = 2612
	Error2613 = 2613
	Error2614 = 2614
	Error2615 = 2615
	Error2616 = 2616
	Error2617 = 2617
	Error2618 = 2618
	Error2619 = 2619
	Error2620 = 2620
	Error2621 = 2621
	Error2622 = 2622
	Error2623 = 2623
	Error2625 = 2625
	Error2626 = 2626
	Error2627 = 2627
	Error2628 = 2628
	Error2629 = 2629
	Error2630 = 2630
	Error2631 = 2631
	Error2632 = 2632
	Error2633 = 2633
	Error2634 = 2634
	Error2635 = 2635
	Error2636 = 2636
	Error2637 = 2637
	Error2638 = 2638
	Error2639 = 2639
	Error2640 = 2640
	Error2641 = 2641
	Error2642 = 2642
	Error2643 = 2643
	Error2644 = 2644
	Error2645 = 2645
	Error2646 = 2646
	Error2647 = 2647
	Error2648 = 2648
	Error2649 = 2649
	Error2650 = 2650
	Error2651 = 2651
	Error2652 = 2652
	Error2653 = 2653
	Error2654 = 2654
	Error2655 = 2655
	Error2656 = 2656
	Error2657 = 2657
	Error2658 = 2658
	Error2659 = 2659
	Error2660 = 2660
	Error2661 = 2661
	Error2662 = 2662
	Error2663 = 2663
	Error2664 = 2664
	Error2665 = 2665
	Error2666 = 2666
	Error2667 = 2667
	Error2668 = 2668
)

Error Log Pkg operator(2600-2699) Config Constants - LoggerAPKOperator

const (
	Error3001 = 3001
	Error3002 = 3002
)

Error Log Pkg auth(3001-3099) Config Constants

const (
	Error3100 = 3100
	Error3101 = 3101
	Error3102 = 3102
	Error3103 = 3103
	Error3104 = 3104
	Error3105 = 3105
	Error3106 = 3106
	Error3107 = 3107
	Error3108 = 3108
	Error3109 = 3109
	Error3110 = 3110
	Error3111 = 3111
	Error3112 = 3112
	Error3113 = 3113
	Error3114 = 3114
	Error3115 = 3115
	Error3116 = 3116
	Error3117 = 3117
	Error3118 = 3118
	Error3119 = 3119
	Error3120 = 3120
	Error3121 = 3121
	Error3122 = 3122
	Error3123 = 3123
	Error3124 = 3124
	Error3125 = 3125
	Error3126 = 3126
)

Error codes gateway controller (3100-3199)

const (
	Error3200 = 3200
	Error3201 = 3201
	Error3202 = 3202
	Error3203 = 3203
	Error3204 = 3204
	Error3205 = 3205
	Error3206 = 3206
)

Error codes api (3200-3299)

const (
	Error2300 = 2300
)

Error Log RateLimiter callbacks(2300-2399) Config Constants - LoggerEnforcerXdsCallbacks

Types

type ErrorDetails

type ErrorDetails struct {
	Message   string
	Severity  string
	ErrorCode int
}

ErrorDetails used to keep error details for error logs

func PrintError

func PrintError(code int, severity string, message string, args ...interface{}) ErrorDetails

PrintError prints the error details

type Log

type Log struct {
	*logrus.Logger
}

Log represents the extended type of logrus.logger

func InitPackageLogger

func InitPackageLogger(pkgName string) Log

InitPackageLogger initialises the package loggers for given package name. If the package log level is defined in the log_config.toml file, it override the root log level.

func (*Log) ErrorC

func (l *Log) ErrorC(e ErrorDetails)

ErrorC can be used for formal error logs