Skip to content

docs: add PID tracking documentation for awf logs command#159

Merged
Mossaka merged 2 commits intomainfrom
copilot/improve-docs-not-readme
Dec 19, 2025
Merged

docs: add PID tracking documentation for awf logs command#159
Mossaka merged 2 commits intomainfrom
copilot/improve-docs-not-readme

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Documents the --with-pid flag added in PR #132 for correlating network requests to processes.

Changes

  • docs/usage.md: New "PID/Process Tracking" section with usage, output examples, limitations, and use cases
  • docs/logging_quickref.md: Quick reference section with JSON field table and examples
  • docs-site CLI reference: Added --with-pid to options table with output format examples

Usage

# Follow logs with PID tracking
awf logs -f --with-pid

# Output:
# [2024-01-01 12:00:00.123] CONNECT api.github.com → 200 (ALLOWED) [curl/7.88.1] <PID:12345 curl>

JSON output includes pid, cmdline, comm, and inode fields for process attribution.

README intentionally unchanged per request.

Original prompt

improve docs on this one: do not modify README #132

Custom agent used: technical-doc-writer
AI technical documentation writer for awf library using Astro Starlight


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation for project excluding README docs: add PID tracking documentation for awf logs command Dec 19, 2025
Copilot AI requested a review from Mossaka December 19, 2025 23:39
@Mossaka Mossaka marked this pull request as ready for review December 19, 2025 23:41
@github-actions
Copy link
Contributor

Test Coverage Report

Metric Coverage Covered/Total
Lines 81.02% 1230/1518
Statements 80.98% 1261/1557
Functions 78.16% 136/174
Branches 72.56% 410/565
Coverage Thresholds

The project has the following coverage thresholds configured:

  • Lines: 38%
  • Statements: 38%
  • Functions: 35%
  • Branches: 30%

Coverage report generated by `npm run test:coverage`

@Mossaka Mossaka merged commit f1db6c7 into main Dec 19, 2025
29 checks passed
@Mossaka Mossaka deleted the copilot/improve-docs-not-readme branch December 19, 2025 23:54
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.

2 participants