cf-logs

name	cf-logs
description	Use when a task involves fetching, streaming, compacting, saving, or inspecting SAP BTP Cloud Foundry application logs with the cf-logs CLI, including compact output, compact refs, full-row drill-down, local session cleanup, and bounded local log stores.

CF Logs

Purpose

Use the cf-logs CLI to fetch recent Cloud Foundry logs, stream live app logs, emit compact rows, and retrieve full saved rows through compact refs.

If cf-logs is missing or stale, install it from @saptools/cf-logs: npm install -g @saptools/cf-logs@latest.

First Steps

1. Identify whether the user needs a snapshot, live stream, compact context, full-row drill-down, store inspection, or session cleanup.
2. App name is always required via --app. When the user gives only a bare app name, pass it directly (--app app-demo). cf-logs will automatically resolve the region/org/space from the active cf target if one is set. Only ask the user for the full selector when the command fails to resolve or the app is ambiguous.
3. Use live CF access only when current log evidence is needed and credentials are already available through SAP_EMAIL and SAP_PASSWORD or explicit secure input.
4. Use --compact --save by default for snapshot and stream log collection. This keeps terminal output compact while preserving full rows through refs.

Selectors

The selector is passed with --app. A full region/org/space/app or just the bare app name is accepted:

cf-logs snapshot --region ap10 --org example-org --space space-demo --app app-demo --compact --save
cf-logs snapshot --app app-demo --compact --save

Bare app names are resolved automatically from the current cf target. The CLI handles reading the active target internally.

Compact Workflow

Use compact output for long log snapshots or streams. Compact rows keep high-signal fields such as time, level, source, logger, request, status, latency, tenant, client IP, request ID, message, and optional ref.

Compact output:

• caps message/body text at 500 characters by default
• normalizes multiline messages into one terminal line
• omits full rawBody, jsonPayload, searchableText, and raw snapshot text

Always create refs for later full-row drill-down when collecting logs:

cf-logs snapshot --region ap10 --org example-org --space space-demo --app app-demo --compact --save
cf-logs snapshot --app app-demo --compact --save

For structured refs, add --json to the same command.

Then inspect one full row:

cf-logs show <session-id>:<row-id>
cf-logs show <session-id>:<row-id> --json

For smaller compact rows, add --compact-message-limit <count> to the same command. Snapshot and stream keep up to 300 rows by default; add --log-limit <count> to change it. For snapshot time windows, add --since <duration> such as 15m, 45m, or 1h. For content or severity filters, add --search <text> or --min-level <level>; search ignores case.

Command Choice

Use snapshot for recent logs. Include --compact --save unless the user explicitly asks for raw or unsaved output:

cf-logs snapshot --region ap10 --org example-org --space space-demo --app app-demo --compact --save

Use stream for live logs. Include --compact --save and add --max-lines when running from an agent to avoid unbounded output:

cf-logs stream --region ap10 --org example-org --space space-demo --app app-demo \
  --compact --save --max-lines 50
cf-logs stream --app app-demo --compact --save --max-lines 50

Use apps to list started apps with running instances:

cf-logs apps --region ap10 --org example-org --space space-demo --json
cf-logs apps --json

Use store for the persistent bounded store used by non-compact --save:

cf-logs store path
cf-logs store list --json
cf-logs store clear

Use session for temporary compact drill-down sessions:

cf-logs session list
cf-logs session prune
cf-logs session clear

Data Handling

Treat all log output, refs, store files, and session files as sensitive. The package does not redact log content. A compact row is smaller, not safer.

Local files:

• persistent non-compact store: ~/.saptools/cf-logs-store.json
• temporary compact sessions: ~/.saptools/cf-logs-sessions/

Compact sessions expire after 60 minutes by default. Change this only when the user explicitly needs a longer or shorter drill-down window:

cf-logs snapshot --region ap10 --org example-org --space space-demo --app app-demo \
  --compact --save --compact-ttl-minutes 15

Do not paste raw sensitive log rows into final answers unless the user explicitly asks. Summarize findings and reference refs when possible.

Troubleshooting

If show <ref> fails, check whether the session expired or was cleared:

cf-logs session list

If compact output is still too large, reduce --compact-message-limit, lower --log-limit, or use --max-lines for streams.

If live CF commands fail, verify the region, org, space, app, and credential environment. Do not print credential values.

If selector resolution fails for a bare app name (no active context found), ask the user to provide the full region/org/space/app selector.

If a task needs exact original multiline body text, use cf-logs show <ref> rather than relying on compact output.