Skip to content

Commit 31d90ff

Browse files
committed
update documentation for resource fields
1 parent 26a54b5 commit 31d90ff

5 files changed

Lines changed: 14 additions & 11 deletions

File tree

crates/kallichore_api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To see how to make this your own, look here:
1414
[README]((https://openapi-generator.tech))
1515

1616
- API version: 1.0.0
17-
- Build date: 2026-01-06T08:32:05.147283-08:00[America/Los_Angeles]
17+
- Build date: 2026-01-06T09:23:26.564876-08:00[America/Los_Angeles]
1818
- Generator version: 7.17.0
1919

2020
For more information, please visit [https://posit.co](https://posit.co)

crates/kallichore_api/api/openapi.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -894,15 +894,18 @@ components:
894894
timestamp: 9
895895
properties:
896896
cpu_percent:
897-
description: The percentage of CPU used by the kernel process and its child processes
897+
description: The percentage of CPU used by the kernel process and its child
898+
processes
898899
format: int64
899900
type: integer
900901
memory_bytes:
901-
description: The amount of memory used by the kernel process and its child processes in bytes
902+
description: The amount of memory used by the kernel process and all of
903+
its child processes in bytes
902904
format: int64
903905
type: integer
904906
thread_count:
905-
description: The number of threads used by the kernel process and its child processes
907+
description: The total number of threads used by the kernel process and
908+
its child processes (Linux only)
906909
format: int64
907910
type: integer
908911
sampling_period_ms:

crates/kallichore_api/docs/ResourceUsage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**cpu_percent** | **i64** | The percentage of CPU used by the kernel process |
7-
**memory_bytes** | **i64** | The amount of memory used by the kernel process in bytes |
8-
**thread_count** | **i64** | The number of threads used by the kernel process |
6+
**cpu_percent** | **i64** | The percentage of CPU used by the kernel process and its child processes |
7+
**memory_bytes** | **i64** | The amount of memory used by the kernel process and all of its child processes in bytes |
8+
**thread_count** | **i64** | The total number of threads used by the kernel process and its child processes (Linux only) |
99
**sampling_period_ms** | **i64** | The sampling period in milliseconds over which the resource usage was measured |
1010
**timestamp** | **i64** | A Unix timestamp in milliseconds indicating when the resource usage was sampled |
1111

crates/kallichore_api/src/models.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2330,15 +2330,15 @@ impl std::convert::TryFrom<hyper::header::HeaderValue>
23302330
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, validator::Validate)]
23312331
#[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))]
23322332
pub struct ResourceUsage {
2333-
/// The percentage of CPU used by the kernel process
2333+
/// The percentage of CPU used by the kernel process and its child processes
23342334
#[serde(rename = "cpu_percent")]
23352335
pub cpu_percent: i64,
23362336

2337-
/// The amount of memory used by the kernel process in bytes
2337+
/// The amount of memory used by the kernel process and all of its child processes in bytes
23382338
#[serde(rename = "memory_bytes")]
23392339
pub memory_bytes: i64,
23402340

2341-
/// The number of threads used by the kernel process
2341+
/// The total number of threads used by the kernel process and its child processes (Linux only)
23422342
#[serde(rename = "thread_count")]
23432343
pub thread_count: i64,
23442344

kallichore.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1164,7 +1164,7 @@
11641164
"thread_count": {
11651165
"type": "integer",
11661166
"format": "int64",
1167-
"description": "The total number of threads used by the kernel process and its child processes"
1167+
"description": "The total number of threads used by the kernel process and its child processes (Linux only)"
11681168
},
11691169
"sampling_period_ms": {
11701170
"type": "integer",

0 commit comments

Comments
 (0)