uipath-insights

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

UiPath Insights

Use

uip insights

for job monitoring and monitoring-scope discovery. Read the guide for the task before running commands.

使用

uip insights

进行任务监控和监控范围发现。在运行命令前，请阅读对应任务的指南。

When to Use This Skill

适用场景

Job health, success rate, failure count, or processing time across a tenant, folder, or process
Job trends over time, or a comparison between two periods
Which processes fail most, and which failure reasons recur
Whether jobs are stuck, pending, or still running
Finding the exact folder key, process name, queue name, or machine name to scope a query by

租户、文件夹或流程下的任务健康状况、成功率、故障数量或处理时长
任务随时间变化的趋势，或两个时间段的对比情况
哪些流程故障频率最高，哪些故障原因重复出现
任务是否处于停滞、待处理或仍在运行状态
查找用于限定查询范围的准确文件夹密钥、流程名称、队列名称或机器名称

Critical Rules

核心规则

Use
--output json
.
```
jobs
```
commands return
```
{ Result, Code, Data }
```
.
```
filter-*
```
commands add
```
Pagination
```
and
```
Instructions
```
; quote those
```
Instructions
```
in the explanation. A failure envelope carries
```
Result
```
,
```
Message
```
,
```
Instructions
```
,
```
ErrorCode
```
, and
```
Retry
```
, with no
```
Code
```
and no
```
Data
```
. Keys inside
```
Data
```
are PascalCase on the wire, so read
```
FolderKey
```
and
```
JobsCount
```
, not
```
folderKey
```
or
```
jobsCount
```
.
One subcommand per invocation, written literally. Do not chain, loop, or parameterize
```
uip insights
```
commands: no
```
&&
```
or
```
;
```
chains, no
```
for
```
loops, and no shell variables holding the subcommand name or flag values. Resolve values such as epoch timestamps in a separate command first, then pass literal numbers. Never write
```
$(date ...)
```
or
```
$VAR
```
into a flag value.
Use only the flags the guides document. Identity, organization, and tenant come from the active session. Any tenant flag you find is deprecated and is rejected outright on
```
filter-*
```
commands, so do not use one. If a filter is not in the guide's shared-options list, it does not exist.
Every
jobs
command needs a time range. Pass
```
--time-range <minutes>
```
(60 = 1h, 1440 = 24h, 10080 = 7d, 43200 = 30d), or both
```
--started-after
```
and
```
--started-before
```
. Omitting both is rejected locally and exits 1.
```
filter-*
```
commands take no time flags.
Start with
summary
, then drill down. After any scope discovery the task needs, begin a job investigation with
```
uip insights jobs summary
```
for the totals, then run the targeted subcommands. The summary supplies the denominator that makes a failure count meaningful.
Treat empty data as bounded evidence. Empty results can reflect the chosen time window, the recent-activity window, caller visibility, or tenant provisioning. They do not prove that a resource or event never existed.
Use the CLI instead of raw Insights APIs. It owns authentication, tenant routing, validation, and error handling.
Do not retry automatically. Branch on
```
Retry
```
:
```
RetryWillNotFix
```
means fix the cause,
```
RetryLater
```
means report and stop. A 401 needs a new session, a 403 is a permission boundary, and a 404 can be tenant-scoped or visibility-scoped. Each guide documents the error shapes for its own commands.
Never run
uip login
yourself. It opens an interactive browser flow that will hang the session. Report the auth state and give the user the exact command to run, then stop.
Discover identifiers instead of guessing. Use
```
references/filter-discovery-guide.md
```
to resolve monitoring scope. Page through all results before concluding a resource is absent.
Hand off causal debugging. Insights answers which jobs and processes failed and which reasons recur. It does not explain one job's exception or how to fix it. Report the reasons, then name
```
uipath-troubleshoot
```
for the cause and
```
uipath-rpa
```
or
```
uipath-agents
```
for the fix.

使用
--output json
格式。
```
jobs
```
命令返回
```
{ Result, Code, Data }
```
。
```
filter-*
```
命令会额外返回
```
Pagination
```
和
```
Instructions
```
；在解释时请引用这些
```
Instructions
```
内容。失败响应包包含
```
Result
```
,
```
Message
```
,
```
Instructions
```
,
```
ErrorCode
```
, 和
```
Retry
```
，不包含
```
Code
```
和
```
Data
```
。传输过程中
```
Data
```
内的键采用PascalCase格式，因此请读取
```
FolderKey
```
和
```
JobsCount
```
，而非
```
folderKey
```
或
```
jobsCount
```
。
每次调用仅使用一个子命令，按字面编写。 不要链式调用、循环或参数化
```
uip insights
```
命令：不使用
```
&&
```
或
```
;
```
链式操作，不使用
```
for
```
循环，也不使用shell变量存储子命令名称或标志值。请先通过单独命令解析时间戳等数值，再传入字面量数字。切勿在标志值中写入
```
$(date ...)
```
或
```
$VAR
```
。
仅使用指南中记录的标志。 身份、组织和租户信息来自当前会话。任何租户标志均已弃用，且
```
filter-*
```
命令会直接拒绝此类标志，因此请勿使用。如果某个筛选器不在指南的共享选项列表中，则表示该筛选器不存在。
每个
jobs
命令都需要指定时间范围。传入
```
--time-range <minutes>
```
（60=1小时，1440=24小时，10080=7天，43200=30天），或同时传入
```
--started-after
```
和
```
--started-before
```
。两者都省略会被本地拒绝并以状态码1退出。
```
filter-*
```
命令不接受时间标志。
从
summary
开始，逐步深入。在完成任务所需的范围发现后，先运行
```
uip insights jobs summary
```
获取任务总数，再运行针对性的子命令进行任务调查。汇总信息为故障数量提供了有意义的参考基数。
将空数据视为有边界的证据。 空结果可能反映所选时间窗口、近期活动窗口、调用者可见性或租户配置情况，并不证明某个资源或事件从未存在。
使用CLI而非原生Insights API。 CLI负责处理身份验证、租户路由、验证和错误处理。
不要自动重试。 根据
```
Retry
```
字段进行分支处理：
```
RetryWillNotFix
```
表示需要修复问题根源，
```
RetryLater
```
表示上报后停止操作。401错误需要重新建立会话，403错误表示存在权限边界，404错误可能与租户范围或可见性范围有关。每个指南都会记录其对应命令的错误格式。
切勿自行运行
uip login
命令。该命令会打开交互式浏览器流程，导致会话挂起。请上报认证状态，并告知用户需运行的精确命令，然后停止操作。
通过发现获取标识符，而非猜测。 使用
```
references/filter-discovery-guide.md
```
确定监控范围。在得出资源不存在的结论前，请遍历所有结果页。
移交因果调试工作。 Insights仅能回答哪些任务和流程发生故障，以及哪些原因重复出现。它无法解释单个任务的异常情况或修复方法。请上报故障原因，然后指定使用
```
uipath-troubleshoot
```
进行原因分析，使用
```
uipath-rpa
```
或
```
uipath-agents
```
进行修复。

Shared Workflow

通用工作流

Check the active login when the task will call UiPath Cloud:
bash
```
uip login status --output json
```
Read the guide the Task Navigation table below names for this task.
Run the subcommand and parse
```
Data
```
for the result. On
```
filter-*
```
commands also read
```
Pagination
```
for list completeness.

Default to the active Production session. Change authority, organization, or tenant only when the user explicitly names another environment or scope. Give the user the command to run rather than running it yourself:

bash

uip login --authority https://cloud.uipath.com --tenant MyTenant   # named environment
uip login tenant set MyTenant                                      # same environment, different tenant

当任务需要调用UiPath云服务时，检查当前登录状态：
bash
```
uip login status --output json
```
阅读下方任务导航表中为当前任务指定的指南。
运行子命令并解析
```
Data
```
字段获取结果。对于
```
filter-*
```
命令，还需读取
```
Pagination
```
字段判断列表是否完整。

默认使用当前的Production会话。仅当用户明确指定其他环境或范围时，才更改权限、组织或租户。请告知用户需运行的命令，而非自行执行：

bash

uip login --authority https://cloud.uipath.com --tenant MyTenant   # 指定环境
uip login tenant set MyTenant                                      # 同一环境，切换租户

Task Navigation

任务导航

User's task	Read first
Check job health, success rate, trends, failures, stuck jobs, or compare periods	`references/investigation-playbook-guide.md`
Choose a Jobs subcommand, flag, time range, or interpret its response fields	`references/jobs-commands-guide.md`
Answer which folders, processes, queues, or machines are visible, or resolve an exact folder key, process name, or machine name to filter by	`references/filter-discovery-guide.md`

Read only the guides the task needs. A job investigation that must first resolve a folder, process, or machine needs the filter guide, then the jobs guide.

用户任务	优先阅读指南
检查任务健康状况、成功率、趋势、故障、停滞任务或对比时间段	`references/investigation-playbook-guide.md`
选择Jobs子命令、标志、时间范围或解释其响应字段	`references/jobs-commands-guide.md`
查询可见的文件夹、流程、队列或机器，或确定用于筛选的准确文件夹密钥、流程名称或机器名称	`references/filter-discovery-guide.md`

仅阅读任务所需的指南。如果任务调查需要先确定文件夹、流程或机器范围，则需先阅读筛选指南，再阅读任务指南。

Scope Boundaries

范围边界

uip insights

ships two command families:

jobs

and

filter-folders

filter-processes

filter-queues

filter-machines

. If a request needs anything else, say it is not available rather than guessing a subcommand.

Request	Route
Start, stop, restart, or inspect logs for an individual Orchestrator job	`uipath-platform`
Diagnose the root cause of a specific job error	`uipath-troubleshoot`
Fix the workflow or agent that caused a failure	`uipath-rpa` or `uipath-agents`
Query queue item metrics	Not supported; `filter-queues` discovers queue scope only
Alert definitions, dashboards, or robot utilization	Not in the shipped `uip insights` surface

uip insights

包含两类命令：

jobs

和

filter-folders

filter-processes

filter-queues

filter-machines

。如果请求需要其他功能，请告知该功能不可用，而非猜测子命令。

请求内容	处理路径
启动、停止、重启单个Orchestrator任务或检查其日志	`uipath-platform`
诊断特定任务错误的根本原因	`uipath-troubleshoot`
修复导致故障的工作流或代理	`uipath-rpa` 或 `uipath-agents`
查询队列项指标	不支持； `filter-queues` 仅用于发现队列范围
告警定义、仪表板或机器人利用率	不在 `uip insights` 的已发布功能范围内

Anti-patterns

反模式

Do not add
```
--limit
```
or
```
--offset
```
to a
```
jobs
```
command. Only
```
filter-*
```
commands page.
Do not reuse an identifier from an example. Folder keys, process names, and machine names come from a
```
filter-*
```
result or from the user.

不要在
```
jobs
```
命令中添加
```
--limit
```
或
```
--offset
```
参数。只有
```
filter-*
```
命令支持分页。
不要复用示例中的标识符。文件夹密钥、流程名称和机器名称需来自
```
filter-*
```
命令的结果或用户提供的信息。

Completion Output

完成输出

Close with the answer, the window queried, the active organization and tenant, and the filters applied. For

filter-*

results, say whether every page was retrieved. For permission-limited or empty results, state what the result does and does not prove.

结尾需包含答案、查询的时间窗口、当前组织和租户，以及应用的筛选条件。对于

filter-*

命令的结果，请说明是否已获取所有结果页。对于受权限限制或空结果，请说明该结果能证明什么、不能证明什么。