Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 3.6 KB

TROUBLESHOOTING.md

File metadata and controls

59 lines (43 loc) · 3.6 KB
Raw

Troubleshooting

First, read How to debug WakaTime plugins.

Set debug=true in your ~/.wakatime.cfg file to enable verbose logging.

If you’re debugging RAM usage, set metrics=true in your ~/.wakatime.cfg file to log pprof memory usage to ~/.wakatime/metrics/.

The common wakatime-cli program logs to your user $HOME directory ~/.wakatime/wakatime.log.

If your error message contains won't send heartbeat due to backoff, delete your ~/.wakatime/wakatime-internal.cfg file to trigger an API connection to get the real error message.

Each plugin also has its own log file:

  • Atom writes errors to the developer console (View -> Developer -> Toggle Developer Tools)
  • Brackets errors go to the developer console (Debug -> Show Developer Tools)
  • Cloud9 logs to the browser console (View -> Developer -> JavaScript Console)
  • Coda logs to /var/log/system.log so use sudo tail -f /var/log/system.log in Terminal to watch Coda 2 logs
  • Eclipse logs can be found in the Eclipse Error Log (Window -> Show View -> Error Log)
  • Emacs messages go to the messages buffer window
  • Jetbrains IDEs (IntelliJ IDEA, PyCharm, RubyMine, PhpStorm, AppCode, AndroidStudio, WebStorm) log to idea.log (locating IDE log files)
  • Komodo logs are written to pystderr.log (Help -> Troubleshooting -> View Log File)
  • Netbeans logs to its own log file (View -> IDE Log)
  • Notepad++ errors go to AppData\Roaming\Notepad++\plugins\config\WakaTime.log (this file is only created when an error occurs)
  • Sublime Text logs to the Sublime Console (View -> Show Console)
  • TextMate logs to stderr so run TextMate from Terminal to see any errors (enable logging)
  • Vim errors get displayed in the status line or inline (use :redraw! to clear inline errors)
  • Visual Studio logs to the Output window, but uncaught exceptions go to ActivityLog.xml (more info...)
  • VS Code logs to the developer console (Help -> Toggle Developer Tools)
  • Xcode type sudo tail -f /var/log/system.log in a Terminal to view Xcode errors

Check the Plugin Status Page to see when the API last heard from each of your WakaTime plugins.

Useful API Endpoints for debugging:

Useful Resources:

SSH configuration

If you’re connected to a remote host using the ssh extension you might want to force WakaTime to run locally, for example when the server you connect to is shared among multiple people. Please follow this guide.