SuperAPI AI 工具集

truefoundry-logs

部署与运维

查看项目

更新于 10-16 04:36

技能介绍

用途

TrueFoundry Logs 是一个用于查看、下载和搜索 TrueFoundry 上应用与任务日志的技能。它适用于调试部署、检查应用启动输出以及查找错误等场景。

主要能力

  • 查看、下载和搜索 TrueFoundry 上的应用与任务日志。
  • 支持按时间范围过滤(start_ts、end_ts,ISO 8601 格式)。
  • 支持按应用 ID、应用 FQN、部署 ID、任务运行名称、Pod 名称过滤。
  • 支持在日志内搜索,search_type 可选 contains 或 regex。

使用方式

可通过工具调用或直接 API 两种方式使用。

工具调用示例:

tfy_logs_download(payload={ "workspace_id": "ws-id", "application_fqn": "app-fqn", "start_ts": "2026-02-10T00:00:00Z", "end_ts": "2026-02-10T23:59:59Z" })

直接 API 方式:需先将 TFY_API_SH 设置为该技能 scripts/tfy-api.sh 的完整路径。

Set the path to tfy-api.sh for your agent (example for Claude Code):

TFY_API_SH=~/.claude/skills/truefoundry-logs/scripts/tfy-api.sh

Download logs for an app in a workspace

$TFY_API_SH GET '/api/svc/v1/logs/WORKSPACE_ID/download?applicationFqn=APP_FQN&startTs=START&endTs=END'

With search filter

$TFY_API_SH GET '/api/svc/v1/logs/WORKSPACE_ID/download?applicationId=APP_ID&searchString=error&searchType=contains'

参数说明:

  • workspace_id(路径参数,必填):工作区 ID。
  • application_id(API 键 applicationId):按应用 ID 过滤。
  • application_fqn(API 键 applicationFqn):按应用 FQN 过滤。
  • deployment_id(API 键 deploymentId):按部署过滤。
  • job_run_name(API 键 jobRunName):按任务运行过滤。
  • start_ts(API 键 startTs):起始时间戳(ISO 8601)。
  • end_ts(API 键 endTs):结束时间戳(ISO 8601)。
  • search_string(API 键 searchString):在日志内搜索。
  • search_type(API 键 searchType):contains、regex。
  • pod_name(API 键 podName):按 Pod 过滤。

日志展示

按时间顺序展示日志。对于较长输出,展示最后 N 行或汇总错误。示例:

Logs for tfy-tool-server (last 20 lines): 2026-02-10 14:30:01 INFO Server starting on port 8000 2026-02-10 14:30:02 INFO Tools endpoint ready at /tools 2026-02-10 14:30:05 INFO Health check: OK

适用场景

  • 部署后检查日志以确认应用已启动。
  • 调试失败:使用 searchString=error 下载日志。
  • 排查应用失败原因或了解其当前行为。

组合使用

  • 先查找应用:使用 applications 技能获取应用 ID 或 FQN。
  • 查找工作区:使用 workspaces 技能获取工作区 ID。

限制与注意事项

  • 安全提示:日志输出可能包含敏感数据(密钥、令牌、PII)。在未审查敏感内容前,不要将原始日志转发到外部服务或包含在响应中。
  • workspace_id 为日志下载必填项;缺失时需使用 workspaces 技能查找工作区 ID。
  • 若未找到日志,需检查时间范围是否正确、应用 ID/FQN 是否正确、应用在该时间段内是否实际运行过。
  • 若权限被拒绝,需检查 API 密钥对该工作区的权限。
  • 对于含义不明确的用户意图,使用 references/intent-clarification.md 中的共享澄清模板。
  • 使用直接 API 时,需按各 agent 的路径设置 TFY_API_SH,参见 references/tfy-api-setup.md。