Documentation
¶
Overview ¶
Package streamlog provides a non-blocking message broadcaster.
Index ¶
- Constants
- func GetQueryLogFormat() string
- func GetRedactDebugUIQueries() bool
- func SetQueryLogFilterTag(newQueryLogFilterTag string)
- func SetQueryLogFormat(newQueryLogFormat string)
- func SetQueryLogRowThreshold(newQueryLogRowThreshold uint64)
- func SetRedactDebugUIQueries(newRedactDebugUIQueries bool)
- func ShouldEmitLog(sql string, rowsAffected, rowsReturned uint64) bool
- type Formatter
- type LogFormatter
- type StreamLogger
- func (logger *StreamLogger[T]) LogToFile(path string, logf LogFormatter) (chan T, error)
- func (logger *StreamLogger[T]) Name() string
- func (logger *StreamLogger[T]) Send(message T)
- func (logger *StreamLogger[T]) ServeLogs(url string, logf LogFormatter)
- func (logger *StreamLogger[T]) Subscribe(name string) chan T
- func (logger *StreamLogger[T]) Unsubscribe(ch chan T)
Constants ¶
const ( // QueryLogFormatText is the format specifier for text querylog output QueryLogFormatText = "text" // QueryLogFormatJSON is the format specifier for json querylog output QueryLogFormatJSON = "json" )
Variables ¶
This section is empty.
Functions ¶
func GetQueryLogFormat ¶ added in v0.15.0
func GetQueryLogFormat() string
func GetRedactDebugUIQueries ¶ added in v0.15.0
func GetRedactDebugUIQueries() bool
func SetQueryLogFilterTag ¶ added in v0.15.0
func SetQueryLogFilterTag(newQueryLogFilterTag string)
func SetQueryLogFormat ¶ added in v0.15.0
func SetQueryLogFormat(newQueryLogFormat string)
func SetQueryLogRowThreshold ¶ added in v0.15.0
func SetQueryLogRowThreshold(newQueryLogRowThreshold uint64)
func SetRedactDebugUIQueries ¶ added in v0.15.0
func SetRedactDebugUIQueries(newRedactDebugUIQueries bool)
func ShouldEmitLog ¶
ShouldEmitLog returns whether the log with the given SQL query should be emitted or filtered
Types ¶
type Formatter ¶
Formatter is a simple interface for objects that expose a Format function as needed for streamlog.
type LogFormatter ¶
LogFormatter is the function signature used to format an arbitrary message for the given output writer.
func GetFormatter ¶
func GetFormatter[T any](logger *StreamLogger[T]) LogFormatter
GetFormatter returns a formatter function for objects conforming to the Formatter interface
type StreamLogger ¶
type StreamLogger[T any] struct { // contains filtered or unexported fields }
StreamLogger is a non-blocking broadcaster of messages. Subscribers can use channels or HTTP.
func New ¶
func New[T any](name string, size int) *StreamLogger[T]
New returns a new StreamLogger that can stream events to subscribers. The size parameter defines the channel size for the subscribers.
func (*StreamLogger[T]) LogToFile ¶
func (logger *StreamLogger[T]) LogToFile(path string, logf LogFormatter) (chan T, error)
LogToFile starts logging to the specified file path and will reopen the file in response to SIGUSR2.
Returns the channel used for the subscription which can be used to close it.
func (*StreamLogger[T]) Name ¶
func (logger *StreamLogger[T]) Name() string
Name returns the name of StreamLogger.
func (*StreamLogger[T]) Send ¶
func (logger *StreamLogger[T]) Send(message T)
Send sends message to all the writers subscribed to logger. Calling Send does not block.
func (*StreamLogger[T]) ServeLogs ¶
func (logger *StreamLogger[T]) ServeLogs(url string, logf LogFormatter)
ServeLogs registers the URL on which messages will be broadcast. It is safe to register multiple URLs for the same StreamLogger.
func (*StreamLogger[T]) Subscribe ¶
func (logger *StreamLogger[T]) Subscribe(name string) chan T
Subscribe returns a channel which can be used to listen for messages.
func (*StreamLogger[T]) Unsubscribe ¶
func (logger *StreamLogger[T]) Unsubscribe(ch chan T)
Unsubscribe removes the channel from the subscription.
Source Files