Skip to content

Commit 8795df2

Browse files
committed
fix: address inconcsistencies with --sys and --drop-privileges + update docs
1 parent 9b22d0c commit 8795df2

20 files changed

Lines changed: 298 additions & 93 deletions

File tree

docs/docs/how-it-works/commands/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ $ sysg stop # Stop services
1313
$ sysg restart # Restart services
1414
$ sysg status # Check health
1515
$ sysg logs # View output
16-
$ sysg inspect api # View metrics
16+
$ sysg inspect --service api # View metrics
1717
$ sysg spawn --name w1 -- cmd # Create child
1818
$ sysg purge # Clear all state
1919
```

docs/docs/how-it-works/commands/inspect.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ title: inspect
88
View detailed metrics for a specific service.
99

1010
```sh
11-
$ sysg inspect myservice
11+
$ sysg inspect --service myservice
1212
```
1313

1414
## Options
1515

1616
| Option | Description |
1717
|--------|------------|
18+
| `-s, --service` | Name of the service to inspect |
1819
| `--stream` | Continuously refresh output and render a rolling metrics window of the provided duration (e.g., `5`, `1s`, `2m`) |
1920
| `--config` | Path to configuration file |
2021
| `--json` | Emit machine-readable JSON output instead of a report |
2122
| `--sys` | Opt into privileged system mode. Requires running as root |
22-
| `--drop-privileges` | Drop privileges after performing privileged setup |
2323
| `--no-color` | Disable ANSI colors in output |
2424
| `--log-level` | Set verbosity (`debug`, `info`, `warn`, `error`) |
2525

@@ -28,7 +28,7 @@ $ sysg inspect myservice
2828
### View service metrics
2929

3030
```sh
31-
$ sysg inspect api
31+
$ sysg inspect --service api
3232
```
3333

3434
Shows CPU and memory usage chart:
@@ -54,15 +54,7 @@ CPU: 45.2% (current) Memory: 23.1% (current)
5454
### Stream with a longer rolling window
5555

5656
```sh
57-
$ sysg inspect api --stream 24h
58-
```
59-
60-
### Inspect by hash
61-
62-
Useful for cron jobs:
63-
64-
```sh
65-
$ sysg inspect 3abad7ffa39c
57+
$ sysg inspect --service api --stream 24h
6658
```
6759

6860
## Metrics shown

docs/docs/how-it-works/commands/logs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ $ sysg logs
2121
| `--kind` | Kind of logs to show: stdout, stderr, or supervisor (default: stderr) |
2222
| `--stream` | Continuously refresh the latest log snapshot at the provided interval (e.g., `5`, `1s`, `2m`) |
2323
| `--sys` | Opt into privileged system mode. Requires running as root |
24-
| `--drop-privileges` | Drop privileges after performing privileged setup |
2524
| `--log-level` | Set verbosity (`debug`, `info`, `warn`, `error`) |
2625

2726
## Examples

docs/docs/how-it-works/commands/purge.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ $ sysg purge
1818
| Option | Description |
1919
|--------|------------|
2020
| `--sys` | Opt into privileged system mode. Requires running as root |
21-
| `--drop-privileges` | Drop privileges after performing privileged setup |
2221
| `--log-level` | Set verbosity (`debug`, `info`, `warn`, `error`) |
2322

2423
## What gets removed

docs/docs/how-it-works/commands/restart.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ $ sudo sysg restart --sys
4747

4848
### `--drop-privileges`
4949

50-
Drop privileges after performing privileged setup.
50+
Drop child service privileges during spawn. When enabled in root/system mode,
51+
services without an explicit `user` run as `nobody`.
5152

5253
```sh
5354
$ sudo sysg restart --sys --drop-privileges

docs/docs/how-it-works/commands/spawn.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ $ sysg spawn --name worker_1 -- python worker.py
1919
| `--ttl` | Time-to-live in seconds (optional) |
2020
| `--parent-pid` | Parent process ID (defaults to caller's parent PID if not specified) |
2121
| `--sys` | Opt into privileged system mode. Requires running as root |
22-
| `--drop-privileges` | Drop privileges after performing privileged setup |
2322
| `--log-level` | Override the logging verbosity for the spawned process |
2423

2524
## Examples

docs/docs/how-it-works/commands/start.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ $ sudo sysg start --sys
4747

4848
### `--drop-privileges`
4949

50-
Drop privileges after performing privileged setup.
50+
Drop child service privileges during spawn. When enabled in root/system mode,
51+
services without an explicit `user` run as `nobody`.
5152

5253
```sh
5354
$ sudo sysg start --sys --drop-privileges

docs/docs/how-it-works/commands/status.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ $ sysg status
1919
| `--service` | Show specific service details |
2020
| `--all` | Show all services including orphaned state (services not in current config) |
2121
| `--sys` | Opt into privileged system mode. Requires running as root |
22-
| `--drop-privileges` | Drop privileges after performing privileged setup |
2322
| `--json` | Emit machine-readable JSON output instead of a table |
2423
| `--no-color` | Disable ANSI colors in output |
2524
| `--stream` | Continuously refresh status at the provided interval (e.g., `5`, `1s`, `2m`) |

docs/docs/how-it-works/commands/stop.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,6 @@ Opt into privileged system mode. Requires running as root.
3737
$ sudo sysg stop --sys
3838
```
3939

40-
### `--drop-privileges`
41-
42-
Drop privileges after performing privileged setup.
43-
44-
```sh
45-
$ sudo sysg stop --sys --drop-privileges
46-
```
47-
4840
### `--log-level`
4941

5042
Set logging verbosity for this invocation. Accepts named levels (`trace`, `debug`, `info`, `warn`, `error`, `off`) or numeric values (5-0).

docs/docs/how-it-works/privileged-mode.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Enable privileged mode to:
2222
$ sudo sysg --sys start --daemonize
2323
```
2424

25+
If you also pass `--drop-privileges`, it applies to child service processes at
26+
spawn time (not to read-only control commands like `status` or `logs`).
27+
2528
The `--sys` flag moves state to system directories:
2629
- `/var/lib/systemg/` - Runtime state
2730
- `/var/log/systemg/` - Logs

0 commit comments

Comments
 (0)