Skip to content

docs(accessanalyzer): add view and export logs page for 26.1 - #1737

Merged
jtviolet merged 4 commits into
devfrom
thobed/aa-installer-logs-commands
Oct 20, 2026
Merged

jtviolet merged 4 commits into
devfrom
thobed/aa-installer-logs-commands

Conversation

@thobed

@thobed thobed commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Adds a 26.1 install page for the installer's two log commands, dspm-installer logs and dspm-installer export-logs. They shipped in installer v1.0.20 (netwrix-corp/access-analyzer#753).

Closed PR #1588 covered the manual kubectl path and said the page should lead with these commands once they landed. This page documents them on their own.

Please merge this after netwrix-corp/access-analyzer#1232 (AA-1295) and #1233 (AA-1296) ship in a release. The logs core-api, picker and export-logs recordings were made with those fixes. Until that release, core-api's init log carries curl's progress meter, and a full export-logs prints client-go throttling warnings.

What changed

  • install/view-and-export-logs.md (new): a command summary, how targets match pods, and one section each for reading a service's logs, following them, reading the log from before a restart, the pod picker, narrowing by namespace and time, and the support bundle with its layout and a credentials warning.
  • Six animated WebP recordings under static/images/accessanalyzer/26.1/install/, about 2.8 MB in total. They were recorded with VHS against a 26.1 install, and each section has one.
  • install/index.md and install/installer-reference.md: one line each linking to the new page.

Test plan

  • Vale and Dale pass on all three pages (pre-commit quality check)
  • Anchor check passes
  • DOCS_PRODUCT=accessanalyzer build renders the page and the images. Its broken-link list doesn't include this page.
  • Every command and flag on the page was run against the installer on a 26.1 server
  • Build passes in CI

Document dspm-installer logs and export-logs: how targets match pods,
following logs, reading the previous container's log, the pod picker,
namespace and time filters, and the support bundle layout. Each section
has a short recording from a 26.1 install.

Link the page from the install index and the installer reference.
@thobed
thobed requested a review from a team as a code owner October 20, 2026 12:42
@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

1 issues fixed, 1 skipped across 3 files

Category Fixes
Dale: passive-voice 1
Skipped (needs manual review) Reason

| docs/accessanalyzer/26.1/install/installer-reference.md:79 — Dale: passive-voice | 'whose volume isn't mounted' is an adjectival state description of the path; rewriting to active voice would be awkward and risks changing meaning |

Ask @claude on this PR if you'd like an explanation of any fix.

@jth-nw
jth-nw deployed to development October 20, 2026 12:45 — with GitHub Actions Active
… throttling noise

Re-record logs-target and logs-picker on pods whose wait-for-clickhouse
init container no longer prints curl's progress meter, and record
export-logs as a full, untargeted run now that it no longer prints
client-go throttling warnings. The example command matches the new
recording.
@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/accessanalyzer/26.1/install/index.md

No issues found.

docs/accessanalyzer/26.1/install/installer-reference.md

No issues found.

docs/accessanalyzer/26.1/install/view-and-export-logs.md

  • Clarity — Line 7: The page relies on Kubernetes terms ("pod", and on line 49 "init containers") without defining them. The Installation section is written for administrators who may not know Kubernetes, and the rest of the install pages use these terms only inside kubectl commands. Suggested fix: "Every Access Analyzer service runs as a pod (a group of one or more containers) on the server's Kubernetes cluster." On line 49, add a short explanation: "including init containers (containers that run setup tasks before the service starts)."
  • Completeness — Line 37: "A target that matches pods in more than one namespace prints a warning" doesn't tell the reader whether the command still reads all the matching pods, or what to do about the warning. Suggested fix: "A target that matches pods in more than one namespace prints a warning and reads all of them. To read only one, add the namespace prefix."
  • Structure — Line 43: --since is a time filter, but it sits in the flags table under "Choose Which Pods to Read". The page then covers namespaces and --since again in "Narrow by Namespace and Time" (line 101). A reader looking for time filtering may not expect to find it under pod selection. Suggested fix: Move the --since row out of this table and describe it only in "Narrow by Namespace and Time", or rename this section to cover all the scoping flags (for example, "Choose Which Pods and Lines to Read").
  • Clarity — Line 79: "the pod list" isn't defined. It could mean kubectl get pods, the pod picker, or the pod table in the support bundle. The pod picker also isn't introduced until the next section. Suggested fix: "The RESTARTS column in sudo kubectl get pods -A, or the restarts= value in the pod picker, shows which containers have a previous log."
  • Clarity — Line 114: "every pod in the selected namespaces" doesn't say which namespaces are selected when the reader passes no flags. Suggested fix: "With no target, it includes every pod in the default namespaces (access-analyzer and argocd), or in the namespaces you choose with --namespace or --all."
  • Completeness — Line 123: The -o rules cover a path that ends in .tar.gz, a path that ends in a slash, and an existing empty folder, but they don't say what happens with any other path (for example -o ./bundle with no slash, or a folder that isn't empty). Suggested fix: Add one sentence describing that case, for example "Any other path ... " followed by the actual behavior (an error, or a compressed file written to that name).

Summary

6 editorial suggestions across 3 files. Vale and Dale issues are auto-fixed separately.


What to do next:

Comment @claude on this PR followed by your instructions to get help:

  • @claude fix all issues — fix all editorial issues
  • @claude help improve the flow of this document — get writing assistance
  • @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

2 issues fixed, 1 skipped across 3 files

Category Fixes
Dale: passive-voice 2
Skipped (needs manual review) Reason

| docs/accessanalyzer/26.1/install/installer-reference.md:226 — Dale: ing-analysis | Trailing clause 'matching a dry-run install' states a concrete behavior (consistency with dry-run), not an interpretation; ambiguous whether it is a violation |

Ask @claude on this PR if you'd like an explanation of any fix.

@jth-nw
jth-nw deployed to development October 20, 2026 16:12 — with GitHub Actions Active
@jtviolet
jtviolet merged commit 9522e30 into dev Oct 20, 2026
10 checks passed

This branch was successfully deployed

1 active deployment
development — dc883f67 Deployed Oct 20, 2026 by jth-nw via build-and-deploy #4689
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants