hermes.shared_metrics.v2.schema.json 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705
  1. {
  2. "$schema": "https://json-schema.org/draft/2020-12/schema",
  3. "$id": "urn:hermes-agent:schema:shared-metrics:v2",
  4. "title": "Hermes Shared Metrics Package v2",
  5. "type": "object",
  6. "additionalProperties": false,
  7. "required": [
  8. "schema_version",
  9. "package_id",
  10. "install_id",
  11. "period_start",
  12. "period_end",
  13. "generated_at",
  14. "resource",
  15. "metrics"
  16. ],
  17. "properties": {
  18. "schema_version": {
  19. "const": "hermes.shared_metrics.v2"
  20. },
  21. "package_id": {
  22. "$ref": "#/$defs/uuid"
  23. },
  24. "install_id": {
  25. "description": "Random persistent identifier scoped to one HERMES_HOME; local-only in schema v2.",
  26. "$ref": "#/$defs/uuid"
  27. },
  28. "period_start": {
  29. "type": "string",
  30. "format": "date-time"
  31. },
  32. "period_end": {
  33. "type": "string",
  34. "format": "date-time"
  35. },
  36. "generated_at": {
  37. "type": "string",
  38. "format": "date-time"
  39. },
  40. "resource": {
  41. "type": "object",
  42. "additionalProperties": false,
  43. "required": [
  44. "architecture",
  45. "hermes_version",
  46. "install_method",
  47. "os_family"
  48. ],
  49. "properties": {
  50. "architecture": {
  51. "type": "string",
  52. "enum": ["arm", "arm64", "unknown", "x86", "x86_64"]
  53. },
  54. "hermes_version": {
  55. "type": "string",
  56. "minLength": 1,
  57. "maxLength": 64
  58. },
  59. "install_method": {
  60. "type": "string",
  61. "enum": ["apt", "docker", "git", "home-manager", "homebrew", "nixos", "pip", "unknown"]
  62. },
  63. "os_family": {
  64. "type": "string",
  65. "enum": ["linux", "macos", "unknown", "windows"]
  66. }
  67. }
  68. },
  69. "metrics": {
  70. "type": "array",
  71. "minItems": 1,
  72. "items": {
  73. "oneOf": [
  74. {
  75. "$ref": "#/$defs/client_active_counter"
  76. },
  77. {
  78. "$ref": "#/$defs/model_call_counter"
  79. },
  80. {
  81. "$ref": "#/$defs/model_route_counter"
  82. },
  83. {
  84. "$ref": "#/$defs/task_started_counter"
  85. },
  86. {
  87. "$ref": "#/$defs/task_finished_counter"
  88. },
  89. {
  90. "$ref": "#/$defs/tool_call_counter"
  91. },
  92. {
  93. "$ref": "#/$defs/tool_approval_counter"
  94. },
  95. {
  96. "$ref": "#/$defs/skill_lifecycle_counter"
  97. },
  98. {
  99. "$ref": "#/$defs/skill_load_counter"
  100. }
  101. ]
  102. }
  103. }
  104. },
  105. "$defs": {
  106. "client_active_counter": {
  107. "type": "object",
  108. "additionalProperties": false,
  109. "required": [
  110. "name",
  111. "type",
  112. "dimensions",
  113. "value"
  114. ],
  115. "properties": {
  116. "name": {
  117. "const": "hermes.client.active"
  118. },
  119. "type": {
  120. "const": "counter"
  121. },
  122. "dimensions": {
  123. "type": "object",
  124. "additionalProperties": false,
  125. "maxProperties": 0
  126. },
  127. "value": {
  128. "const": 1
  129. }
  130. }
  131. },
  132. "uuid": {
  133. "type": "string",
  134. "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
  135. },
  136. "model_call_counter": {
  137. "type": "object",
  138. "additionalProperties": false,
  139. "required": [
  140. "name",
  141. "type",
  142. "dimensions",
  143. "value"
  144. ],
  145. "properties": {
  146. "name": {
  147. "const": "hermes.model_call.count"
  148. },
  149. "type": {
  150. "const": "counter"
  151. },
  152. "dimensions": {
  153. "type": "object",
  154. "additionalProperties": false,
  155. "required": [
  156. "call_role",
  157. "locality",
  158. "model_family",
  159. "outcome",
  160. "provider_family"
  161. ],
  162. "properties": {
  163. "call_role": {
  164. "const": "primary"
  165. },
  166. "locality": {
  167. "enum": [
  168. "local",
  169. "remote",
  170. "unknown"
  171. ]
  172. },
  173. "model_family": {
  174. "enum": [
  175. "claude",
  176. "deepseek",
  177. "gemini",
  178. "gemma",
  179. "glm",
  180. "gpt",
  181. "grok",
  182. "kimi",
  183. "llama",
  184. "minimax",
  185. "mimo",
  186. "mistral",
  187. "nemotron",
  188. "nova",
  189. "o1",
  190. "o3",
  191. "o4",
  192. "qwen",
  193. "step",
  194. "trinity",
  195. "unknown"
  196. ]
  197. },
  198. "outcome": {
  199. "enum": [
  200. "cancelled",
  201. "failed",
  202. "success"
  203. ]
  204. },
  205. "provider_family": {
  206. "enum": [
  207. "aggregator",
  208. "custom",
  209. "direct",
  210. "local",
  211. "unknown"
  212. ]
  213. }
  214. }
  215. },
  216. "value": {
  217. "type": "integer",
  218. "minimum": 1
  219. }
  220. }
  221. },
  222. "model_route_counter": {
  223. "type": "object",
  224. "additionalProperties": false,
  225. "required": [
  226. "name",
  227. "type",
  228. "dimensions",
  229. "value"
  230. ],
  231. "properties": {
  232. "name": {
  233. "const": "hermes.model_route.count"
  234. },
  235. "type": {
  236. "const": "counter"
  237. },
  238. "dimensions": {
  239. "type": "object",
  240. "additionalProperties": false,
  241. "required": [
  242. "model",
  243. "provider"
  244. ],
  245. "properties": {
  246. "model": {
  247. "type": "string",
  248. "minLength": 1,
  249. "maxLength": 256,
  250. "pattern": "^[a-z0-9][a-z0-9._:/@+\\-]*$"
  251. },
  252. "provider": {
  253. "type": "string",
  254. "minLength": 1,
  255. "maxLength": 64,
  256. "pattern": "^[a-z0-9][a-z0-9._:/@+\\-]*$"
  257. }
  258. }
  259. },
  260. "value": {
  261. "type": "integer",
  262. "minimum": 1
  263. }
  264. }
  265. },
  266. "task_started_counter": {
  267. "type": "object",
  268. "additionalProperties": false,
  269. "required": [
  270. "name",
  271. "type",
  272. "dimensions",
  273. "value"
  274. ],
  275. "properties": {
  276. "name": {
  277. "const": "hermes.task_run.started"
  278. },
  279. "type": {
  280. "const": "counter"
  281. },
  282. "dimensions": {
  283. "type": "object",
  284. "additionalProperties": false,
  285. "required": [
  286. "entrypoint",
  287. "execution_surface"
  288. ],
  289. "properties": {
  290. "entrypoint": {
  291. "$ref": "#/$defs/task_entrypoint"
  292. },
  293. "execution_surface": {
  294. "$ref": "#/$defs/execution_surface"
  295. }
  296. }
  297. },
  298. "value": {
  299. "type": "integer",
  300. "minimum": 1
  301. }
  302. }
  303. },
  304. "task_finished_counter": {
  305. "type": "object",
  306. "additionalProperties": false,
  307. "required": [
  308. "name",
  309. "type",
  310. "dimensions",
  311. "value"
  312. ],
  313. "properties": {
  314. "name": {
  315. "const": "hermes.task_run.finished"
  316. },
  317. "type": {
  318. "const": "counter"
  319. },
  320. "dimensions": {
  321. "type": "object",
  322. "additionalProperties": false,
  323. "required": [
  324. "duration_bucket",
  325. "end_reason",
  326. "entrypoint",
  327. "execution_surface",
  328. "model_call_count_bucket",
  329. "outcome",
  330. "retry_count_bucket",
  331. "termination",
  332. "tool_call_count_bucket"
  333. ],
  334. "properties": {
  335. "duration_bucket": {
  336. "$ref": "#/$defs/duration_bucket"
  337. },
  338. "end_reason": {
  339. "enum": [
  340. "approval_denied",
  341. "completed",
  342. "failed",
  343. "guardrail_blocked",
  344. "iteration_limit",
  345. "system_aborted",
  346. "timed_out",
  347. "unknown",
  348. "user_cancelled"
  349. ]
  350. },
  351. "entrypoint": {
  352. "$ref": "#/$defs/task_entrypoint"
  353. },
  354. "execution_surface": {
  355. "$ref": "#/$defs/execution_surface"
  356. },
  357. "model_call_count_bucket": {
  358. "$ref": "#/$defs/count_bucket"
  359. },
  360. "outcome": {
  361. "enum": [
  362. "cancelled",
  363. "failed",
  364. "success",
  365. "timed_out",
  366. "unknown"
  367. ]
  368. },
  369. "retry_count_bucket": {
  370. "$ref": "#/$defs/count_bucket"
  371. },
  372. "termination": {
  373. "enum": [
  374. "none",
  375. "system_aborted",
  376. "timed_out",
  377. "unknown",
  378. "user_cancelled"
  379. ]
  380. },
  381. "tool_call_count_bucket": {
  382. "$ref": "#/$defs/count_bucket"
  383. }
  384. }
  385. },
  386. "value": {
  387. "type": "integer",
  388. "minimum": 1
  389. }
  390. }
  391. },
  392. "execution_surface": {
  393. "enum": [
  394. "acp",
  395. "api",
  396. "batch",
  397. "cli",
  398. "desktop",
  399. "gateway",
  400. "other",
  401. "python",
  402. "scheduled_task",
  403. "tui",
  404. "unknown"
  405. ]
  406. },
  407. "task_entrypoint": {
  408. "enum": [
  409. "api",
  410. "background",
  411. "batch",
  412. "delegated",
  413. "gateway_message",
  414. "interactive",
  415. "other",
  416. "python",
  417. "scheduled_task",
  418. "unknown"
  419. ]
  420. },
  421. "duration_bucket": {
  422. "enum": [
  423. "1s_to_5s",
  424. "2m_to_10m",
  425. "30s_to_2m",
  426. "5s_to_30s",
  427. "gte_10m",
  428. "lt_1s"
  429. ]
  430. },
  431. "count_bucket": {
  432. "enum": [
  433. "0",
  434. "1",
  435. "2",
  436. "3_to_5",
  437. "6_to_10",
  438. "gte_11"
  439. ]
  440. },
  441. "tool_latency_bucket": {
  442. "enum": [
  443. "100ms_to_250ms",
  444. "10s_to_30s",
  445. "1s_to_2s",
  446. "250ms_to_500ms",
  447. "2s_to_5s",
  448. "500ms_to_1s",
  449. "5s_to_10s",
  450. "gte_30s",
  451. "lt_100ms",
  452. "unknown"
  453. ]
  454. },
  455. "tool_retry_bucket": {
  456. "enum": [
  457. "0",
  458. "1",
  459. "2",
  460. "3_to_5",
  461. "6_to_10",
  462. "gte_11",
  463. "unknown"
  464. ]
  465. },
  466. "tool_call_counter": {
  467. "type": "object",
  468. "additionalProperties": false,
  469. "required": [
  470. "name",
  471. "type",
  472. "dimensions",
  473. "value"
  474. ],
  475. "properties": {
  476. "name": {
  477. "const": "hermes.tool_call.count"
  478. },
  479. "type": {
  480. "const": "counter"
  481. },
  482. "dimensions": {
  483. "type": "object",
  484. "additionalProperties": false,
  485. "required": [
  486. "approval_outcome",
  487. "latency_bucket",
  488. "outcome",
  489. "retry_count_bucket",
  490. "tool_category"
  491. ],
  492. "properties": {
  493. "approval_outcome": {
  494. "enum": [
  495. "approved",
  496. "cancelled",
  497. "denied",
  498. "not_required",
  499. "timed_out",
  500. "unknown"
  501. ]
  502. },
  503. "latency_bucket": {
  504. "$ref": "#/$defs/tool_latency_bucket"
  505. },
  506. "outcome": {
  507. "enum": [
  508. "blocked",
  509. "cancelled",
  510. "failed",
  511. "success",
  512. "timed_out",
  513. "unknown"
  514. ]
  515. },
  516. "retry_count_bucket": {
  517. "$ref": "#/$defs/tool_retry_bucket"
  518. },
  519. "tool_category": {
  520. "enum": [
  521. "browser",
  522. "code_execution",
  523. "communication",
  524. "computer_use",
  525. "delegation",
  526. "file",
  527. "home_automation",
  528. "mcp",
  529. "media",
  530. "memory",
  531. "other",
  532. "planning",
  533. "project",
  534. "scheduler",
  535. "skill",
  536. "terminal",
  537. "unknown",
  538. "web"
  539. ]
  540. }
  541. }
  542. },
  543. "value": {
  544. "type": "integer",
  545. "minimum": 1
  546. }
  547. }
  548. },
  549. "tool_approval_counter": {
  550. "type": "object",
  551. "additionalProperties": false,
  552. "required": [
  553. "name",
  554. "type",
  555. "dimensions",
  556. "value"
  557. ],
  558. "properties": {
  559. "name": {
  560. "const": "hermes.tool_approval.count"
  561. },
  562. "type": {
  563. "const": "counter"
  564. },
  565. "dimensions": {
  566. "type": "object",
  567. "additionalProperties": false,
  568. "required": [
  569. "attribution",
  570. "outcome"
  571. ],
  572. "properties": {
  573. "attribution": {
  574. "enum": [
  575. "tool_call",
  576. "unattributed"
  577. ]
  578. },
  579. "outcome": {
  580. "enum": [
  581. "approved",
  582. "cancelled",
  583. "denied",
  584. "timed_out",
  585. "unknown"
  586. ]
  587. }
  588. }
  589. },
  590. "value": {
  591. "type": "integer",
  592. "minimum": 1
  593. }
  594. }
  595. },
  596. "skill_lifecycle_counter": {
  597. "type": "object",
  598. "additionalProperties": false,
  599. "required": [
  600. "name",
  601. "type",
  602. "dimensions",
  603. "value"
  604. ],
  605. "properties": {
  606. "name": {
  607. "const": "hermes.skill.lifecycle.count"
  608. },
  609. "type": {
  610. "const": "counter"
  611. },
  612. "dimensions": {
  613. "type": "object",
  614. "additionalProperties": false,
  615. "required": [
  616. "action",
  617. "provenance"
  618. ],
  619. "properties": {
  620. "action": {
  621. "enum": [
  622. "archived",
  623. "created",
  624. "edited",
  625. "installed",
  626. "patched",
  627. "restored",
  628. "stale"
  629. ]
  630. },
  631. "provenance": {
  632. "$ref": "#/$defs/skill_provenance"
  633. }
  634. }
  635. },
  636. "value": {
  637. "type": "integer",
  638. "minimum": 1
  639. }
  640. }
  641. },
  642. "skill_load_counter": {
  643. "type": "object",
  644. "additionalProperties": false,
  645. "required": [
  646. "name",
  647. "type",
  648. "dimensions",
  649. "value"
  650. ],
  651. "properties": {
  652. "name": {
  653. "const": "hermes.skill.load.count"
  654. },
  655. "type": {
  656. "const": "counter"
  657. },
  658. "dimensions": {
  659. "type": "object",
  660. "additionalProperties": false,
  661. "required": [
  662. "post_patch_state",
  663. "provenance",
  664. "reuse_state",
  665. "use_count_bucket"
  666. ],
  667. "properties": {
  668. "post_patch_state": {
  669. "enum": [
  670. "no_new_patch",
  671. "not_applicable",
  672. "reused_after_patch"
  673. ]
  674. },
  675. "provenance": {
  676. "$ref": "#/$defs/skill_provenance"
  677. },
  678. "reuse_state": {
  679. "enum": [
  680. "first_use",
  681. "reused"
  682. ]
  683. },
  684. "use_count_bucket": {
  685. "$ref": "#/$defs/count_bucket"
  686. }
  687. }
  688. },
  689. "value": {
  690. "type": "integer",
  691. "minimum": 1
  692. }
  693. }
  694. },
  695. "skill_provenance": {
  696. "enum": [
  697. "agent_created",
  698. "external",
  699. "installed",
  700. "local",
  701. "unknown"
  702. ]
  703. }
  704. }
  705. }