Skip to content

Commit 2b43ed1

Browse files
committed
add few empty lines - they make it easier for me to read in editor
1 parent 50a3cfb commit 2b43ed1

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ probe the system and reports on its overall configuration.
1414

1515
Image: [Midjourney](https://midjourney.com/), [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/legalcode)
1616

17+
1718
## Subcommands
1819

1920
Sonar has two subcommands, `ps` and `sysinfo`. Both collect information about the system and print
@@ -35,6 +36,7 @@ Options:
3536
-V, --version Print version
3637
```
3738

39+
3840
## Versions and release procedures
3941

4042
### Version numbers
@@ -51,6 +53,7 @@ itself changes. For example, v0.8.0 both added fields and stopped printing fiel
5153
The bugfix version is updated for changes that do not alter the output format per se but that might
5254
affect the output nevertheless, ie, most changes not covered by changes to the minor version number.
5355

56+
5457
### Release branches, uplifts and backports
5558

5659
The following branching scheme is new with v0.12.x.
@@ -87,15 +90,18 @@ With the branches come some additional rules for how to move patches around:
8790

8891
Version in progress, no changes as of yet.
8992

93+
9094
### Changes in v0.12.x (on `release_0_12`)
9195

9296
**System load data introduced**. Added the `load` field which is printed with one of the records
9397
per sonar invocation. (v0.12.0)
9498

99+
95100
### Changes in v0.11.x
96101

97102
**Better `ps` data**. More data points. (v0.11.0)
98103

104+
99105
### Changes in v0.10.x
100106

101107
**Less output**. Removed the `cores` and `memtotalkib` fields, as they are supplied by `sonar
@@ -105,6 +111,7 @@ sysinfo`. (v0.10.0)
105111
--batchless`) has changed from being the pid of the process below the session leader to being the
106112
more conventional process group id. In most situations this won't make a difference. (v0.10.1)
107113

114+
108115
### Changes in v0.9.x
109116

110117
**Sysinfo introduced**. The `sonar sysinfo` subcommand was introduced to extract information about
@@ -113,6 +120,7 @@ the system itself.
113120
**More help when information is missing**. The user name field now includes the UID if the user
114121
name can't be obtained from system databases but the UID is known. (v0.9.0)
115122

123+
116124
### Changes in v0.8.x
117125

118126
**Better `ps` data**. More clarifications, more data points. (v0.8.0)
@@ -121,6 +129,7 @@ name can't be obtained from system databases but the UID is known. (v0.9.0)
121129

122130
**Less `ps` output**. Fields that hold default values are not printed. (v0.8.0)
123131

132+
124133
### Changes in v0.7.x
125134

126135
**Improved `ps` process filtering.** The filters used in previous versions (minimum CPU
@@ -144,6 +153,7 @@ of fields and the use of default values.
144153
simply-created sonar data, process it and present it in specialized ways, removing those burdens
145154
from sonar.
146155

156+
147157
### Changes in v0.6.0
148158

149159
**This tool focuses on how resources are used**. What is actually running. Its
@@ -242,17 +252,20 @@ The base-45 digits of the value `897` are (in little-endian order) 42 and 19, an
242252
this value is thus `&J`. As the initial character is from a different character set, no explicit
243253
separator is needed in the array - the initial digit acts as a separator.
244254

255+
245256
### Version 0.11.0 `ps` output format
246257

247258
Version 0.11.0 adds one field:
248259

249260
`ppid` (optional, default "0"): The parent process ID of the job, a positive integer.
250261

262+
251263
### Version 0.10.0 `ps` output format
252264

253265
The fields `cores` and `memtotalkib` were removed, as they were unused by all clients and are
254266
supplied by `sonar sysinfo` for clients that need that information.
255267

268+
256269
### Version 0.9.0 `ps` output format
257270

258271
Version 0.9.0 documents that the `user` field *in previous versions* could have the value
@@ -263,6 +276,7 @@ Version 0.9.0 extends the encoding of the `user` field: it can now (also) have t
263276
`_noinfo_<uid>` where `<uid>` is the user ID, if user information was unobtainable for any reason
264277
but we have a UID. Clients could be able to handle both this encoding and the older encoding.
265278

279+
266280
### Version 0.8.0 `ps` output format
267281

268282
Fields with default values (zero in most cases, or the empty set of GPUs) are not printed.
@@ -278,6 +292,7 @@ a nonnegative integer, with 0 meaning "no data available".
278292
Version 0.8.0 also clarifies that the existing `cpukib` field reports virtual data+stack memory, not
279293
resident memory nor virtual total memory.
280294

295+
281296
### Version 0.7.0 `ps` output format
282297

283298
Each field has the syntax `name=value` where the names are defined below. Fields are separated by
@@ -413,6 +428,7 @@ VMs) once every 24 hours, and to aggregate the information in some database.
413428

414429
The `sysinfo` subcommand currently has no options.
415430

431+
416432
### Version 0.9.0 `sysinfo` format
417433

418434
The JSON structure has these fields:
@@ -429,6 +445,7 @@ Numeric fields that are zero may or may not be omitted by the producer.
429445

430446
Note the v0.9.0 `sysinfo` output does not carry a version number.
431447

448+
432449
## Collect and analyze results
433450

434451
Sonar data are used by two other tools:
@@ -439,6 +456,7 @@ Sonar data are used by two other tools:
439456
provides dashboards, interactive and batch queries, and reporting of system activity, policy violations,
440457
hung jobs, and more.
441458

459+
442460
## Authors
443461

444462
- [Radovan Bast](https://bast.fr)
@@ -497,6 +515,7 @@ of processes.
497515

498516
Optionally, `sonar` will use a lockfile to avoid a pile-up of processes.
499517

518+
500519
## Dependencies and updates
501520

502521
Sonar runs everywhere and all the time, and even though it currently runs without privileges it
@@ -514,6 +533,7 @@ attack. There are some rules:
514533

515534
There is a useful discussion of these matters [here](https://research.swtch.com/deps).
516535

536+
517537
## How we run sonar on a cluster
518538

519539
We let cron execute the following script every 5 minutes on every compute node:

0 commit comments

Comments
 (0)