forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
factory.go
108 lines (93 loc) · 3.18 KB
/
factory.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
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package snmpreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver"
import (
"context"
"errors"
"fmt"
"net/url"
"strings"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/scraperhelper"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snmpreceiver/internal/metadata"
)
var errConfigNotSNMP = errors.New("config was not a SNMP receiver config")
// NewFactory creates a new receiver factory for SNMP
func NewFactory() receiver.Factory {
return receiver.NewFactory(
metadata.Type,
createDefaultConfig,
receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
}
// createDefaultConfig creates a config for SNMP with as many default values as possible
func createDefaultConfig() component.Config {
return &Config{
ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
CollectionInterval: defaultCollectionInterval,
Timeout: defaultTimeout,
},
Endpoint: defaultEndpoint,
Version: defaultVersion,
Community: defaultCommunity,
SecurityLevel: defaultSecurityLevel,
AuthType: defaultAuthType,
PrivacyType: defaultPrivacyType,
}
}
// createMetricsReceiver creates the metric receiver for SNMP
func createMetricsReceiver(
_ context.Context,
params receiver.CreateSettings,
config component.Config,
consumer consumer.Metrics,
) (receiver.Metrics, error) {
snmpConfig, ok := config.(*Config)
if !ok {
return nil, errConfigNotSNMP
}
if err := addMissingConfigDefaults(snmpConfig); err != nil {
return nil, fmt.Errorf("failed to validate added config defaults: %w", err)
}
snmpScraper := newScraper(params.Logger, snmpConfig, params)
scraper, err := scraperhelper.NewScraper(metadata.Type, snmpScraper.scrape, scraperhelper.WithStart(snmpScraper.start))
if err != nil {
return nil, err
}
return scraperhelper.NewScraperControllerReceiver(&snmpConfig.ScraperControllerSettings, params, consumer, scraperhelper.AddScraper(scraper))
}
// addMissingConfigDefaults adds any missing config parameters that have defaults
func addMissingConfigDefaults(cfg *Config) error {
// Add the schema prefix to the endpoint if it doesn't contain one
if !strings.Contains(cfg.Endpoint, ":https://") {
cfg.Endpoint = "udp:https://" + cfg.Endpoint
}
// Add default port to endpoint if it doesn't contain one
u, err := url.Parse(cfg.Endpoint)
if err == nil && u.Port() == "" {
portSuffix := "161"
if cfg.Endpoint[len(cfg.Endpoint)-1:] != ":" {
portSuffix = ":" + portSuffix
}
cfg.Endpoint += portSuffix
}
// Set defaults for metric configs
for _, metricCfg := range cfg.Metrics {
if metricCfg.Unit == "" {
metricCfg.Unit = "1"
}
if metricCfg.Gauge != nil && metricCfg.Gauge.ValueType == "" {
metricCfg.Gauge.ValueType = "double"
}
if metricCfg.Sum != nil {
if metricCfg.Sum.ValueType == "" {
metricCfg.Sum.ValueType = "double"
}
if metricCfg.Sum.Aggregation == "" {
metricCfg.Sum.Aggregation = "cumulative"
}
}
}
return component.ValidateConfig(cfg)
}