summaryrefslogtreecommitdiff
path: root/internal/clients/tailclient.go
blob: 9f208a29c8de432b4543f50edad302f3483cb75f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package clients

import (
	"github.com/mimecast/dtail/internal/config"
	"github.com/mimecast/dtail/internal/omode"
)

// TailClient provides distributed log file tailing functionality, continuously
// monitoring remote log files and streaming new content as it appears. Unlike
// traditional tail implementations, TailClient can monitor multiple files across
// multiple servers simultaneously, aggregating the results in real-time.
//
// Key features:
// - Continuous monitoring of log files across multiple servers
// - Real-time streaming of new content only (seeks to end of files)
// - Automatic connection retry for long-running operations
// - Regex-based line filtering with normal and inverted matching
// - Graceful handling of log rotation and file recreation
//
// TailClient embeds CommonClient to inherit standard connection management,
// SSH authentication, and command generation capabilities.
type TailClient struct {
	CommonClient
}

// NewTailClient creates a new TailClient configured for distributed log tailing.
// This constructor sets up the client for continuous monitoring operations with
// automatic retry enabled for long-running tail operations.
//
// Parameters:
//   args: Complete configuration arguments including servers, files, and options
//
// Returns:
//   *TailClient: Configured client ready to start tailing operations
//   error: Configuration or initialization error, if any
//
// Configuration:
// - Sets operating mode to TailClient
// - Enables automatic connection retry for continuous operation
// - Initializes regex compilation and SSH authentication
// - Establishes connections to all discovered servers
//
// The returned client is fully initialized and ready to call Start().
func NewTailClient(args config.Args) (*TailClient, error) {
	args.Mode = omode.TailClient
	c := TailClient{
		CommonClient: NewCommonClient(args, true),
	}

	c.init()
	c.makeConnections(c)
	return &c, nil
}