Page MenuHomeDevCentral
Create Task
Maniphest T1790

Trace eggdrop errors
Open, NormalPublic
Actions

Description

Trace could be a payload with global variables errorCode, errorInfo and the new TCL 8.6 command info errorstack.

For example:

Wearg partyline
17:24:36 <Dereckson> .tcl putdebug $errorInfo
17:24:36 <Wearg> [DEBUG] can not find channel named "sock8018e0910"
17:24:36 <Wearg>     while executing
17:24:36 <Wearg> "eof $sock"
17:24:36 <Wearg> Tcl:

17:24:39 <Dereckson> .tcl putdebug $errorCode
17:24:39 <Wearg> [DEBUG] TCL LOOKUP CHANNEL sock8018e0910
17:24:39 <Wearg> Tcl:

17:25:04 <Dereckson> .tcl info errorstack
17:25:04 <Wearg> Tcl: INNER {invokeStk1 eof sock8018e0910} CALL {http::Event sock8018e0910 ::http::5}

A payload could be generated from those three values:

Payload
errorCode: TCL LOOKUP CHANNEL sock8018e0910
errorInfo: |
    can not find channel named "sock8018e0910"
         while executing
    "eof $sock"
errorstack: |
    INNER {invokeStk1 eof sock8018e0910} CALL {http::Event sock8018e0910 ::http::5}

We can watch $errorInfo to trigger a method to report the trace:

Trace code
trace add variable ::errorInfo write {
    # Generate payload
    # Log it or send it to Sentry
}

Documentation for that is located at https://wiki.tcl-lang.org/page/Traces

Revisions and Commits

rOPS Nasqueron Operations
D2900rOPS642bf17d707f Deploy Relay for SDK development on Dwellers
D2899rOPSbb6e7f795437 Allow eggdrop to run Git commands on repositories

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedderecksonT1791 Refresh Sentry installation
 OpenNoneT1790 Trace eggdrop errors

Event Timeline

dereckson triaged this task as Normal priority.Mar 7 2023, 17:38
dereckson created this task.
dereckson mentioned this in T1791: Refresh Sentry installation.Mar 7 2023, 17:47
dereckson added a parent task: T1791: Refresh Sentry installation.Mar 7 2023, 17:51
dereckson added a comment.EditedMar 9 2023, 01:11

To create the payload, we can use a dictionary: [dict create code "$::errorCode" info "$::errorInfo" stack [info errorstack]].

It can then represented as a JSON payload ready to be send to Sentry or a log:

Error traced as a JSON payload
01:09:14 <Dereckson> .tcl incr x
01:09:14 <Wearg> Tcl error: expected integer but got "a"

01:09:30 <Dereckson> .tcl dict2json [dict create code "$::errorCode" info "$::errorInfo" stack [info errorstack]]
01:09:30 <Wearg> Tcl: {
01:09:30 <Wearg> Tcl:     "code"  : "TCL VALUE INTEGER",
01:09:30 <Wearg> Tcl:     "info"  : "expected integer but got \"a\"\n    while executing\n\"incr x\"",
01:09:30 <Wearg> Tcl:     "stack" : "INNER {incr x} UP 1"
01:09:30 <Wearg> Tcl: }

Seems my dict2json expects every value to be a string,
but [info errorstack] returns a dictionary, so let's use this:

Wearg :: Correct JSON payload
01:13:17 <Dereckson> .tcl ::json::write object code [::json::write string $errorCode] info [::json::write string $errorInfo] stack [dict2json [info errorstack]]
01:13:17 <Wearg> Tcl: {
01:13:17 <Wearg> Tcl:     "code"  : "TCL VALUE INTEGER",
01:13:17 <Wearg> Tcl:     "info"  : "expected integer but got \"a\"\n    while executing\n\"incr x\"",
01:13:17 <Wearg> Tcl:     "stack" : {
01:13:17 <Wearg> Tcl:         "INNER" : "incr x",
01:13:17 <Wearg> Tcl:         "UP"    : "1"
01:13:17 <Wearg> Tcl:     }
01:13:17 <Wearg> Tcl: }

To test what it can reports, I've added this:

Wearg :: Error payload to partyline
trace add variable ::errorInfo write {
    set error_payload [dict create code "$::errorCode" info "$::errorInfo" stack [info errorstack]]
    putdebug "Error traced: $error_payload" ;#
}
dereckson added a comment.Mar 15 2023, 00:13

An issue with the code above is [info errorstack] gives the previous error call stack. It will update when we're done with the error.

I'm adding to Tech.tcl the following error context with:

  • a generic part, to be handled by the Sentry TCL toolkit/SDK
  • a specialized part

P314 Build error context for ViperServ eggdrops
1#
2# Error handling
3#
4
5proc build_error_context {} {
6 global username version
7
8 # Should be done by Sentry TCL toolkit
9 set context [dict create tcl_version [info patchlevel]]
10 dict append context nameofexecutable [info nameofexecutable]
11 dict append context environment [array get ::env]
12 dict append context extensions [info loaded]
13 dict append context error [dict create code $::errorCode info $::errorInfo stack [info errorstack]]
14
15 # Can only be done by us
16 set app_context [dict create username $username eggdrop_version $version]
17 dict append app_context scripts_version [exec sh -c "cd scripts && git rev-parse HEAD"]
18
19 dict merge $context $app_context
20}

From there, a short timer can call error management:

trace add variable ::errorInfo write {
    utimer 10 handle_error [clock microseconds]
}

proc handle_error {time} {
   set context [build_error_context]
   dict append context time $time

   sentry_send [vault_get sentry dsn] $context
}
dereckson added a revision: D2899: Allow eggdrop to run Git commands on repositories.Mar 16 2023, 18:18
dereckson added a commit: rOPSbb6e7f795437: Allow eggdrop to run Git commands on repositories.Mar 16 2023, 18:23
dereckson added a revision: D2900: Deploy Relay for SDK development on Dwellers.Mar 16 2023, 18:33
dereckson added a commit: rOPS642bf17d707f: Deploy Relay for SDK development on Dwellers.Mar 16 2023, 18:36
dereckson moved this task from Backlog to Sentry on the Monitoring and reporting board.Apr 2 2023, 10:23
dereckson moved this task from Backlog to Eggdrop dev on the IRC board.May 1 2023, 20:36
Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator