towerops/priv/proto/agent.proto

155 lines
3.3 KiB
Protocol Buffer

syntax = "proto3";
package towerops.agent;
// Configuration received from the API
message AgentConfig {
string version = 1;
uint32 poll_interval_seconds = 2;
repeated Equipment equipment = 3;
}
message Equipment {
string id = 1;
string name = 2;
string ip_address = 3;
SnmpConfig snmp = 4;
uint32 poll_interval_seconds = 5;
repeated Sensor sensors = 6;
repeated Interface interfaces = 7;
}
message SnmpConfig {
bool enabled = 1;
string version = 2;
string community = 3;
uint32 port = 4;
}
message Sensor {
string id = 1;
string type = 2;
string oid = 3;
double divisor = 4;
string unit = 5;
map<string, string> metadata = 6;
}
message Interface {
string id = 1;
uint32 if_index = 2;
string if_name = 3;
}
// Metrics submitted to the API
message MetricBatch {
repeated Metric metrics = 1;
}
message Metric {
oneof metric_type {
SensorReading sensor_reading = 1;
InterfaceStat interface_stat = 2;
NeighborDiscovery neighbor_discovery = 3;
}
}
message SensorReading {
string sensor_id = 1;
double value = 2;
string status = 3;
int64 timestamp = 4; // Unix timestamp in seconds
}
message InterfaceStat {
string interface_id = 1;
int64 if_in_octets = 2;
int64 if_out_octets = 3;
int64 if_in_errors = 4;
int64 if_out_errors = 5;
int64 if_in_discards = 6;
int64 if_out_discards = 7;
int64 timestamp = 8; // Unix timestamp in seconds
}
message NeighborDiscovery {
string interface_id = 1;
string protocol = 2; // "lldp" or "cdp"
string remote_chassis_id = 3;
string remote_system_name = 4;
string remote_system_description = 5;
string remote_platform = 6;
string remote_port_id = 7;
string remote_port_description = 8;
string remote_address = 9;
repeated string remote_capabilities = 10;
int64 timestamp = 11; // Unix timestamp in seconds
}
// Heartbeat metadata
message HeartbeatMetadata {
string version = 1;
string hostname = 2;
uint64 uptime_seconds = 3;
}
message HeartbeatResponse {
string status = 1;
}
// Channel-based communication messages
enum JobType {
DISCOVER = 0; // Full device discovery
POLL = 1; // Poll known sensors/interfaces
}
enum QueryType {
GET = 0; // SNMP GET operation
WALK = 1; // SNMP WALK operation
}
message AgentJob {
string job_id = 1; // Unique job identifier (e.g., "discover:eq123")
JobType job_type = 2; // DISCOVER or POLL
string equipment_id = 3; // Equipment UUID
SnmpDevice device = 4; // SNMP connection details
repeated SnmpQuery queries = 5; // Queries to execute
}
message AgentJobList {
repeated AgentJob jobs = 1;
}
message SnmpDevice {
string ip = 1;
string community = 2;
string version = 3; // "1", "2c", or "3"
uint32 port = 4;
}
message SnmpQuery {
QueryType query_type = 1;
repeated string oids = 2; // OIDs to query (GET) or walk (WALK)
}
message SnmpResult {
string equipment_id = 1;
JobType job_type = 2;
map<string, string> oid_values = 3; // OID → value mapping
int64 timestamp = 4; // Unix timestamp in seconds
}
message AgentHeartbeat {
string version = 1;
string hostname = 2;
uint64 uptime_seconds = 3;
string ip_address = 4; // Agent's IP address
}
message AgentError {
string equipment_id = 1;
string job_id = 2;
string message = 3;
int64 timestamp = 4;
}