README
¶
Documentation
¶
Overview ¶
Package logplexc provides Logplex clients that can be linked into other Go programs.
Most users will want to use logplexc.Client, which implements a concurrent client, including periodic flushing, dropping, statistics accumulation, and request-level parallelism. logplexc.Client is built with logplexc.MiniClient.
To use the client, call NewClient with a configuration structure:
cfg := logplexc.Config{
Logplex: "https://t:123@my.logplex.example.com",
HttpClient: client,
RequestSizeTrigger: 100 * KB,
Concurrency: 3,
Period: 3 * time.Second,
}
c, err := logplexc.NewClient(&cfg)
defer c.Close()
// Messages will be periodically flushed.
c.BufferMessage(...)
Those with advanced needs will want to use the low level logplexc.MiniClient, which implements log formatting, buffering, and HTTP POSTing.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bundle ¶
type Bundle struct {
MiniStats
// contains filtered or unexported fields
}
Bundle represents bundle of log messages. Bundles are used to act as buffers of multiple log records as well as the unit of work for submittted to Logplex.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a Logplex embeddable client implementation that includes concurrency, dropping, and statistics gathering.
func (*Client) BufferMessage ¶
func (*Client) Statistics ¶
type Config ¶
type Config struct {
Logplex url.URL
HTTPClient http.Client
RequestSizeTrigger int
Concurrency int
Period time.Duration
// Optional: Can be set for advanced behaviors like triggering
// Never or Immediately.
TimeTrigger TimeTriggerBehavior
}
Config represents a Client configuration
type MiniClient ¶
type MiniClient struct {
// Configuration that should not be mutated after creation
MiniConfig
// contains filtered or unexported fields
}
MiniClient implements a low-level, synchronous Logplex client. It can format messages and gather statistics. Most uses of logplexc are anticipated to use logplexc.Client.
func NewMiniClient ¶
func NewMiniClient(cfg *MiniConfig) (client *MiniClient, err error)
NewMiniClient creates a new MiniClient based on a the given config.
func (*MiniClient) BufferMessage ¶
func (c *MiniClient) BufferMessage( priority int, when time.Time, host string, procID string, log []byte) MiniStats
BufferMessage buffers a message for best-effort delivery to Logplex.
Return the critical statistics on what has been buffered so far so that the caller can opt to PostMessages() and empty the buffer.
No effort is expended to clean up bad bytes disallowed by syslog, as Logplex has a length-prefixed format.
func (*MiniClient) Post ¶
func (c *MiniClient) Post(b *Bundle) (*http.Response, error)
Post sends a Bundle of logs to Logplex via HTTP POST.
func (*MiniClient) Statistics ¶
func (c *MiniClient) Statistics() MiniStats
Statistics copies the statistics structure embedded in the client.
func (*MiniClient) SwapBundle ¶
func (c *MiniClient) SwapBundle() Bundle
SwapBundle swaps out the bundle of logs for a fresh one, so that buffering can continue again immediately. It's the caller's perogative to submit the returned, completed Bundle to logplex.
type MiniConfig ¶
type MiniConfig struct {
// The configuration is by-value to prevent most kinds of accidental
// sharing of modifications between clients. Also, modification of
// the URL is compulsary in the constructor, and it's not desirable to
// modify the version passed by the user as a side effect of
// constructing a client instance.
Logplex url.URL
HTTPClient http.Client
}
MiniConfig represents configuration of a MiniClient.
type Stats ¶
type Stats struct {
// Number of concurrent requests at the time of retrieval.
Concurrency int32
// Total messages submitted
Total uint64
// Incremented when a message is ignored outright because of
// too much work being done already.
Dropped uint64
// Incremented when a log post request is not known to have
// succeeded and one has given up waiting.
Cancelled uint64
// Incremented when a log post request is responded to,
// affirming that the messages have been rejected.
Rejected uint64
// Incremented only when a positive response is received from
// logplex.
Successful uint64
TotalRequests uint64
DroppedRequests uint64
CancelRequests uint64
RejectRequests uint64
SuccessRequests uint64
}
type TimeTriggerBehavior ¶
type TimeTriggerBehavior byte
const ( // Carefully choose the zero-value so it is a reasonable // default, so that a user requesting the other behaviors -- // which do not need a time -- can write things like: // TimeTrigger{Behavior: TimeTriggerImmediate} without // specifying a Period. TimeTriggerPeriodic TimeTriggerBehavior = iota TimeTriggerImmediate TimeTriggerNever )
Source Files