-
Notifications
You must be signed in to change notification settings - Fork 35
/
config.go
92 lines (78 loc) · 2.84 KB
/
config.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
// Copyright 2023, OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package syslogexporter
import (
"errors"
"strings"
"github.com/THREATINT/go-net"
"go.opentelemetry.io/collector/config/configretry"
"go.opentelemetry.io/collector/config/configtls"
"go.opentelemetry.io/collector/exporter/exporterhelper"
"go.uber.org/multierr"
)
var (
errUnsupportedPort = errors.New("unsupported port: port is required, must be in the range 1-65535")
errInvalidEndpoint = errors.New("invalid endpoint: endpoint is required, must be a valid FQDN or IP address")
errUnsupportedProtocol = errors.New("unsupported protocol: protocol is required, only tcp/udp supported")
errUnsupportedFormat = errors.New("unsupported format: Only rfc5424 and rfc3164 supported")
)
// Config defines configuration for Syslog exporter.
type Config struct {
// Syslog server address
Endpoint string `mapstructure:"endpoint"`
// Syslog server port
Port int `mapstructure:"port"`
// Protocol for syslog communication
// options: tcp, udp
Protocol string `mapstructure:"protocol"`
// Format of syslog messages
Format string `mapstructure:"format"`
// TLSSetting struct exposes TLS client configuration.
TLSSetting configtls.ClientConfig `mapstructure:"tls"`
exporterhelper.QueueSettings `mapstructure:"sending_queue"`
configretry.BackOffConfig `mapstructure:"retry_on_failure"`
}
// Validate the configuration for errors. This is required by component.Config.
func (cfg *Config) Validate() error {
invalidFields := []error{}
if cfg.Port < 1 || cfg.Port > 65525 {
invalidFields = append(invalidFields, errUnsupportedPort)
}
if !net.IsFQDN(cfg.Endpoint) && !net.IsIPAddr(cfg.Endpoint) && cfg.Endpoint != "localhost" {
invalidFields = append(invalidFields, errInvalidEndpoint)
}
if strings.ToLower(cfg.Protocol) != "tcp" && strings.ToLower(cfg.Protocol) != "udp" {
invalidFields = append(invalidFields, errUnsupportedProtocol)
}
switch cfg.Format {
case formatRFC3164Str:
case formatRFC5424Str:
default:
invalidFields = append(invalidFields, errUnsupportedFormat)
}
if len(invalidFields) > 0 {
return multierr.Combine(invalidFields...)
}
return nil
}
const (
// Syslog Protocol
DefaultProtocol = "tcp"
// Syslog Port
DefaultPort = 514
// Syslog Endpoint
DefaultEndpoint = "host.domain.com"
// Syslog format
DefaultFormat = "rfc5424"
)