webkit-devtools-agent

Webkit devtools agent that leverages remote debugging and profiling of nodejs applications using the built-in webkit inspector.

npm install webkit-devtools-agent
134 downloads in the last day
871 downloads in the last week
2 575 downloads in the last month

Stories in Ready

Node Webkit Agent

Flattr this

This module is an implementation of Chrome developer tools protocol. It is still pretty much a work in progress and only the heap and CPU profilers are working right now. Debugger, console and networking will be added soon.

Features

This module allows you to debug and profile remotely your nodejs applications leveraging the following features by re-using the built-in devtools front-end that comes with any webkit-based browser such as Chrome and Safari.

  • Remote heap and CPU profiling
  • More agents are coming.

Installation

npm install webkit-devtools-agent

Example

var agent = require('webkit-devtools-agent');
var http = require('http');
http.createServer(function (req, res) {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('Hello World\n');
}).listen(8080, '127.0.0.1');
console.log('[%s] Server running at http://127.0.0.1:8080/', process.pid);

Connecting to the agent

  • Activate the agent in your nodejs application by sending a SIGUSR2 signal to its process id. The signal might vary depending on your platform. To de-activate, send the signal once again. Example:
    $ kill -SIGUSR2 <the process id of your nodejs app> # any POSIX-complaint platform
    $ kill -USR2 <the process id of your nodejs app> # OSX
    
  • Using your browser, go to devtools frontend URL corresponding to your nodejs version:
Nodejs v0.6.x

http://c4milo.github.io/node-webkit-agent/19.0.1084.46/inspector.html?host=localhost:9999&page=0

Nodejs v0.8.x and v0.10.x

http://c4milo.github.io/node-webkit-agent/26.0.1410.65/inspector.html?host=localhost:9999&page=0

It's important to make sure your browser supports websockets, otherwise the front-end won't be able to connect to the node agent whatsoever.

You can also change the agent port and host where it listen to by setting up the DEBUG_PORT and DEBUG_HOST environment variables.

For more documentation about how to use and interpret devtools, please go to the Devtools official documentation

Heads Up

ABI compatibility is breaking between nodejs v0.6.x and v0.8.x, therefore if you switch nodejs versions you would have to re-install webkit-devtools-agent again. See issue #11.

Screenshots

CPU profiling

Screenshot

Heap Profiling

Screenshot

Happy Debugging!

License

(The MIT License)

Copyright 2014 Camilo Aguilar. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you