appsignal

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

AppSignal CLI

Use the

appsignal-cli

CLI to fetch error incidents and samples from AppSignal for debugging and analysis.

使用

appsignal-cli

CLI从AppSignal获取错误事件和样本，用于调试和分析。

Prerequisites

前提条件

Ensure

APPSIGNAL_TOKEN

and

APPSIGNAL_APP_ID

environment variables are set, or a

.appsignal-cli.yaml

config file exists.

确保已设置

APPSIGNAL_TOKEN

和

APPSIGNAL_APP_ID

环境变量，或存在

.appsignal-cli.yaml

配置文件。

Common Workflows

常见工作流程

Investigate Recent Errors

排查近期错误

bash

undefined

bash

undefined

List open incidents

列出未解决的事件

appsignal-cli incidents list

Get details for a specific incident

获取特定事件的详情

appsignal-cli incidents get <number>

undefined

appsignal-cli incidents get <number>

undefined

Filter Incidents

筛选事件

bash

undefined

bash

undefined

By state: open, closed, wip

按状态筛选：未解决（open）、已关闭（closed）、处理中（wip）

appsignal-cli incidents list --state open

By namespace: web, background, frontend

按命名空间筛选：web、background、frontend

appsignal-cli incidents list --namespace web

By date (ISO 8601)

按日期筛选（ISO 8601格式）

appsignal-cli incidents list --since 2024-01-15

By minimum occurrences

按最小出现次数筛选

appsignal-cli incidents list --min-occurrences 10

Combine filters

组合筛选条件

appsignal-cli incidents list --namespace background --min-occurrences 5

undefined

appsignal-cli incidents list --namespace background --min-occurrences 5

undefined

Get Detailed Error Information

获取详细错误信息

bash

undefined

bash

undefined

Standard detail view

标准详情视图

appsignal-cli incidents get <number>

With params and session data

包含参数和会话数据

appsignal-cli --verbose incidents get <number>

Export as markdown for analysis

导出为markdown格式用于分析

appsignal-cli incidents export <number> -o error-report.md

undefined

appsignal-cli incidents export <number> -o error-report.md

undefined

Work with Error Samples

处理错误样本

bash

undefined

bash

undefined

List recent error samples

列出近期错误样本

appsignal-cli samples list --limit 10

Get full sample details (params, session, environment)

获取完整样本详情（参数、会话、环境信息）

appsignal-cli samples get <sample-id>

undefined

appsignal-cli samples get <sample-id>

undefined

Manage Incidents

管理事件

bash

undefined

bash

undefined

Close a resolved incident

关闭已解决的事件

appsignal-cli incidents close <number>

Reopen if issue recurs

当问题复发时重新打开事件

appsignal-cli incidents reopen <number>

undefined

appsignal-cli incidents reopen <number>

undefined

Output Formats

输出格式

Use

--compact

for token-efficient output when analyzing errors:

bash

appsignal-cli --compact incidents list
appsignal-cli --compact incidents get <number>

Use

--json

for structured data:

bash

appsignal-cli --json incidents list

分析错误时，使用

--compact

参数获取精简输出，节省token：

bash

appsignal-cli --compact incidents list
appsignal-cli --compact incidents get <number>

使用

--json

参数获取结构化数据：

bash

appsignal-cli --json incidents list

Debugging Steps

调试步骤

When asked to debug an AppSignal error:

List incidents to find the relevant error
Get incident details including backtrace
Analyze the backtrace to identify the root cause
Find the relevant code in the codebase
Propose a fix based on the error context

当需要调试AppSignal捕获的错误时：

列出事件以找到相关错误
获取事件详情，包括调用栈
分析调用栈以确定根本原因
在代码库中找到相关代码
根据错误上下文提出修复方案

Available Commands

可用命令

Command	Description
`apps`	List all applications
`incidents list`	List error incidents
`incidents get <n>`	Get incident details
`incidents close <n>`	Close an incident
`incidents reopen <n>`	Reopen an incident
`incidents export <n>`	Export to markdown
`samples list`	List error samples
`samples get <id>`	Get sample details
`config show`	Show current config
`config init`	Initialize config file
`config set <k> <v>`	Set config value

命令	描述
`apps`	列出所有应用
`incidents list`	列出错误事件
`incidents get <n>`	获取事件详情
`incidents close <n>`	关闭事件
`incidents reopen <n>`	重新打开事件
`incidents export <n>`	导出为markdown格式
`samples list`	列出错误样本
`samples get <id>`	获取样本详情
`config show`	显示当前配置
`config init`	初始化配置文件
`config set <k> <v>`	设置配置值