@spec acknowledge_alert(atom(), any()) :: :ok

Acknowledges an alert to stop notifications.

Examples

:ok = SnmpKit.SnmpLib.Dashboard.acknowledge_alert(:device_unreachable, "192.168.1.1")

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec create_alert(atom(), alert_level(), map()) :: :ok

Creates an alert for monitoring and notification systems.

Parameters

• alert_name: Unique identifier for the alert type
• level: Alert severity level (:info, :warning, :critical)
• details: Alert metadata and context information

Examples

# Create device unreachable alert
SnmpKit.SnmpLib.Dashboard.create_alert(:device_unreachable, :critical, %{
  device: "192.168.1.1",
  last_seen: DateTime.utc_now(),
  consecutive_failures: 5
})

# Create performance degradation warning
SnmpKit.SnmpLib.Dashboard.create_alert(:slow_response, :warning, %{
  device: "192.168.1.1",
  avg_response_time: 5000,
  threshold: 2000
})

@spec export_prometheus() :: binary()

Exports metrics in Prometheus format for external monitoring.

Examples

prometheus_data = SnmpKit.SnmpLib.Dashboard.export_prometheus()
File.write!("/tmp/snmp_metrics.prom", prometheus_data)

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

Gets all active alerts with optional filtering.

Examples

all_alerts = SnmpKit.SnmpLib.Dashboard.get_active_alerts()
critical_alerts = SnmpKit.SnmpLib.Dashboard.get_active_alerts(level: :critical)

@spec get_device_metrics(binary()) :: map()

Gets detailed metrics for a specific device.

Examples

device_metrics = SnmpKit.SnmpLib.Dashboard.get_device_metrics("192.168.1.1")
IO.inspect device_metrics.response_times

@spec get_metrics_summary() :: map()

Gets current performance metrics summary.

Returns

A map containing aggregated metrics:

• total_operations: Total SNMP operations performed
• success_rate: Percentage of successful operations
• avg_response_time: Average response time in milliseconds
• active_devices: Number of devices being monitored
• pool_utilization: Connection pool usage percentage
• error_rates: Breakdown of error types and frequencies

Examples

metrics = SnmpKit.SnmpLib.Dashboard.get_metrics_summary()
IO.puts "Success rate: " <> Float.to_string(metrics.success_rate * 100) <> "%"

@spec get_timeseries(metric_name(), pos_integer(), map()) :: [map()]

Gets historical time series data for a metric.

Parameters

• metric_name: Name of the metric to retrieve
• duration: Time window in milliseconds (default: 1 hour)
• tags: Optional tag filters

Examples

# Get last hour of response times
timeseries = SnmpKit.SnmpLib.Dashboard.get_timeseries(:snmp_response_time)

# Get last 24 hours for specific device
device_data = SnmpKit.SnmpLib.Dashboard.get_timeseries(
  :snmp_response_time,
  24 * 60 * 60 * 1000,
  %{device: "192.168.1.1"}
)

@spec record_metric(metric_name(), metric_value(), metric_tags()) :: :ok

Records a metric data point for monitoring and visualization.

Parameters

• metric_name: Unique identifier for the metric type
• value: Numeric value for the metric
• tags: Optional metadata for filtering and grouping

Examples

# Record response time metric
SnmpKit.SnmpLib.Dashboard.record_metric(:snmp_response_time, 125, %{
  device: "192.168.1.1",
  operation: "get",
  community: "public"
})

# Record error count
SnmpKit.SnmpLib.Dashboard.record_metric(:snmp_errors, 1, %{
  device: "192.168.1.1",
  error_type: "timeout"
})

# Record pool utilization
SnmpKit.SnmpLib.Dashboard.record_metric(:pool_utilization, 0.75, %{
  pool_name: "main_pool"
})

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

Starts the dashboard server with monitoring and web interface.

Options

• port: Web dashboard port (default: 4000)
• update_interval: Metrics update frequency in milliseconds (default: 5000)
• retention_days: How long to keep historical data (default: 7)
• prometheus_enabled: Enable Prometheus metrics endpoint (default: false)
• grafana_integration: Enable Grafana dashboard integration (default: false)

Examples

# Start with defaults
{:ok, _pid} = SnmpKit.SnmpLib.Dashboard.start_link()

# Start with custom configuration
{:ok, _pid} = SnmpKit.SnmpLib.Dashboard.start_link(
  port: 8080,
  prometheus_enabled: true,
  retention_days: 14
)