README
¶
go-syslog 
Syslog server library for go, build easy your custom syslog server over UDP, TCP or Unix sockets using RFC3164, RFC6587 or RFC5424
Installation
The recommended way to install go-syslog
go get gopkg.in/mcuadros/go-syslog.v2
Examples
How import the package
import "gopkg.in/mcuadros/go-syslog.v2"
Example of a basic syslog UDP server:
channel := make(syslog.LogPartsChannel)
handler := syslog.NewChannelHandler(channel)
server := syslog.NewServer()
server.SetFormat(syslog.RFC5424)
server.SetHandler(handler)
server.ListenUDP("0.0.0.0:514")
server.Boot()
go func(channel syslog.LogPartsChannel) {
for logParts := range channel {
fmt.Println(logParts)
}
}(channel)
server.Wait()
License
MIT, see LICENSE
Documentation
¶
Overview ¶
Syslog server library for go, build easy your custom syslog server over UDP, TCP or Unix sockets using RFC3164, RFC5424 and RFC6587
Index ¶
- Variables
- type ChannelHandler
- type DatagramMessage
- type Handler
- type LogPartsChannel
- type ScanCloser
- type Server
- func (s *Server) Boot() error
- func (s *Server) GetLastError() error
- func (s *Server) Kill() error
- func (s *Server) ListenTCP(addr string) error
- func (s *Server) ListenTCPTLS(addr string, config *tls.Config) error
- func (s *Server) ListenUDP(addr string) error
- func (s *Server) ListenUnixgram(addr string) error
- func (s *Server) SetFormat(f format.Format)
- func (s *Server) SetHandler(handler Handler)
- func (s *Server) SetTimeout(millseconds int64)
- func (s *Server) SetTlsPeerNameFunc(tlsPeerNameFunc TlsPeerNameFunc)
- func (s *Server) Wait()
- type TimeoutCloser
- type TlsPeerNameFunc
Constants ¶
This section is empty.
Variables ¶
var ( RFC3164 = &format.RFC3164{} // RFC3164: http://www.ietf.org/rfc/rfc3164.txt RFC5424 = &format.RFC5424{} // RFC5424: http://www.ietf.org/rfc/rfc5424.txt RFC6587 = &format.RFC6587{} // RFC6587: http://www.ietf.org/rfc/rfc6587.txt - octet counting variant Automatic = &format.Automatic{} // Automatically identify the format )
Functions ¶
This section is empty.
Types ¶
type ChannelHandler ¶
type ChannelHandler struct {
// contains filtered or unexported fields
}
The ChannelHandler will send all the syslog entries into the given channel
func NewChannelHandler ¶
func NewChannelHandler(channel LogPartsChannel) *ChannelHandler
NewChannelHandler returns a new ChannelHandler
func (*ChannelHandler) Handle ¶
func (h *ChannelHandler) Handle(logParts format.LogParts, messageLength int64, err error)
Syslog entry receiver
func (*ChannelHandler) SetChannel ¶
func (h *ChannelHandler) SetChannel(channel LogPartsChannel)
The channel to be used
type DatagramMessage ¶ added in v2.1.0
type DatagramMessage struct {
// contains filtered or unexported fields
}
type LogPartsChannel ¶
type ScanCloser ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) ListenTCPTLS ¶ added in v2.1.1
Configure the server for listen on a TCP addr for TLS
func (*Server) ListenUnixgram ¶
Configure the server for listen on an unix socket
func (*Server) SetHandler ¶
Sets the handler, this handler with receive every syslog entry
func (*Server) SetTimeout ¶
Sets the connection timeout for TCP connections, in milliseconds
func (*Server) SetTlsPeerNameFunc ¶ added in v2.1.1
func (s *Server) SetTlsPeerNameFunc(tlsPeerNameFunc TlsPeerNameFunc)
Set the function that extracts a TLS peer name from the TLS connection
Source Files
Directories