Skip to content

feat(agent): add system facts, routes, fact references, and validation #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
retr0h merged 10 commits into from
Mar 6, 2026
Merged

feat(agent): add system facts, routes, fact references, and validation #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
379252f
refactor(test): consolidate split test methods
retr0h Mar 6, 2026
035188f
feat(validation): add ip_or_fact validator for @fact references
retr0h Mar 6, 2026
1d2919a
wip: checkpoint agent facts, routes, factref, test consolidation
retr0h Mar 6, 2026
cba825b
test: close coverage gaps in agent handler, factref, and darwin routes
retr0h Mar 6, 2026
2d1045c
test: close coverage gaps in network provider factories
retr0h Mar 6, 2026
1729033
fix: validate fact keys and propagate resolution errors
retr0h Mar 6, 2026
f4e6d52
fix(docs): broken link to system-facts and remove SDK replace
retr0h Mar 6, 2026
2539683
fix(test): make default route reader test platform-agnostic
retr0h Mar 6, 2026
42195b7
fix(dns): return error for non-existent interface on macOS
retr0h Mar 6, 2026
cf6acce
test(dns): restore coverage for resolveServiceName error path
retr0h Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 32 additions & 13 deletions cmd/client_agent_get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ func displayAgentGetDetail(
cli.PrintKV("Package Mgr", data.PackageMgr)
}

if data.PrimaryInterface != "" {
cli.PrintKV("Primary Iface", data.PrimaryInterface)
}

if len(data.Interfaces) > 0 {
for _, iface := range data.Interfaces {
parts := []string{}
Expand All @@ -145,6 +149,20 @@ func displayAgentGetDetail(

var sections []cli.Section

if len(data.Routes) > 0 {
routeRows := make([][]string, 0, len(data.Routes))
for _, r := range data.Routes {
routeRows = append(routeRows, []string{
r.Destination, r.Gateway, r.Interface, r.Mask, fmt.Sprintf("%d", r.Metric),
})
}
sections = append(sections, cli.Section{
Title: "Routes",
Headers: []string{"DESTINATION", "GATEWAY", "INTERFACE", "MASK", "METRIC"},
Rows: routeRows,
})
}

if len(data.Conditions) > 0 {
condRows := make([][]string, 0, len(data.Conditions))
for _, c := range data.Conditions {
Expand All @@ -166,20 +184,21 @@ func displayAgentGetDetail(
})
}

if len(data.Timeline) > 0 {
timelineRows := make([][]string, 0, len(data.Timeline))
for _, te := range data.Timeline {
timelineRows = append(
timelineRows,
[]string{te.Timestamp, te.Event, te.Hostname, te.Message, te.Error},
)
}
sections = append(sections, cli.Section{
Title: "Timeline",
Headers: []string{"TIMESTAMP", "EVENT", "HOSTNAME", "MESSAGE", "ERROR"},
Rows: timelineRows,
})
timelineRows := make([][]string, 0, len(data.Timeline))
for _, te := range data.Timeline {
timelineRows = append(
timelineRows,
[]string{te.Timestamp, te.Event, te.Hostname, te.Message, te.Error},
)
}
if len(timelineRows) == 0 {
timelineRows = [][]string{{"No events"}}
}
sections = append(sections, cli.Section{
Title: "Timeline",
Headers: []string{"TIMESTAMP", "EVENT", "HOSTNAME", "MESSAGE", "ERROR"},
Rows: timelineRows,
})

for _, sec := range sections {
cli.PrintCompactTable([]cli.Section{sec})
Expand Down
117 changes: 115 additions & 2 deletions docs/docs/gen/api/get-agent-details.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Get detailed information about a specific agent by hostname."
sidebar_label: "Get agent details"
hide_title: true
hide_table_of_contents: true
api: eJztWdFu47YS/RWCT72A4pUSO83qLd0mvbltd4PdBH1YBAYtjiw2EqklR+66hv79YkjZlmwncZH2ocA+xbHIMzNnhuPD0YpLcJlVNSqjecp/AmQSUKgSJFM6N7YS9IiJmWmQCeZqyFSuMibmoJHNlqwwDrWoYMQjbmqwfv2N5CmfA17Sqh89oOMRRzF3PP3M/dfTX4UWc6jo4+XtzdQjTjcQjj9E3EHWWIVLnn5e8R9AWLCXDRaE4ZenFoTkD+1DxGthRQUI1vnF5BJP+do7HnFFAdYCCx5xC18aZUHyFG0DEXdZAZXg6YrjsqZ9Dq3Sc95GOwTdFbCJmJmcYQEdFWiYBbQKFjDi5JAFVxvtwBHsaRzTnyGYp6Hj2xF/mdEIGmmlqOtSZZ6JN787Wr7a99LMfocMecRrS7yhCsY2Qe/Fc3Q4IwrdocDGHUIB3VSUhI8g5JJH/L3B8PHhkIWssZYiDXj7dkoxg9IdiktIqQhIlLeDCF/I0s+wPFmIsgEWoFlmdK7mjQXJjN6xbmGuHIIFORV4KNhwCnjKpUA4QeWraWjwtwJ6sKwUDpmF3IIr6CChYwUIizMQG2Yt/o0Ga2sycI51uN6GcVM6wYdoHWJ9CEdOz5lbOoSqf/BHe8UlFfk5a8LmYwqsX1y/KN18ZX0MsgBfRVWXBHM/azQ25P4CrDvaRLf4WCun8Sge87btN4LPw8i2DjxEHBX6fR8+3ejcfOwONnnZ1D49RznZsRu2hMI3Qk7FAqyYw8t56mHQRtZtdCw3liURm0RMaMmSCauUbhDcfvKSSvUZ1U01A7tn6JceugcnTn1NJx30gM54dHbaRnzySuyB2z3w04s24slr0ZMn4Se7deBJ6uJZW+4VAdm4DCb6lVBBZezy5Sz+6texxpGLz540NCjKHqDSCPMDQd/ROhbsM6XZbLkb5cXZxcV5TDzmFuAIyGsL8Cziafz2+2RCaW8csfYi4r0D+SziOHk7PovHu8kIJHSOd9Z6yQhs9vMgbFYohAwbe8S5fHd7z/o7hn1CVPJ8TKCPYDWU06N70odPLGxZd6Yh7mSUTEbxydvkZA4arMrIRlY308w0Go9g870vf2p3pZmrTJTs3e39Dp+U7S/yCGevm7Jcsi+NKFWuQDJpKqE0W4u6rdt/wOwkTkbdF6PMVP63DOxCZTCt5vZlWzdaYdfEhtjhO0mAtcgexfxIwNuwmFVeTNqd/NVIgMSizUU20A7CWkHSRSFUB7XH8DA+pae2xgCL2FurF+PnVyZvT0fJ+cUoGSXrHefP78jhIk7TxPcZkT2/No7TJElPT9Ozs3Q8TicT2pWLSpXLI/Jzy4SUlrRE2DIkVDb+MK7ln9KAXlkDnhMUPX3YPcGeud6RfQ/4h7GPN+ukbA+v9zPDv6AEg3ofhnD1FUFLkMxjsdyaim13k1RaKAnWbSTu4bzuKNwfrVA6PHpnrDQ69KFDgp5kumxKL6gI3hvKjA4uvKIGw9OnfQ3N8JayR80v4v9V84J+rsh/5R43Tx4OifuZMSUIHSSxcIfanNfqDqdohXY+mulT8ueAht1r7bRl48gT0P3CMRLerWncF/1XpPgFgmTaSGBbwj3/BFYqDa9gX1XgUFT1seFGHBagDyj8NnrmiualhHNDRbh9BtaaA21xj9uNs2svekTedVxc+Qd7RHZVTKXLtulghXJo7HK0Z6t3x+5y2bPlwUg187aljeM42b8I32vRYGGs+hMkO2GXtzfsEZZsY+Rvuxk/wd4eA6z3//pS4fcyLAQyk/krrRw2x+swNukNArob7yhwHKYgLxvf9qpuTzd92Thx0KxsgEzr0F0ZFYBpsOs98hjRd7cJkjYMjEziuG23Sb2iVb2+HRJ7tp/Ya2NnSkrQ7ITdaNfkucqUv7CCrZRzvh9+y+6/Ibvjp+ZX2iDLTaO/HdN/QyInhwaRfuGaDtIt4h+aTH5L7D+UWK8asDDd3J2Ip0l3yt/4VL5ZrX+kWx5ubGFO3huxf6IUhiz1B+0brwtEEhM+014u+kU86j5crwXQ/3678wphM3vsCwG2nfnTr3xvypbyZBSP/HWoNg4robe3Lv9aYlCSu9yttgX62ncYXbgIX/FNXQrllWZj/SAmcNq9e+ARTzfS5yFIOnq4Ws2Eg3tbti19/aUBGgsR1QthlZgRG5/9HJU+S57monS7t5h+QN997HTQf9iRrx+eiGKtezWpXj8f5ynnNN1Y9l+VtHQ9KEBIsN7T8Pgyy6DG3sa9PkAvPTZF+NPVHd3ahjW0UzMe/aBTq1VYcWceQbftxkek/8nBtv0/q4g1/g==
api: eJztWV9v2zgS/yoEn24BxZGSOJvqLZsmvdzttkGaYB+KwKDFsc2NRKrkKK3P8Hc/DCnLkq0kWmT3YYEiD7HN4W/+kzPDFZfgMqtKVEbzlH8AZBJQqBwkU3pmbCFoiYmpqZAJ5krI1ExlTMxBI5su2cI41KKAEY+4KcF6+mvJUz4HPCeq9x7Q8YijmDuefuH+58lvQos5FPTx/OZ64hEnDYTjDxF3kFVW4ZKnX1b8FxAW7HmFC8Lw5KkFIfnD+iHipbCiAATrPDGJxFO+kY5HXJGCpcAFj7iFr5WyIHmKtoKIu2wBheDpiuOypH0OrdJzvo52DHS3gEZjZmYMF1CbAg2zgFbBE4w4CWTBlUY7cAR7FMf0rwvmzVDb25H9MqMRNBKlKMtcZd4Sh384Il/tS2mmf0CGPOKlJbuhCswapff0GazOiFR3KLByfSigq4KccAtCLnnEPxoMHx/6OGSVtaRpwNvnk4sp5K5PLyGlIiCR33Q0fMVL/4XlwZPIK2ABmmVGz9S8siCZ0TvcLcyVQ7AgJwL7lA1ZwFMuBcIBKh9NXYa/L6AFy3LhkFmYWXALSiR0bAHC4hREY1mLfyHD0poMnGM1rudh3IQyuM+sXaxPIeX0nLmlQyjaiT/aCy6pSM5pFTYPCbB2cP2qdPWdtTGIA3wXRZkTzP200liR+E9g3WAWNfFQLkfxKD7h63X7IPjS1WwrwEPEUaHf9+nztZ6Z2zqxScqq9O4ZJGRt3bAlBL4RciKewIo5vO6nFgZtZPVGx2bGsiRi44gJLVkyZoXSFYLbd15SqLZFdVVMwe4x+rWF7sHJpj6mkxq6Y854dHy0jvj4jdgdsVvgR2friCdvRU+ehR/vxoE3Uq3PhnMrCIjHeWDRjoQCCmOXr3vxN0/HKkcivphpaFDkLUClEeY9St8RHQv8mdJsutzV8uz47Ow0JjvOLMAAyCsL8CLiUfzu52RMbq8cWe1VxHsH8kXEk+TdyXF8suuMYIRa8JpbyxnBmm0/CJstFEKGlR2Qlxc396y9o3tOiEKenhDoI1gN+WTwmfTpMwtbNidTF3c8Ssaj+OBdcjAHDVZlxCMrq0lmKo0DrPnRhz8dd7mZq0zk7OLmfsee5O2vcoCwV1WeL9nXSuRqpkAyaQqhNNsUdVuxv8H0IE5G9Q+jzBT+LgP7pDKYFHP7Oq9rrbA+xLrY4TdJgKXIHsV8IOBNIGaFLybtjv9KJECyop2JrFM7CGsFlS4KoeitPbrJ+Fw9tWUGuIg9t/Lp5GXK5N3RKDk9GyWjZLPj9OUdMziL0zTx54zIXqaN4zRJ0qOj9Pg4PTlJx2PaNROFypcD/HPDhJSWaomwpWtQWflk3JR/SgP6yhrwlKBo9WE3g73lWin7EfCbsY/XG6dsk5d8b1Uh7HLSuOx1kT+2yotmG6ODorkBJMxElSOzZvfuarzml/5UfOzU8kwHvTwTKqZQTHNgoNEue6oocKi0GFZEvd8SN1xqL3WViUf+j/SZC4RvYoDHPwTCfsBWpHYSaYBXajm3Htk/Tza2L4R7HI5I1HSFXFy/v2XaoNiv7w4DLLVj2YDT9JZ8zwJ5ByiJY8qd3Letr8kXUDzxjlfi+Hi/2GwFwNZbbRO3UsZDty+5fsvsR56iS9anf4Z/osEKTXGXyeV3BC0pqQiLzawp2HY3dSBPSoJ1TefYf1zuNI7vrVA6LF0YK40O13tfn0zdr6xy36cQvGeUGR1EeMPRHlaflzXUGDeUHVRTRPzfar6gKpDkV+6xWXno65mnxuQgdOg0hevLd98CO5ygFdp5bSbPdRU9reFexURbGkGegW6fx0bCxcaM+8F1SY20QJBMGwlsa3BvfwLLlYY3WF8V4FAU5VB1Iw5PoHsa53X0wuTDnwfOdRut7RpYa3qqjT3bNsJupGgZ8q62xaVf2DNkHcUUumzrDrZQDg1dEbu8WqOr2pctXh6MmlG+XtPGkzjZny/da1Hhwlj1P5DsgJ3fXLNHWLKGyV82cHrGevt3ZOv75sr2exkuBDKT+UmR7B6fV2Ea2Zqv1YOkUbBxGC6+znx7VtV76qFmI0QvW1kBsd5cuxQApsL67JFDeqm7Rkna0GEyjuP1euvUS6JqlUPBscf7jr0ydqqkBM0O2LV21WymMuXnQGAL5Zw/D39495/g3ZPnxsLaIJuZSv9I03+CI8d9831PuDEH1S3ibxr4/3Ds3+TY0EUsTP2cRYanB6SUH3pXHq42l/Sah0FIeH5qvVx9JhcGL7XfrxqpF4hUTHhP+3LRE/Go/nC1KYD+8/udrxCakX67EGDbpzS65VvD65Qnm46wNA4LobfDDP/a1wnJXduttgH61qfBWl2E73hY5kL5SrOyfr4ZbFo/6fGIp03p8xBKOlpcrabCwb3N12v6+WsFNG0lUz8Jq6jj8e9+Ujn6LHk6E7nb7WLaCv3rtq6DfmIDX/We0WJT92qqev2zE085p6Hhsv0Cuab2YAFCgvWShuXzLIMSWxv3zgF6S2yC8MPlHXVt3RjaiRmP3ivUahUo7swj6PW6kRHpOwm4Xv8fAFNaBg==
sidebar_class_name: "get api-method"
info_path: gen/api/agent-management-api
custom_edit_url: null
Expand Down Expand Up @@ -547,6 +547,119 @@ Get detailed information about a specific agent by hostname.
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"primary_interface"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Name of the interface used for the default route.","example":"eth0"}}
>

</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
routes
</strong><span
className={"openapi-schema__name"}
>
object[]
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>


Network routing table entries.


</div><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"destination"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Destination network address.","example":"0.0.0.0"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"gateway"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Gateway address.","example":"192.168.1.1"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"interface"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Network interface name.","example":"eth0"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"mask"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Network mask in CIDR notation.","example":"/0"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"metric"}
required={false}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"Route metric.","example":100}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"flags"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Route flags.","example":"0003"}}
>

</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
Expand Down Expand Up @@ -792,7 +905,7 @@ Get detailed information about a specific agent by hostname.
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"hostname\": \"string\",\n \"status\": \"Ready\",\n \"labels\": {},\n \"registered_at\": \"2024-07-29T15:51:28.071Z\",\n \"started_at\": \"2024-07-29T15:51:28.071Z\",\n \"os_info\": {\n \"distribution\": \"Ubuntu\",\n \"version\": \"20.04\"\n },\n \"uptime\": \"string\",\n \"load_average\": {\n \"1min\": 0.32,\n \"5min\": 0.28,\n \"15min\": 0.25\n },\n \"memory\": {\n \"total\": 8388608,\n \"free\": 2097152,\n \"used\": 4194304\n },\n \"architecture\": \"amd64\",\n \"kernel_version\": \"5.15.0-91-generic\",\n \"cpu_count\": 4,\n \"fqdn\": \"web-01.example.com\",\n \"service_mgr\": \"systemd\",\n \"package_mgr\": \"apt\",\n \"interfaces\": [\n {\n \"name\": \"eth0\",\n \"ipv4\": \"192.168.1.10\",\n \"ipv6\": \"fe80::1\",\n \"mac\": \"00:11:22:33:44:55\",\n \"family\": \"dual\"\n }\n ],\n \"facts\": {},\n \"state\": \"Ready\",\n \"conditions\": [\n {\n \"type\": \"MemoryPressure\",\n \"status\": true,\n \"reason\": \"string\",\n \"last_transition_time\": \"2024-07-29T15:51:28.071Z\"\n }\n ],\n \"timeline\": [\n {\n \"timestamp\": \"2024-07-29T15:51:28.071Z\",\n \"event\": \"string\",\n \"hostname\": \"string\",\n \"message\": \"string\",\n \"error\": \"string\"\n }\n ]\n}"}
responseExample={"{\n \"hostname\": \"string\",\n \"status\": \"Ready\",\n \"labels\": {},\n \"registered_at\": \"2024-07-29T15:51:28.071Z\",\n \"started_at\": \"2024-07-29T15:51:28.071Z\",\n \"os_info\": {\n \"distribution\": \"Ubuntu\",\n \"version\": \"20.04\"\n },\n \"uptime\": \"string\",\n \"load_average\": {\n \"1min\": 0.32,\n \"5min\": 0.28,\n \"15min\": 0.25\n },\n \"memory\": {\n \"total\": 8388608,\n \"free\": 2097152,\n \"used\": 4194304\n },\n \"architecture\": \"amd64\",\n \"kernel_version\": \"5.15.0-91-generic\",\n \"cpu_count\": 4,\n \"fqdn\": \"web-01.example.com\",\n \"service_mgr\": \"systemd\",\n \"package_mgr\": \"apt\",\n \"interfaces\": [\n {\n \"name\": \"eth0\",\n \"ipv4\": \"192.168.1.10\",\n \"ipv6\": \"fe80::1\",\n \"mac\": \"00:11:22:33:44:55\",\n \"family\": \"dual\"\n }\n ],\n \"primary_interface\": \"eth0\",\n \"routes\": [\n {\n \"destination\": \"0.0.0.0\",\n \"gateway\": \"192.168.1.1\",\n \"interface\": \"eth0\",\n \"mask\": \"/0\",\n \"metric\": 100,\n \"flags\": \"0003\"\n }\n ],\n \"facts\": {},\n \"state\": \"Ready\",\n \"conditions\": [\n {\n \"type\": \"MemoryPressure\",\n \"status\": true,\n \"reason\": \"string\",\n \"last_transition_time\": \"2024-07-29T15:51:28.071Z\"\n }\n ],\n \"timeline\": [\n {\n \"timestamp\": \"2024-07-29T15:51:28.071Z\",\n \"event\": \"string\",\n \"hostname\": \"string\",\n \"message\": \"string\",\n \"error\": \"string\"\n }\n ]\n}"}
language={"json"}
>

Expand Down
Loading