Skip to content

Commit 1af1742

Browse files
committed
docs: update COMMANDS.md and EXAMPLES.md for new apm and fleet commands
Add apm troubleshooting list to command index, and usage examples for apm troubleshooting list and fleet agents list --filter.
1 parent ae62b2e commit 1af1742

2 files changed

Lines changed: 26 additions & 1 deletion

File tree

docs/COMMANDS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pup <domain> <subgroup> <action> [options] # Nested commands
5050
| error-tracking | issues (search, get) | src/commands/error_tracking.rs ||
5151
| scorecards | list, get | src/commands/scorecards.rs ||
5252
| usage | summary, hourly | src/commands/usage.rs ||
53-
| apm | services (list, stats, operations, resources), entities (list), dependencies (list), flow-map | src/commands/apm.rs ||
53+
| apm | services (list, stats, operations, resources), entities (list), dependencies (list), flow-map, troubleshooting (list) | src/commands/apm.rs ||
5454
| cost | projected, attribution, by-org, aws-config (list, get, create, delete), azure-config (list, get, create, delete), gcp-config (list, get, create, delete) | src/commands/cost.rs ||
5555
| product-analytics | events send | src/commands/product_analytics.rs ||
5656
| data-governance | scanner-rules (list) | src/commands/data_governance.rs ||

docs/EXAMPLES.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,17 @@ pup security findings search \
285285
--query="@severity:high"
286286
```
287287

288+
## APM Troubleshooting
289+
290+
### List Instrumentation Errors for a Host
291+
```bash
292+
# Show APM instrumentation errors for a specific host
293+
pup apm troubleshooting list --hostname my-host
294+
295+
# Narrow results to a specific time window
296+
pup apm troubleshooting list --hostname my-host --timeframe 4h
297+
```
298+
288299
## Infrastructure
289300

290301
### List Hosts
@@ -296,6 +307,20 @@ pup infrastructure hosts list
296307
pup infrastructure hosts list --filter="env:production"
297308
```
298309

310+
## Fleet
311+
312+
### List Fleet Agents
313+
```bash
314+
# Filter agents by hostname
315+
pup fleet agents list --filter "hostname:my-host"
316+
317+
# Filter by IP address
318+
pup fleet agents list --filter "ip_address:1.2.3.4"
319+
320+
# Boolean filter expression
321+
pup fleet agents list --filter "(hostname:host-a OR hostname:host-b) AND env:prod"
322+
```
323+
299324
### Get Host
300325
```bash
301326
pup infrastructure hosts get "host-name"

0 commit comments

Comments
 (0)