-
Notifications
You must be signed in to change notification settings - Fork 106
/
outputelastic.go
210 lines (177 loc) · 6.97 KB
/
outputelastic.go
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
package outputelastic
import (
"context"
"crypto/tls"
"net/http"
"strings"
"time"
jsoniter "github.com/json-iterator/go"
"github.com/olivere/elastic/v7"
"github.com/sirupsen/logrus"
"github.com/tsaikd/KDGoLib/errutil"
"github.com/tsaikd/gogstash/config"
"github.com/tsaikd/gogstash/config/goglog"
"github.com/tsaikd/gogstash/config/logevent"
)
// ModuleName is the name used in config file
const ModuleName = "elastic"
// OutputConfig holds the configuration json fields and internal objects
type OutputConfig struct {
config.OutputConfig
URL []string `json:"url"` // elastic API entrypoints
resolvedURLs []string // URLs after resolving environment vars
Index string `json:"index"` // index name to log
DocumentType string `json:"document_type"` // type name to log
DocumentID string `json:"document_id"` // id to log, used if you want to control id format
RetryOnConflict int `json:"retry_on_conflict"` // the number of times Elasticsearch should internally retry an update/upserted document
Username string `json:"username"` // basic auth username to Elasticsearch
Password string `json:"password"` // basic auth password to Elasticsearch
SimpleClient bool `json:"simple_client"` // if set uses simpleclient instead of newclient, disables some functionality
Sniff bool `json:"sniff"` // find all nodes of your cluster, https://github.com/olivere/elastic/wiki/Sniffing
// BulkActions specifies when to flush based on the number of actions
// currently added. Defaults to 1000 and can be set to -1 to be disabled.
BulkActions int `json:"bulk_actions,omitempty"`
// BulkSize specifies when to flush based on the size (in bytes) of the actions
// currently added. Defaults to 5 MB and can be set to -1 to be disabled.
BulkSize int `json:"bulk_size,omitempty"`
// BulkFlushInterval specifies when to flush at the end of the given interval.
// Defaults to 30 seconds. If you want the bulk processor to
// operate completely asynchronously, set both BulkActions and BulkSize to
// -1 and set the FlushInterval to a meaningful interval.
BulkFlushInterval time.Duration `json:"bulk_flush_interval"`
// ExponentialBackoffInitialTimeout used to set the first/minimal interval in elastic.ExponentialBackoff
// Defaults to 10s
ExponentialBackoffInitialTimeout string `json:"exponential_backoff_initial_timeout,omitempty"`
exponentialBackoffInitialTimeout time.Duration
// ExponentialBackoffMaxTimeout used to set the maximum wait interval in elastic.ExponentialBackoff
// Defaults to 5m
ExponentialBackoffMaxTimeout string `json:"exponential_backoff_max_timeout,omitempty"`
exponentialBackoffMaxTimeout time.Duration
// SSLCertValidation Option to validate the server's certificate. Disabling this severely compromises security.
// For more information on disabling certificate verification please read https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf
SSLCertValidation bool `json:"ssl_certificate_validation,omitempty"`
client *elastic.Client // elastic client instance
processor *elastic.BulkProcessor // elastic bulk processor
}
// DefaultOutputConfig returns an OutputConfig struct with default values
func DefaultOutputConfig() OutputConfig {
return OutputConfig{
OutputConfig: config.OutputConfig{
CommonConfig: config.CommonConfig{
Type: ModuleName,
},
},
RetryOnConflict: 1,
BulkActions: 1000, // 1000 actions
BulkSize: 5 << 20, // 5 MB
BulkFlushInterval: 30 * time.Second,
ExponentialBackoffInitialTimeout: "10s",
ExponentialBackoffMaxTimeout: "5m",
SSLCertValidation: true,
}
}
// errors
var (
ErrorCreateClientFailed1 = errutil.NewFactory("create elastic client failed: %q")
)
type errorLogger struct {
logger logrus.FieldLogger
}
// Printf log format string to error level
func (l *errorLogger) Printf(format string, args ...any) {
l.logger.Errorf(format, args...)
}
type jsonDecoder struct{}
// Decode decodes with jsoniter.Unmarshal
func (u *jsonDecoder) Decode(data []byte, v any) error {
return jsoniter.Unmarshal(data, v)
}
// InitHandler initialize the output plugin
func InitHandler(
ctx context.Context,
raw config.ConfigRaw,
control config.Control,
) (config.TypeOutputConfig, error) {
conf := DefaultOutputConfig()
err := config.ReflectConfig(raw, &conf)
if err != nil {
return nil, err
}
// map Printf to error level
logger := &errorLogger{logger: goglog.Logger}
// replace env var names with values on URL config
for _, url := range conf.URL {
newURL := logevent.FormatWithEnv(url)
conf.resolvedURLs = append(conf.resolvedURLs, newURL)
}
options := []elastic.ClientOptionFunc{
elastic.SetURL(conf.resolvedURLs...),
elastic.SetSniff(conf.Sniff),
elastic.SetErrorLog(logger),
elastic.SetBasicAuth(conf.Username, conf.Password),
elastic.SetDecoder(&jsonDecoder{}),
}
// set httpclient explicitly if we need to avoid https cert checks
if !conf.SSLCertValidation {
tr := &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
}
client := &http.Client{Transport: tr}
options = append(options, elastic.SetHttpClient(client))
}
if conf.SimpleClient {
conf.client, err = elastic.NewSimpleClient(options...)
} else {
conf.client, err = elastic.NewClient(options...)
}
if err != nil {
return nil, ErrorCreateClientFailed1.New(err, conf.URL)
}
conf.exponentialBackoffInitialTimeout, err = time.ParseDuration(conf.ExponentialBackoffInitialTimeout)
if err != nil {
return nil, err
}
conf.exponentialBackoffMaxTimeout, err = time.ParseDuration(conf.ExponentialBackoffMaxTimeout)
if err != nil {
return nil, err
}
conf.processor, err = conf.client.BulkProcessor().
Name("gogstash-output-elastic").
BulkActions(conf.BulkActions).
BulkSize(conf.BulkSize).
FlushInterval(conf.BulkFlushInterval).
Backoff(elastic.NewExponentialBackoff(conf.exponentialBackoffInitialTimeout, conf.exponentialBackoffMaxTimeout)).
After(conf.BulkAfter).
Do(ctx)
if err != nil {
return nil, err
}
return &conf, nil
}
// BulkAfter execute after a commit to Elasticsearch
func (t *OutputConfig) BulkAfter(executionID int64, requests []elastic.BulkableRequest, response *elastic.BulkResponse, err error) {
if err == nil && response.Errors {
// find failed requests, and log it
for i, item := range response.Items {
for _, v := range item {
if v.Error != nil {
goglog.Logger.Errorf("%s: bulk processor request %s failed: %s", ModuleName, requests[i].String(), v.Error.Reason)
}
}
}
}
}
// Output event
func (t *OutputConfig) Output(ctx context.Context, event logevent.LogEvent) (err error) {
index := event.Format(t.Index)
// elastic index name should be lowercase
index = strings.ToLower(index)
id := event.Format(t.DocumentID)
indexRequest := elastic.NewBulkIndexRequest().
Index(index).
RetryOnConflict(t.RetryOnConflict).
Id(id).
Doc(event)
t.processor.Add(indexRequest)
return
}