mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
11dbb1b277
# Which Problems Are Solved Streams allow differentiating logs produced by different components of Zitadel. # How the Problems Are Solved The `backend/v3/instrumentation/logging` package now exposes convenience function for setting and getting a logger from the context. As well as high-level functions to emit log records at various levels. When constructing a new logger a "stream" needs to be specified: - **runtime**: General runtime logs, such as startup and shutdown messages. Default for logs that do not belong to the other categories. - **request**: Logs for incoming API and HTTP requests. - **event_handler**: Logs for event handling in projections. - **queue**: Logs for the job queue processing. - **event_pusher**: Logs for event pushing to the database. Disabled by default, contains sensitive information. Each line from the returned logger contains a `stream` field as well as a `version` field with the current Zitadel version. ## Runtime config Streams can be enabled by passing an array of stream names in the runtime config. Because some log streams may contain sensitive data (especially events), it is now also possible to mask values by their key. # Additional Changes - Wrap `slogctx` in the `logging` package. (Except API error converter packages, because of import cycle) - Add some docs to `logging` package so other devs understand how to add logging to Zitadel - Add `logging.OnError` and `logging.WithError` helper functions with `Panic()` and `Fatal()` methods, to preserve current calls in the `cmd` packages. - Add instance context extractor. - Only output request details in the request info log. Request ID remains propagated through context. - Moved middleware functionality into protocol specific packages. - Removed setting of URI to context in metric middleware. There were ony setters and no getters. (Unused value) - Reuse a single statusWriter in the middleware package for middlewares that need to know the response status. # Additional Context - Closes #11333 - Closes #11331 - Partly #11330 --------- Co-authored-by: Silvan <[email protected]>
107 lines
2.9 KiB
Go
107 lines
2.9 KiB
Go
// Code generated by "enumer -type=Stream -trimprefix=Stream -transform=snake -text"; DO NOT EDIT.
|
|
|
|
package instrumentation
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
const _StreamName = "runtimereadyrequestevent_pusherevent_handlerqueue"
|
|
|
|
var _StreamIndex = [...]uint8{0, 7, 12, 19, 31, 44, 49}
|
|
|
|
const _StreamLowerName = "runtimereadyrequestevent_pusherevent_handlerqueue"
|
|
|
|
func (i Stream) String() string {
|
|
if i < 0 || i >= Stream(len(_StreamIndex)-1) {
|
|
return fmt.Sprintf("Stream(%d)", i)
|
|
}
|
|
return _StreamName[_StreamIndex[i]:_StreamIndex[i+1]]
|
|
}
|
|
|
|
// An "invalid array index" compiler error signifies that the constant values have changed.
|
|
// Re-run the stringer command to generate them again.
|
|
func _StreamNoOp() {
|
|
var x [1]struct{}
|
|
_ = x[StreamRuntime-(0)]
|
|
_ = x[StreamReady-(1)]
|
|
_ = x[StreamRequest-(2)]
|
|
_ = x[StreamEventPusher-(3)]
|
|
_ = x[StreamEventHandler-(4)]
|
|
_ = x[StreamQueue-(5)]
|
|
}
|
|
|
|
var _StreamValues = []Stream{StreamRuntime, StreamReady, StreamRequest, StreamEventPusher, StreamEventHandler, StreamQueue}
|
|
|
|
var _StreamNameToValueMap = map[string]Stream{
|
|
_StreamName[0:7]: StreamRuntime,
|
|
_StreamLowerName[0:7]: StreamRuntime,
|
|
_StreamName[7:12]: StreamReady,
|
|
_StreamLowerName[7:12]: StreamReady,
|
|
_StreamName[12:19]: StreamRequest,
|
|
_StreamLowerName[12:19]: StreamRequest,
|
|
_StreamName[19:31]: StreamEventPusher,
|
|
_StreamLowerName[19:31]: StreamEventPusher,
|
|
_StreamName[31:44]: StreamEventHandler,
|
|
_StreamLowerName[31:44]: StreamEventHandler,
|
|
_StreamName[44:49]: StreamQueue,
|
|
_StreamLowerName[44:49]: StreamQueue,
|
|
}
|
|
|
|
var _StreamNames = []string{
|
|
_StreamName[0:7],
|
|
_StreamName[7:12],
|
|
_StreamName[12:19],
|
|
_StreamName[19:31],
|
|
_StreamName[31:44],
|
|
_StreamName[44:49],
|
|
}
|
|
|
|
// StreamString retrieves an enum value from the enum constants string name.
|
|
// Throws an error if the param is not part of the enum.
|
|
func StreamString(s string) (Stream, error) {
|
|
if val, ok := _StreamNameToValueMap[s]; ok {
|
|
return val, nil
|
|
}
|
|
|
|
if val, ok := _StreamNameToValueMap[strings.ToLower(s)]; ok {
|
|
return val, nil
|
|
}
|
|
return 0, fmt.Errorf("%s does not belong to Stream values", s)
|
|
}
|
|
|
|
// StreamValues returns all values of the enum
|
|
func StreamValues() []Stream {
|
|
return _StreamValues
|
|
}
|
|
|
|
// StreamStrings returns a slice of all String values of the enum
|
|
func StreamStrings() []string {
|
|
strs := make([]string, len(_StreamNames))
|
|
copy(strs, _StreamNames)
|
|
return strs
|
|
}
|
|
|
|
// IsAStream returns "true" if the value is listed in the enum definition. "false" otherwise
|
|
func (i Stream) IsAStream() bool {
|
|
for _, v := range _StreamValues {
|
|
if i == v {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// MarshalText implements the encoding.TextMarshaler interface for Stream
|
|
func (i Stream) MarshalText() ([]byte, error) {
|
|
return []byte(i.String()), nil
|
|
}
|
|
|
|
// UnmarshalText implements the encoding.TextUnmarshaler interface for Stream
|
|
func (i *Stream) UnmarshalText(text []byte) error {
|
|
var err error
|
|
*i, err = StreamString(string(text))
|
|
return err
|
|
}
|