akvorado/outlet/metadata/provider/snmp/root.go

// SPDX-FileCopyrightText: 2022 Free Mobile
// SPDX-License-Identifier: AGPL-3.0-only

// Package snmp handles SNMP polling to get interface names and
// descriptions.
package snmp

import (
	"context"
	"net/netip"
	"time"

	"akvorado/common/reporter"
	"akvorado/outlet/metadata/provider"
)

// Provider represents the SNMP provider.
type Provider struct {
	r         *reporter.Reporter
	config    *Configuration
	errLogger reporter.Logger

	metrics struct {
		successes *reporter.CounterVec
		errors    *reporter.CounterVec
		retries   *reporter.CounterVec
		times     *reporter.SummaryVec
	}
}

var (
	_ provider.Provider      = &Provider{}
	_ provider.Configuration = Configuration{}
)

// New creates a new SNMP provider from configuration
func (configuration Configuration) New(r *reporter.Reporter) (provider.Provider, error) {
	for exporterIP, agentIP := range configuration.Agents {
		if exporterIP.Is4() || agentIP.Is4() {
			delete(configuration.Agents, exporterIP)
			exporterIP = netip.AddrFrom16(exporterIP.As16())
			agentIP = netip.AddrFrom16(agentIP.As16())
			configuration.Agents[exporterIP] = agentIP
		}
	}

	p := Provider{
		r:         r,
		config:    &configuration,
		errLogger: r.Sample(reporter.BurstSampler(10*time.Second, 3)),
	}

	p.metrics.successes = r.CounterVec(
		reporter.CounterOpts{
			Name: "poller_success_requests_total",
			Help: "Number of successful requests.",
		}, []string{"exporter"})
	p.metrics.errors = r.CounterVec(
		reporter.CounterOpts{
			Name: "poller_error_requests_total",
			Help: "Number of failed requests.",
		}, []string{"exporter", "error"})
	p.metrics.retries = r.CounterVec(
		reporter.CounterOpts{
			Name: "poller_retry_requests_total",
			Help: "Number of retried requests.",
		}, []string{"exporter"})
	p.metrics.times = r.SummaryVec(
		reporter.SummaryOpts{
			Name:       "poller_seconds",
			Help:       "Time to successfully poll for values.",
			Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
			MaxAge:     time.Hour,
		}, []string{"exporter"})

	return &p, nil
}

// Query queries exporter to get information through SNMP.
func (p *Provider) Query(ctx context.Context, query provider.Query) (provider.Answer, error) {
	agentIP, ok := p.config.Agents[query.ExporterIP]
	if !ok {
		agentIP = query.ExporterIP
	}
	agentPort := p.config.Ports.LookupOrDefault(query.ExporterIP, 161)
	return p.Poll(ctx, query.ExporterIP, agentIP, agentPort, query.IfIndex)
}