github-actions[bot]
commented
2 months ago API Changes
--- prev.txt 2024-09-05 11:17:07.003883236 +0000
+++ current.txt 2024-09-05 11:17:03.911857676 +0000
@@ -5247,6 +5247,10 @@
// If not set or left empty, it will default to `info`.
LogLevel string `json:"log_level"`
+ // You can now configure the log format to be either the standard or json format
+ // If not set or left empty, it will default to `standard`.
+ LogFormat string `json:"log_format"`
+
// Section for configuring OpenTracing support
// Deprecated: use OpenTelemetry instead.
Tracer Tracer `json:"tracing"`
@@ -8121,8 +8125,6 @@
func (gw *Gateway) InitHostCheckManager(ctx context.Context, store storage.Handler)
-func (gw *Gateway) InitializeRPCCache()
-
func (gw *Gateway) LoadAPI(specs ...*APISpec) (out []*APISpec)
func (gw *Gateway) LoadDefinitionsFromRPCBackup() ([]*APISpec, error)
@@ -10406,25 +10408,57 @@
FUNCTIONS
func Get() *logrus.Logger
+ Get returns the default configured logger.
+
func GetRaw() *logrus.Logger
+ GetRaw is used internally. Should likely be removed first, do not rely on
+ it.
+
func LoadTranslations(thing map[string]interface{})
LoadTranslations takes a map[string]interface and flattens it to
- map[string]string Because translations have been loaded - we internally
- override log the formatter Nested entries are accessible using dot notation.
- example: `{"foo": {"bar": "baz"}}` flattened: `foo.bar: baz`
+ map[string]string. Because translations have been loaded - we internally
+ override log the formatter. Nested entries are accessible using dot
+ notation.
+
+ Example: `{"foo": {"bar": "baz"}}` Flattened: `foo.bar: baz`
+func NewFormatter(format string) logrus.Formatter
TYPES
+type JSONFormatter struct {
+ // TimestampFormat sets the format used for marshaling timestamps.
+ // The format to use is the same than for time.Format or time.Parse from the standard
+ // library.
+ // The standard Library already provides a set of predefined format.
+ TimestampFormat string
+
+ // DisableTimestamp allows disabling automatic timestamps in output.
+ DisableTimestamp bool
+
+ // DataKey allows users to put all the log entry parameters into a nested dictionary at a given key.
+ DataKey string
+}
+ JSONFormatter formats logs into parsable json.
+
+func (f *JSONFormatter) Format(entry *logrus.Entry) ([]byte, error)
+ Format renders a single log entry
+
type RawFormatter struct{}
+ RawFormatter returns the logrus entry message as bytes.
func (f *RawFormatter) Format(entry *logrus.Entry) ([]byte, error)
+ Format returns the entry.Message as a []byte.
type TranslationFormatter struct {
- *logrus.TextFormatter
+ logrus.Formatter
}
+ TranslationFormatter handles message reformatting with translations.
func (t *TranslationFormatter) Format(entry *logrus.Entry) ([]byte, error)
+ Format will translate the log message based on the message code. This is a
+ HTTP response code if provided. The message is usually just "Finished" for
+ those cases, this would likely produce a better log message.
# Package: ./regexp
sonarcloud[bot]
Catch issues before they fail your Quality Gate with our IDE extension 
User description
TT-12355 added log format config, func and test cases (#6344)
FR Jira Ticket
https://tyktech.atlassian.net/browse/TT-12355
Description
TYK_GW_LOGFORMATGateway config optionTYK_GW_LOGFORMATis set tojsonthe Gateway will output logs in JSON formatTYK_GW_LOGFORMATis set to""empty string or any other string value it will default the TEXT formatAdditionally, TYK_LOGFORMAT is supported, as is TYK_LOGLEVEL (and TYK_GW_LOGLEVEL).
Note that there is some global use from the log package, I don't think we can set json output from json config, as it would be picked up too late. The one case to cover is to make sure this passes with only config enabled:
The above confirms reading from env and from config.
Related Issue
Motivation and Context
The option to determine which STDOUT log format will open the opportunity for customers to easily parse the STDOUT logs and open up opportunity for our team to easily write tests and parse as needed.
How This Has Been Tested
PR Type
Enhancement, Tests
Description
TYK_GW_LOGFORMATGateway config option to determine log format.NewFormatterfunction to switch between JSON and Text log formats.Changes walkthrough 📝
log.go
Add log format configuration and initializationlog/log.go
NewFormatterfunction to handle log format based onTYK_GW_LOGFORMATenvironment variable.NewFormatter.log_test.go
Add unit tests for log formatter configurationlog/log_test.go
NewFormatterfunction.Co-authored-by: Long Le tyk-longle@Tyk-longle-MacBook-Pro.local Co-authored-by: Tit Petric tit@tyk.io
PR Type
enhancement, tests
Description
LogFormatconfiguration option to allow JSON or standard text log output.log_formatoption.go-jsonfor JSON log formatting.Changes walkthrough 📝
5 files
config.go
Add log format configuration optionconfig/config.go
LogFormatconfiguration option.standard.server.go
Refactor system initialization and add log format setupgateway/server.go
initialiseSystemtoinitSystem.json_formatter.go
Implement JSON log formatterlog/json_formatter.go
log.go
Enhance logging with format and level configurationlog/log.go
variables.
translation_formatter.go
Separate translation formatter logiclog/translation_formatter.go
2 files
testutil.go
Update test setup with new system initializationgateway/testutil.go - Updated call to `initSystem` in test setup.
log_test.go
Add tests and benchmarks for log formatterslog/log_test.go
2 files
schema.json
Update schema with log format optioncli/linter/schema.json - Added `log_format` configuration option to schema.
Taskfile.yml
Add Taskfile for build automationlog/Taskfile.yml
2 files
go.mod
Add go-json dependencygo.mod - Added `github.com/goccy/go-json` dependency.
go.sum
Update go.sum with new dependency checksumsgo.sum - Updated with checksums for `go-json` dependency.