README
¶
Structured log syslog
Go structured log syslog handler.
Requirements
- Go >= 1.21
Usage
package main
import (
"log"
"log/slog"
slogsyslog "github.com/mocheryl/slog-syslog"
)
func main() {
h, err := slogsyslog.New(nil)
if err != nil {
log.Fatalf("Could not initialize syslog slog handler: %s\n", err)
return
}
l := slog.New(h)
slog.SetDefault(l)
slog.Info("Hello, World!")
// Output: Jun 29 08:44:16 localhost helloworld[1234]: Hello, World!
h.Close()
}
Credits
Most of the code and ideas taken from the following projects:
- Structured log text handler from the standard library.
- Syslog client from the standard library.
- RackSpace Managed Security Development srslog.
- HashiCorp go-syslog.
Contributing
Any contributions are welcome - see the CONTRIBUTING.md file for details.
License
This project is licensed under the 3-clause BSD license - see the LICENSE file for details.
Documentation
¶
Overview ¶
Package slogsyslog implements log/slog.Handler for syslog server.
Index ¶
- type Facility
- type Options
- type SyslogHandler
- func (s *SyslogHandler) Close() error
- func (s *SyslogHandler) Enabled(ctx context.Context, level slog.Level) bool
- func (s *SyslogHandler) Handle(ctx context.Context, r slog.Record) error
- func (s *SyslogHandler) WithAttrs(attrs []slog.Attr) slog.Handler
- func (s *SyslogHandler) WithGroup(name string) slog.Handler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Facility ¶
type Facility int
Facility is the log facility.
type Options ¶
type Options struct {
// AddSource, causes the handler to compute the source code position of the
// log statement and add it as a prefix to the message.
AddSource bool
// Level is the level at which we log at.
Level slog.Leveler
// Network protocol to use when connecting to a syslog server.
Network string
// Address of the syslog server.
Address string
// DialTimeout is duration after which connecting to a syslog server
// timeouts.
DialTimeout time.Duration
// WriteTimeout is duration after which writing to a syslog server timeouts.
WriteTimeout time.Duration
// Facility with which we are logging.
Facility Facility
// Tag with which we are logging.
Tag string
}
Options sets the syslog logging options.
type SyslogHandler ¶
type SyslogHandler struct {
// contains filtered or unexported fields
}
SyslogHandler is a structured log log/slog.Handler implementation that writes messages to a syslog server.
func New ¶
func New(opts *Options) (*SyslogHandler, error)
New creates a new syslog slog log/slog.Handler. By default it will log at log/slog.LevelInfo level to a UNIX datagram socket located at /dev/log.
func (*SyslogHandler) Close ¶
func (s *SyslogHandler) Close() error
Source Files
Click to show internal directories.
Click to hide internal directories.