Releases: rokwire/logging-library-go
Release list
v2.3.0
v2.2.0
V2.1.0
v2.0.0
BREAKING
This release includes breaking changes. Please see the "Migration steps' below for instructions on upgrading to this version.
[2.0.0] - 2022-11-16
Added
- Return trace ID in error responses #13
- Add OpenShift health check request properties builder for log suppression #14
Changed
- BREAKING: Restructure logs package #16
Full Changelog: https://github.com/rokwire/logging-library-go/blob/main/CHANGELOG.md
Migration Steps
Follow the steps below to upgrade to the associated version of this library. Note that the steps for each version are cumulative, so if you are attempting to upgrade by several versions, be sure to make the changes described for each version between your current version and the latest.
Log.Request- Functions
The Log.Request- functions have been removed. These can be replaced by the equivalent Log.HTTPResponse- function followed by Log.SendHTTPResponse.
Example Replacement:
func (we WebAdapter) test(l *logs.Log, w http.ResponseWriter, req *http.Request) {
...
// Removed
// l.RequestSuccess(w)
l.SendHTTPResponse(w, l.HTTPResponseSuccess())
}Removed Functions:
- Log.RequestSuccess
- Log.RequestSuccessAction
- Log.RequestSuccessMessage
- Log.RequestSuccessJSON
- Log.RequestError
- Log.RequestErrorAction
- Log.RequestErrorData
Log.-Action and Log.-Data Functions
The Log.-Action and log.-Data functions have been removed. These can be replaced by logutils.MessageAction(orlogutils.MessageActionSuccess/logutils.MessageActionError) or logutils.MessageData` function followed by the equivalent log level function.
Example Replacement:
func (we WebAdapter) test(l *logs.Log, w http.ResponseWriter, req *http.Request) {
...
// Removed
// l.WarnAction(logutils.ActionUpdate, nil, err)
l.WarnError(logutils.MessageActionError(logutils.ActionValidate, logutils.TypeQueryParam, nil), err)
...
}Removed Functions:
- Log.LogAction
- Log.WarnAction
- Log.ErrorAction
- Log.LogData
- Log.WarnData
- Log.ErrorData
Log.SetHeaders
The Log.SetHeaders function has been renamed to Log.SetRequestHeaders and a new Log.SetResponseHeaders function has been added.
HttpRequestProperties
The HttpRequestProperties type has been renamed to HTTPRequestProperties. The related constructor functions have also been renamed:
- NewAwsHealthCheckHttpRequestProperties → NewAwsHealthCheckHTTPRequestProperties
- NewOpenShiftHealthCheckHttpRequestProperties → NewOpenShiftHealthCheckHTTPRequestProperties
- NewStandardHealthCheckHttpRequestProperties → NewStandardHealthCheckHTTPRequestProperties
HttpResponse
The HttpResponse type has been renamed to HTTPResponse. The related constructor and log functions have also been renamed:
-
NewHttpResponse → NewHTTPResponse
-
NewErrorHttpResponse → NewErrorHTTPResponse
-
NewErrorJsonHttpResponse → NewJSONErrorHTTPResponse
-
SendHttpResponse → SendHTTPResponse
-
HttpResponseSuccess → HTTPResponseSuccess
-
HttpResponseSuccessMessage → HTTPResponseSuccessMessage
-
HttpResponseSuccessStatusMessage → HTTPResponseSuccessStatusMessage
-
HttpResponseSuccessJSON → HTTPResponseSuccessJSON
-
HttpResponseSuccessStatusJSON → HTTPResponseSuccessStatusJSON
-
HttpResponseSuccessBytes → HTTPResponseSuccessBytes
-
HttpResponseSuccessStatusBytes → HTTPResponseSuccessStatusBytes
-
HttpResponseError → HTTPResponseError
-
HttpResponseSuccessAction → HTTPResponseSuccessAction
-
HttpResponseSuccessStatusAction → HTTPResponseSuccessStatusAction
-
HttpResponseErrorAction → HTTPResponseErrorAction
-
HttpResponseErrorData → HTTPResponseErrorData
LoggerOpts.JsonFmt
The JsonFmt field in LoggerOpts has been renamed to JSONFmt.