CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(inputs.fritzbox): Fix linter issues (#16664)

This commit is contained in:
Maya Strandboge 2025-03-20 05:05:39 -05:00 committed by GitHub
parent ceeb291e15
commit 0a8cbed073
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
plugins/inputs/fritzbox/fritzbox.go
View File

@ -70,12 +70,12 @@ func (f *Fritzbox) Init() error {
// Initialize the device clients // Initialize the device clients
debug := f.Log.Level().Includes(telegraf.Trace) debug := f.Log.Level().Includes(telegraf.Trace)
f.deviceClients = make([]*tr064.Client, 0, len(f.URLs)) f.deviceClients = make([]*tr064.Client, 0, len(f.URLs))
for _, rawUrl := range f.URLs { for _, rawURL := range f.URLs {
parsedUrl, err := url.Parse(rawUrl) parsedURL, err := url.Parse(rawURL)
if err != nil { if err != nil {
return fmt.Errorf("parsing device URL %q failed: %w", rawUrl, err) return fmt.Errorf("parsing device URL %q failed: %w", rawURL, err)
} }
client := tr064.NewClient(parsedUrl) client := tr064.NewClient(parsedURL)
client.Debug = debug client.Debug = debug
client.Timeout = time.Duration(f.Timeout) client.Timeout = time.Duration(f.Timeout)
client.TlsConfig = tlsConfig client.TlsConfig = tlsConfig
@ -87,17 +87,17 @@ func (f *Fritzbox) Init() error {
for _, c := range f.Collect { for _, c := range f.Collect {
switch c { switch c {
case "device": case "device":
f.serviceHandlers[deviceinfo.ServiceShortType] = f.gatherDeviceInfo f.serviceHandlers[deviceinfo.ServiceShortType] = gatherDeviceInfo
case "wan": case "wan":
f.serviceHandlers[wancommonifconfig.ServiceShortType] = f.gatherWanInfo f.serviceHandlers[wancommonifconfig.ServiceShortType] = gatherWanInfo
case "ppp": case "ppp":
f.serviceHandlers[wanpppconn.ServiceShortType] = f.gatherPppInfo f.serviceHandlers[wanpppconn.ServiceShortType] = gatherPppInfo
case "dsl": case "dsl":
f.serviceHandlers[wandslifconfig.ServiceShortType] = f.gatherDslInfo f.serviceHandlers[wandslifconfig.ServiceShortType] = gatherDslInfo
case "wlan": case "wlan":
f.serviceHandlers[wlanconfig.ServiceShortType] = f.gatherWlanInfo f.serviceHandlers[wlanconfig.ServiceShortType] = gatherWlanInfo
case "hosts": case "hosts":
f.serviceHandlers[hosts.ServiceShortType] = f.gatherHostsInfo f.serviceHandlers[hosts.ServiceShortType] = gatherHostsInfo
default: default:
return fmt.Errorf("invalid service %q in collect parameter", c) return fmt.Errorf("invalid service %q in collect parameter", c)
} }
@ -136,7 +136,7 @@ func (f *Fritzbox) gatherDevice(acc telegraf.Accumulator, deviceClient *tr064.Cl
} }
} }
func (f *Fritzbox) gatherDeviceInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error { func gatherDeviceInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error {
serviceClient := deviceinfo.ServiceClient{ serviceClient := deviceinfo.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
Service: service, Service: service,
@ -160,7 +160,7 @@ func (f *Fritzbox) gatherDeviceInfo(acc telegraf.Accumulator, deviceClient *tr06
return nil return nil
} }
func (f *Fritzbox) gatherWanInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error { func gatherWanInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error {
serviceClient := wancommonifconfig.ServiceClient{ serviceClient := wancommonifconfig.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
Service: service, Service: service,
@ -174,8 +174,8 @@ func (f *Fritzbox) gatherWanInfo(acc telegraf.Accumulator, deviceClient *tr064.C
if err != nil { if err != nil {
return fmt.Errorf("failed to lookup IGD service: %w", err) return fmt.Errorf("failed to lookup IGD service: %w", err)
} }
var totalBytesSent uint64 = 0 var totalBytesSent uint64
var totalBytesReceived uint64 = 0 var totalBytesReceived uint64
if len(igdServices) > 0 { if len(igdServices) > 0 {
igdServiceClient := &igdicfg.ServiceClient{ igdServiceClient := &igdicfg.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
@ -222,7 +222,7 @@ func (f *Fritzbox) gatherWanInfo(acc telegraf.Accumulator, deviceClient *tr064.C
return nil return nil
} }
func (f *Fritzbox) gatherPppInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error { func gatherPppInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error {
serviceClient := wanpppconn.ServiceClient{ serviceClient := wanpppconn.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
Service: service, Service: service,
@ -244,7 +244,7 @@ func (f *Fritzbox) gatherPppInfo(acc telegraf.Accumulator, deviceClient *tr064.C
return nil return nil
} }
func (f *Fritzbox) gatherDslInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error { func gatherDslInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error {
serviceClient := wandslifconfig.ServiceClient{ serviceClient := wandslifconfig.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
Service: service, Service: service,
@ -295,7 +295,7 @@ func (f *Fritzbox) gatherDslInfo(acc telegraf.Accumulator, deviceClient *tr064.C
return nil return nil
} }
func (f *Fritzbox) gatherWlanInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error { func gatherWlanInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error {
serviceClient := wlanconfig.ServiceClient{ serviceClient := wlanconfig.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
Service: service, Service: service,
@ -316,7 +316,7 @@ func (f *Fritzbox) gatherWlanInfo(acc telegraf.Accumulator, deviceClient *tr064.
"status": info.NewStatus, "status": info.NewStatus,
"ssid": info.NewSSID, "ssid": info.NewSSID,
"channel": strconv.Itoa(int(info.NewChannel)), "channel": strconv.Itoa(int(info.NewChannel)),
"band": f.wlanBandFromInfo(info), "band": wlanBandFromInfo(info),
} }
fields := map[string]interface{}{ fields := map[string]interface{}{
"total_associations": totalAssociations.NewTotalAssociations, "total_associations": totalAssociations.NewTotalAssociations,
@ -325,7 +325,7 @@ func (f *Fritzbox) gatherWlanInfo(acc telegraf.Accumulator, deviceClient *tr064.
return nil return nil
} }
func (f *Fritzbox) wlanBandFromInfo(info *wlanconfig.GetInfoResponse) string { func wlanBandFromInfo(info *wlanconfig.GetInfoResponse) string {
band := info.NewX_AVM_DE_FrequencyBand band := info.NewX_AVM_DE_FrequencyBand
if band != "" { if band != "" {
return band return band
@ -336,12 +336,12 @@ func (f *Fritzbox) wlanBandFromInfo(info *wlanconfig.GetInfoResponse) string {
return "5000" return "5000"
} }
func (f *Fritzbox) gatherHostsInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error { func gatherHostsInfo(acc telegraf.Accumulator, deviceClient *tr064.Client, service tr064.ServiceDescriptor) error {
serviceClient := hosts.ServiceClient{ serviceClient := hosts.ServiceClient{
TR064Client: deviceClient, TR064Client: deviceClient,
Service: service, Service: service,
} }
connections, err := f.fetchHostsConnections(&serviceClient) connections, err := fetchHostsConnections(&serviceClient)
if err != nil { if err != nil {
return fmt.Errorf("failed to fetch hosts connections: %w", err) return fmt.Errorf("failed to fetch hosts connections: %w", err)
} }
@ -355,9 +355,9 @@ func (f *Fritzbox) gatherHostsInfo(acc telegraf.Accumulator, deviceClient *tr064
"source": serviceClient.TR064Client.DeviceUrl.Hostname(), "source": serviceClient.TR064Client.DeviceUrl.Hostname(),
"service": serviceClient.Service.ShortId(), "service": serviceClient.Service.ShortId(),
"node": connection.RightDeviceName, "node": connection.RightDeviceName,
"node_role": f.hostRole(connection.RightMeshRole), "node_role": hostRole(connection.RightMeshRole),
"node_ap": connection.LeftDeviceName, "node_ap": connection.LeftDeviceName,
"node_ap_role": f.hostRole(connection.LeftMeshRole), "node_ap_role": hostRole(connection.LeftMeshRole),
"link_type": connection.InterfaceType, "link_type": connection.InterfaceType,
"link_name": connection.InterfaceName, "link_name": connection.InterfaceName,
} }
@ -372,14 +372,14 @@ func (f *Fritzbox) gatherHostsInfo(acc telegraf.Accumulator, deviceClient *tr064
return nil return nil
} }
func (f *Fritzbox) hostRole(role string) string { func hostRole(role string) string {
if role == "unknown" { if role == "unknown" {
return "client" return "client"
} }
return role return role
} }
func (f *Fritzbox) fetchHostsConnections(serviceClient *hosts.ServiceClient) ([]*mesh.Connection, error) { func fetchHostsConnections(serviceClient *hosts.ServiceClient) ([]*mesh.Connection, error) {
meshListPath := &hosts.X_AVM_DE_GetMeshListPathResponse{} meshListPath := &hosts.X_AVM_DE_GetMeshListPathResponse{}
if err := serviceClient.X_AVM_DE_GetMeshListPath(meshListPath); err != nil { if err := serviceClient.X_AVM_DE_GetMeshListPath(meshListPath); err != nil {
return nil, fmt.Errorf("failed to query mesh list path: %w", err) return nil, fmt.Errorf("failed to query mesh list path: %w", err)
@ -400,7 +400,7 @@ func (f *Fritzbox) fetchHostsConnections(serviceClient *hosts.ServiceClient) ([]
return nil, fmt.Errorf("failed to read mesh list: %w", err) return nil, fmt.Errorf("failed to read mesh list: %w", err)
} }
meshList := &mesh.List{} meshList := &mesh.List{}
if json.Unmarshal(meshListBytes, meshList); err != nil { if err := json.Unmarshal(meshListBytes, meshList); err != nil {
return nil, fmt.Errorf("failed to parse mesh list: %w", err) return nil, fmt.Errorf("failed to parse mesh list: %w", err)
} }
return meshList.Connections(), nil return meshList.Connections(), nil

2
plugins/inputs/fritzbox/fritzbox_test.go
View File

@ -95,7 +95,7 @@ func TestCases(t *testing.T) {
} }
t.Run(testcase.Name(), func(t *testing.T) { t.Run(testcase.Name(), func(t *testing.T) {
testcaseDir := filepath.Join("testdata/testcases", testcase.Name()) testcaseDir := filepath.Join("testdata", "testcases", testcase.Name())
configFile := filepath.Join(testcaseDir, "telegraf.conf") configFile := filepath.Join(testcaseDir, "telegraf.conf")
mockDir := filepath.Join(testcaseDir, "mock") mockDir := filepath.Join(testcaseDir, "mock")
expectedMetricsFile := filepath.Join(testcaseDir, "expected.out") expectedMetricsFile := filepath.Join(testcaseDir, "expected.out")