Returns a specification to start this module under a supervisor.

See Supervisor.

@spec export_data(atom(), atom()) :: binary()

Exports monitoring data for external analysis.

Parameters

• format: Export format (:json, :csv, :prometheus)
• timeframe: Time range for export

JSON Export

JSON export uses Elixir's built-in JSON module (requires Elixir 1.18+).

Examples

data = SnmpKit.SnmpLib.Monitor.export_data(:json, :last_hour)
case data do
  "JSON export unavailable" <> _ -> IO.puts("JSON not available")
  json -> File.write!("snmp_metrics.json", json)
end

@spec get_active_alerts() :: [map()]

Gets currently active alerts.

Examples

alerts = SnmpKit.SnmpLib.Monitor.get_active_alerts()
Enum.each(alerts, fn alert ->
  IO.puts("Alert: " <> alert.device_id <> " " <> to_string(alert.metric) <> " " <> to_string(alert.current_value))
end)

@spec get_device_stats(device_id(), atom()) :: device_stats() | {:error, :not_found}

Gets comprehensive statistics for a specific device.

Parameters

• device_id: Device identifier
• timeframe: Optional timeframe (:last_hour, :last_day, :all_time)

Returns

Device statistics map or {:error, :not_found} if device has no recorded operations.

Examples

# Get current device stats
stats = SnmpKit.SnmpLib.Monitor.get_device_stats("192.168.1.1")
IO.puts("Error rate: " <> to_string(stats.error_rate) <> "%")

# Get stats for specific timeframe
stats = SnmpKit.SnmpLib.Monitor.get_device_stats("192.168.1.1", :last_hour)

@spec get_operation_metrics(operation_type(), atom()) :: map()

Gets performance metrics for a specific operation type.

Parameters

• operation: SNMP operation type
• timeframe: Optional timeframe for analysis

Examples

metrics = SnmpKit.SnmpLib.Monitor.get_operation_metrics(:get_bulk)
IO.puts("Average GETBULK time: " <> to_string(metrics.avg_duration) <> "ms")

@spec get_system_stats() :: system_stats()

Gets system-wide statistics and performance metrics.

Returns

Comprehensive system statistics including global performance metrics, device counts, and resource utilization.

Examples

stats = SnmpKit.SnmpLib.Monitor.get_system_stats()
IO.puts("Total devices monitored: " <> to_string(stats.total_devices))
IO.puts("Operations per second: " <> to_string(stats.operations_per_second))

@spec health_check() :: :ok

Forces a health check of all monitored devices.

Useful for immediate assessment of system health.

Examples

:ok = SnmpKit.SnmpLib.Monitor.health_check()

@spec record_operation(map()) :: :ok

Records an SNMP operation for monitoring and analysis.

This is the primary interface for feeding operation data into the monitoring system. Should be called after every SNMP operation for comprehensive monitoring.

Parameters

• metric: Operation metric map with required fields

Required Fields

• device: Target device identifier
• operation: Type of SNMP operation
• duration: Operation duration in milliseconds
• result: Operation result status

Optional Fields

• error_type: Specific error classification (if result is :error)
• bytes_sent: Number of bytes sent
• bytes_received: Number of bytes received
• timestamp: Override timestamp (defaults to current time)

Examples

# Basic operation recording
SnmpKit.SnmpLib.Monitor.record_operation(%{
  device: "192.168.1.1",
  operation: :get,
  duration: 245,
  result: :success
})

# Detailed operation recording
SnmpKit.SnmpLib.Monitor.record_operation(%{
  device: "192.168.1.1",
  operation: :get_bulk,
  duration: 1250,
  result: :error,
  error_type: :timeout,
  bytes_sent: 64,
  bytes_received: 0
})

@spec remove_alert_threshold(device_id(), metric_type()) :: :ok

Removes an alert threshold.

Examples

:ok = SnmpKit.SnmpLib.Monitor.remove_alert_threshold("192.168.1.1", :response_time)

@spec set_alert_threshold(device_id(), metric_type(), number(), keyword()) :: :ok

Sets an alert threshold for automated monitoring.

Alerts fire when the specified metric exceeds the threshold for the given duration.

Parameters

• device_id: Device to monitor (use ":global" for system-wide alerts)
• metric: Metric type to monitor
• threshold: Threshold value
• opts: Alert configuration options

Options

• condition: :above or :below (default: :above)
• duration: How long threshold must be exceeded (default: 60000ms)
• callback: Function to call when alert fires

Examples

# Alert on high response times
SnmpKit.SnmpLib.Monitor.set_alert_threshold("192.168.1.1", :response_time, 5000)

# Alert on low availability with custom callback
SnmpKit.SnmpLib.Monitor.set_alert_threshold("core-router", :availability, 95.0,
  condition: :below,
  duration: 300_000,
  callback: &MyApp.Alerts.device_down/1
)

@spec start_link(keyword()) :: {:ok, pid()} | {:error, any()}

Starts the monitoring system.

Options

• retention_period: How long to keep historical data (default: 1 hour)
• bucket_size: Time bucket size for aggregation (default: 1 minute)
• cleanup_interval: How often to clean old data (default: 5 minutes)
• health_check_interval: How often to check device health (default: 1 minute)

Examples

{:ok, pid} = SnmpKit.SnmpLib.Monitor.start_link()

{:ok, pid} = SnmpKit.SnmpLib.Monitor.start_link(
  retention_period: 7200_000,  # 2 hours
  bucket_size: 30_000          # 30 second buckets
)