PermDock
CLI

snapshot

Measure the snapshot a role sends to the client, by part, in raw and gzip bytes.

permdock snapshot size builds the compact snapshot a probe subject holding one role receives and reports its size. The snapshot is the JSON snapshotFor returns, the payload a client provider serialises into the page.

Usage

permdock snapshot size
permdock snapshot size --role admin --tenants 40 --json
permdock snapshot size --omit-assignable --budget 32768

Without --role the command measures the role with the most grants. A role held on a scope gets --tenants memberships with UUID ids, and the snapshot includes every tenant. A role held on a resource is not supported.

FlagMeaning
--policy <module>Module exporting the policy; default policy in the config
--role <name>Role to measure
--tenants <n>Memberships of a scoped role. Default 1
--omit-assignableMeasure with the assignable part left out
--omit-staticMeasure with declared roles replaced by bundle references
--budget <bytes>Bytes the total may weigh. Default 65536. Reported, never a failure
--jsonPrint the report as JSON

The report lists grants, static, conditions, vocabulary, tenants, assignable and subject with bytes and gzip bytes, the total, the largest part, and perMembership: the bytes of grants and static for each membership of a scoped role. With --omit-static, perMembership shows what the bundle takes out of the page. See Snapshots.

Side effects

CommandEffects
permdock snapshot sizeNone

Last updated on

On this page