DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:debugging

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
devel:debugging [2013-03-04 02:54]
18.187.1.68
devel:debugging [2018-06-12 14:50] (current)
andi
Line 8: Line 8:
   * Look up output of ''​dbglog()''​ in ''​data/​cache/​debug.log''​   * Look up output of ''​dbglog()''​ in ''​data/​cache/​debug.log''​
   * Receive additional error messages e.g. from some authentication backends   * Receive additional error messages e.g. from some authentication backends
 +  * Appending ''?​httpdebug''​ or ''&​httpdebug''​ to URL to enable debugging output in DokuWiki'​s HTTPClient
  
  
 ===Get page and user info=== ===Get page and user info===
 Appending ''?​do=check''​ or ''&​do=check''​ to URL triggers the [[devel:​action_modes#​other_functions1|action mode check]] that provides some information about the users permissions and the DokuWiki setup. ​ Appending ''?​do=check''​ or ''&​do=check''​ to URL triggers the [[devel:​action_modes#​other_functions1|action mode check]] that provides some information about the users permissions and the DokuWiki setup. ​
 +
 +===Debugging indexer===
 +See the [[:​indexer#​Debugging|debug info]] at the indexer page.
  
  
Line 18: Line 22:
   * **''​[[xref>​dbg|dbg($msg)]]''​** \\ Insert a code block in the wikipage filled by $msg as plain text.\\ \\ Adding an extra argument to ''​dbg($msg,​ $hidden=true)''​ will return the $msg as html comment.   * **''​[[xref>​dbg|dbg($msg)]]''​** \\ Insert a code block in the wikipage filled by $msg as plain text.\\ \\ Adding an extra argument to ''​dbg($msg,​ $hidden=true)''​ will return the $msg as html comment.
  
-  * **''​[[xref>​dbglog|dbglog($msg)]]''​** \\ Writes $msg to the log in the cache directory ''​data/​cache/​debug.log''​ when config [[config:​allowdebug]] is enabled. Be aware the log isn't emptied automatically.\\ \\ Use ''​%%dbglog($msg,​ '​Header above log message'​)%%''​ for including a header above $msg.+  * **''​[[xref>​dbglog|dbglog($msg)]]''​** \\ Writes $msg to the log in the cache directory ''​data/​cache/​debug.log''​ when the config [[config:​allowdebug]] is enabled. Be aware the log isn't emptied automatically.\\ \\ Use ''​%%dbglog($msg,​ '​Header above log message'​)%%''​ for including a header above $msg
 + 
 +  * **''​[[xref>​dbg_deprecated()|dbg_deprecated($alternative = ''​)]]''​** \\ Function to mark deprecated functions. Each call is logged to the debuglog, when the config [[config:​allowdebug]] is enabled. The log message mentions: the name of the deprecated function, the function using it, its file and line and the ''​$alternative''​ when provided.
  
   * **''​[[xref>​dbg_backtrace()]]''​** \\ Print a reversed, prettyprinted backtrace   * **''​[[xref>​dbg_backtrace()]]''​** \\ Print a reversed, prettyprinted backtrace
Line 24: Line 30:
   * **''​[[xref>​debug_guard|debug_guard($data)]]''​** \\ When you write your own debug functionality,​ use this function to remove all data from an array where the key seems to point to sensitive data.   * **''​[[xref>​debug_guard|debug_guard($data)]]''​** \\ When you write your own debug functionality,​ use this function to remove all data from an array where the key seems to point to sensitive data.
  
 +===== Sentry Plugin =====
 +
 +The [[plugin:​sentry|Sentry Plugin]] allows you to log extensive information to the [[https://​sentry.io|Sentry]] service. This is especially useful when running beta tests within a live environment.
  
  
devel/debugging.1362362051.txt.gz · Last modified: 2013-03-04 02:54 by 18.187.1.68