Debug log of a plan

Read what the Debugging module writes during calls: one timestamped line per message, grouped by call, kept for seven days.

At a glance

How it works

The Debugging node writes a line as the call passes through, then lets the call continue. It has no other effect: it plays nothing, cuts nothing, and a write that fails does not interrupt the call.

The message text accepts variables, in the form {{variable}}. You can therefore put in it a fixed marker, for example passing through the evening branch, as well as the value of a variable set earlier in the plan.

Each line records the call that produced it. The log groups them: a line separates two successive calls, and the list runs from most recent to oldest.

The time is recorded in universal time and displayed in your browser's time zone. Two people in two countries therefore each read the time local to them.

Beyond the daily cap, a final line announces that the log is truncated, and nothing more is written that day. The cap applies to the whole installation, not to a single plan.

Step by step

1. Open the visual editor of the plan you want to observe.
2. Place a Debugging node on the branch you are interested in and connect it in series: the input comes from the previous node, the output goes on to what follows.
3. Open it and write the message. An empty message writes nothing at all.
4. Click Save.
5. Place a call that takes this branch.
6. Go back to Dial plans and click the notepad icon on the plan's row. Its tooltip reads Debug log.
7. Read the lines. Click Refresh to reread the log after a new call.
8. Remove the Debugging nodes once the diagnosis is done, and save the plan again.

If it doesn't work

"No messages." Three checks, in order: the node is actually connected in the plan and not just placed next to it, the plan has been saved since, and a call has actually taken this branch since.

My message is cut off in the middle. A message is limited to 500 characters. Split it across two nodes if you need more.

A line announces that the log is truncated. The 500-line daily cap has been reached, and nothing more will be written until tomorrow. Remove the Debugging nodes that write on every call and keep only the ones for the diagnosis at hand.

The lines from ten days ago are gone. Retention is seven days. Cleanup happens when the log is viewed.

The displayed time doesn't match the time of the call. Lines are displayed in the time zone of the browser reading them. A device set to a different time zone than your installation will therefore show an offset.