Skip to content

Commit 5a79109

Browse files
author
Lars T Hansen
committed
Remove more, update docs
1 parent 1cc9dae commit 5a79109

36 files changed

+16
-2487
lines changed

doc/CHANGELOG.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,19 @@ general, all relevant fixes are uplifted from release branches to main, so a cha
55
will always be on main and in all later releases.
66

77
Since v0.13.0, the output format is documented mainly by the file
8-
[util/formats/newfmt/types.go](../util/formats/newfmt/types.go), which specifies the new JSON output
8+
[util/formats/newfmt/types.go](../util/formats/newfmt/types.go), which specifies the JSON output
99
format in terms of a Go data structure with JSON annotations. Changes to the output format can most
1010
easily be be seen by diffing this file against a desired tag, starting with "v0.13.0". Such changes
11-
are therefore no longer mentioned specially below. Recall that to get the new format, Sonar must be
12-
run in daemon mode or with the --json switch (which also requires the --cluster).
11+
are therefore no longer mentioned specially below.
1312

14-
The "old" output formats are for the most part not being extended with new fields and should not be
15-
relied upon. Consumers should expect to see the "new" JSON format for new data, and all producers
16-
should ask for that format.
1713

1814
## Changes in v0.17.0 (on `main`)
1915

20-
* Bug 244 - **REMOVED FUNCTIONALITY.** Remove all code related to producing CSV and the "old"
21-
JSON format, asking for those formats will now cause errors. The --json switch is still
22-
accepted but has no effect.
23-
* Bug 434 - **IMPORTANT FUNCTIONALITY.** Introduce the batch-size setting to allow very large
24-
slurm job lists to be split into multiple messages.
16+
* Bug 244 - **REMOVED FUNCTIONALITY.** Remove all code related to producing CSV and the "old" JSON
17+
format, asking for those formats will now cause errors. The --json switch is still accepted but
18+
has no effect.
19+
* Bug 434 - **IMPORTANT FUNCTIONALITY.** Introduce the batch-size setting to allow very large slurm
20+
job lists to be split into multiple messages.
2521

2622

2723
## Changes in v0.16.0 (on `release_0_16`)
@@ -32,8 +28,8 @@ should ask for that format.
3228
* Bug 352 - **MAJOR FUNCTIONALITY.** Populate the `topo_svg` field, introduce a `topo_text` field,
3329
and expand the config file so as to be able to specify how to generate those data
3430
* Bug 353 - Remove the `software` field.
35-
* Bug 387 - **IMPORTANT FIX.** Parse some slurm data, notably ReqMem, correctly. Previously the parser
36-
would always return 0 for this field
31+
* Bug 387 - **IMPORTANT FIX.** Parse some slurm data, notably ReqMem, correctly. Previously the
32+
parser would always return 0 for this field
3733
* Bug 401 - better error messages for Kafka
3834
* Bug 402 - synthesize a UUID on AMD cards when needed
3935
* Bug 402 - change the syntax of synthesized UUIDs on XPU (now joint with AMD)
@@ -43,10 +39,10 @@ should ask for that format.
4339
is no longer a required argument for that (defaulting to the empty string).
4440
* Bug 410 - output on stderr does not by itself cause a subcommand to fail, so long as the
4541
exit code is 0
46-
* Bug 409 / 437 - **MAJOR FUNCTIONALITY.** Run scontrol in addition to sacct in order to extract resource
47-
request for pending jobs. Remove the unused `gres_detail` field of slurm job data and introduce
48-
two fields `allocated_resources` and `requested_resources` and fill them with unparsed resouce data from
49-
sacct and scontrol.
42+
* Bug 409 / 437 - **MAJOR FUNCTIONALITY.** Run scontrol in addition to sacct in order to extract
43+
resource request for pending jobs. Remove the unused `gres_detail` field of slurm job data and
44+
introduce two fields `allocated_resources` and `requested_resources` and fill them with unparsed
45+
resouce data from sacct and scontrol.
5046
* Testing (sundry): Many testing improvements
5147
* Doc (sundry): Various improvements
5248

util/Makefile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ all:
55

66
test:
77
( cd formats ; $(MAKE) test )
8-
( cd ingest-files ; $(MAKE) test )
98

109
format:
1110
( cd formats ; $(MAKE) format )
12-
( cd ingest-files ; $(MAKE) format )
1311

util/README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
11
In `formats/` are definitions of the Sonar data formats, as high-level Go code, and simple parsers
2-
for the most important of the formats. Currently there are definitions for the initial v0.13 and
3-
older format, known here as "old" because there's a "new" format coming.
4-
5-
There is a sample client of the format definition:
6-
7-
* In `ingest-files/` is a program that will attempt to read old-format data from a directory tree.
8-
9-
The ingestor program is a sensible basis for a program that obtains data and stores them in a
10-
database, for example.
2+
for the most important of the formats. Currently there is a definition for only a JSON format
3+
(previously known as the "new" format since there were older formats than that).

util/formats/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Defines the old and new Sonar data formats in a reusable module, and parsers for the old data.
1+
Defines the Sonar data format in a reusable, machine-processable module.

util/formats/newfmt/to_oldfmt.go

Lines changed: 0 additions & 280 deletions
This file was deleted.

0 commit comments

Comments
 (0)