Package intrinsic_proto.status
Messages
message BehaviorTreeNodeReference (Nested in intrinsic_proto.status.ExtendedStatus.Relations ) intrinsic/util/status/extended_status.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | tree_id |
string
|
|
| 2 | node_id |
uint32
|
message DebugReport (Nested in intrinsic_proto.status.ExtendedStatus ) intrinsic/util/status/extended_status.proto
Additional information for debugging by the component owner. This information can be passed on by the system user to investigate an error. This is publicly visible, but is not necessarily expected to be digestible to the user.
Include information meaningful to a debugging journey. There is a limit of the overall amount of data that can be sent in response to an error. This limit applies to the overall hierarchical extended status. Therefore, be mindful and aim for less than 10kB of text for the debug report.
| Field | Type | Description | |
|---|---|---|---|
| 1 | message |
string
|
|
| 2 | stack_trace |
optional
string
|
Optionally a stack trace of an error if useful and not confidential. |
message ExtendedStatus intrinsic/util/status/extended_status.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | status_code |
intrinsic_proto.status.StatusCode
|
|
| 2 | severity |
intrinsic_proto.status.ExtendedStatus.Severity
|
|
| 3 | title |
string
|
One-line summary that can be used as a headline to describe the error. More guidance: https://flowstate.intrinsic.ai/docs/guides/build_with_code/extended_status_guide/ |
| 4 | timestamp |
google.protobuf.Timestamp
|
Time when the error occurred that produced the extended status |
| 5 | context |
repeated
intrinsic_proto.status.ExtendedStatus
|
|
| 6 | related_to |
optional
intrinsic_proto.status.ExtendedStatus.Relations
|
|
| 12 | user_report |
optional
intrinsic_proto.status.ExtendedStatus.UserReport
|
This report is shown to users. It is intended to be helpful to analyze a run-time problem by the caller of the component. |
| 13 | debug_report |
optional
intrinsic_proto.status.ExtendedStatus.DebugReport
|
Debug report intended for developers/owners of the component, but visible to all if they expand it in the UI. This information may not necessarily be helpful to the user to investigate an issue, but to the component developer to investigate a reported issue. |
message Relations (Nested in intrinsic_proto.status.ExtendedStatus ) intrinsic/util/status/extended_status.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | behavior_tree_node |
optional
intrinsic_proto.status.ExtendedStatus.Relations.BehaviorTreeNodeReference
|
|
| 2 | log_context |
optional
intrinsic_proto.data_logger.Context
|
message StatusCode intrinsic/util/status/extended_status.proto
A code that identifies a particular error of the given component.
| Field | Type | Description | |
|---|---|---|---|
| 1 | component |
string
|
A string identifier of the component. This must consist of a package name (examples: ai.intrinsic or com.example) and an entity name (examples: my_skill, my_service). Examples for component strings: ai.intrinsic.executive, com.example.my_skill. |
| 2 | code |
uint32
|
A unique error code. Use values greater than 10000, smaller values are reserved for system and generic errors. |
message UserReport (Nested in intrinsic_proto.status.ExtendedStatus ) intrinsic/util/status/extended_status.proto
An actionable report of the error to be read by the user of the system.
More guidance: https://flowstate.intrinsic.ai/docs/guides/build_with_code/extended_status_guide/
| Field | Type | Description | |
|---|---|---|---|
| 1 | message |
string
|
|
| 2 | instructions |
string
|
Enums
enum Severity intrinsic/util/status/extended_status.proto
| Name | Number | Description |
|---|---|---|
DEFAULT |
0 | Default log severity is info unless otherwise specified. |
INFO |
0 | Severity values are the same as the ones for absl::LogSeverity. |
WARNING |
1 | |
ERROR |
2 | |
FATAL |
3 |