dtrace-provider

What is dtrace-provider?

The dtrace-provider package is a Node.js module that allows you to create DTrace providers for Node.js applications. DTrace is a comprehensive dynamic tracing framework that is available on some operating systems like Solaris, macOS, and FreeBSD. It enables you to get insights into the behavior of your software, allowing for performance analysis and troubleshooting.

What are dtrace-provider's main functionalities?

Creating a DTrace provider

This code sample demonstrates how to create a new DTrace provider with a single probe. The probe is named 'probe-name' and expects an integer and a string argument.

var dtrace = require('dtrace-provider');
var dtp = dtrace.createDTraceProvider('nodeapp');
var probe = dtp.addProbe('probe-name', 'int', 'char *');
dtp.enable();

Firing a probe

This code sample shows how to fire a probe with the specified arguments. When the probe is fired, the function provided to 'fire' is called, and the return value is used as the arguments for the probe.

probe.fire(function() {
  return [42, 'hello world'];
});

Other packages similar to dtrace-provider

bunyan

Bunyan is a simple and fast JSON logging library for node.js services. It includes a DTrace integration allowing you to use DTrace to trace log points in your applications. It is similar to dtrace-provider in that it supports DTrace, but it is primarily a logging library rather than a DTrace-specific provider.

restify

Restify is a node.js module built specifically to enable you to build correct REST web services. It has built-in DTrace support for all of its HTTP server events, similar to dtrace-provider, but it is more focused on creating RESTful services and includes DTrace as part of its observability features.

README

dtrace-provider - Native DTrace providers for Node.js apps.

This extension allows you to create native DTrace providers for your Node.js applications. That is, to create providers and probes which expose information specific to your application, rather than information about the node runtime.

You could use this to expose high-level information about the inner workings of your application, or to create a specific context in which to look at information from other runtime or system-level providers.

The provider is not created in the usual way, by declaring it and then changing the build process to include it, but instead dynamically at runtime. This is done entirely in-process, and there is no background compiler or dtrace(1) invocation. The process creating the provider need not run as root.

INSTALL

$ npm install dtrace-provider

EXAMPLE

Here's a simple example of creating a provider:

var d = require('dtrace-provider');

var dtp = d.createDTraceProvider("nodeapp");
var p1 = dtp.addProbe("probe1", "int", "int");
var p2 = dtp.addProbe("probe2", "char *");
dtp.enable();	   

Probes may be fired via the provider object:

dtp.fire("probe1", function(p) {
    return [1, 2];
});
dtp.fire("probe2", function(p) { 
    return ["hello, dtrace via provider", "foo"];
});

or via the probe objects themselves:

p1.fire(function(p) {
  return [1, 2, 3, 4, 5, 6];
});
p2.fire(function(p) {
  return ["hello, dtrace via probe", "foo"];
});

This example creates a provider called "nodeapp", and adds two probes. It then enables the provider, at which point the provider becomes visible to DTrace.

The probes are then fired, which produces this output:

$ sudo dtrace -Z -n 'nodeapp*:::probe1{ trace(arg0); trace(arg1) }'  \
                 -n 'nodeapp*:::probe2{ trace(copyinstr(arg0));  }'
dtrace: description 'nodeapp*:::probe1' matched 0 probes
dtrace: description 'nodeapp*:::probe2' matched 0 probes
CPU     ID                    FUNCTION:NAME
  1 123562                      func:probe1                 1                2
  1 123563                      func:probe2   hello, dtrace                    

Arguments are captured by a callback only executed when the probe is enabled. This means you can do more expensive work to gather arguments.

The maximum number of arguments supported is 32.

Available argument types are "int", for integer numeric values, "char *" for strings, and "json" for objects rendered into JSON strings.

Arguments typed as "json" will be created as "char *" probes in DTrace, but objects passed to these probe arguments will be automatically serialized to JSON before being passed to DTrace. This feature is best used in conjunction with the json() D subroutine, but is available whether or not the platform supports it.

# create a json probe:

var dtp = d.createDTraceProvider("nodeapp");
var p1 = dtp.addProbe("j1", "json");
dtp.enable();
p1.fire(function() { return { "foo": "bar" }; });

# on a platform supporting json():

$ sudo dtrace -Z -n 'nodeapp*:::j1{ this->j = copyinstr(arg0); \
                                    trace(json(this->j, "foo")) }'
dtrace: description 'nodeapp$target:::j1' matched 0 probes
CPU     ID                    FUNCTION:NAME
  0  68712                            j1:j1   bar

PLATFORM SUPPORT

This libusdt-based Node.JS module supports 64 and 32 bit processes on Mac OS X and Solaris-like systems such as Illumos or SmartOS. As more platform support is added to libusdt, those platforms will be supported by this module. See libusdt's status at:

https://github.com/chrisa/libusdt#readme

FreeBSD is supported in principle but is restricted to only 4 working arguments per probe.

Platforms not supporting DTrace (notably, Linux and Windows) may install this module without building libusdt, with a stub no-op implementation provided for compatibility. This allows cross-platform npm modules to embed probes and include a dependency on this module.

GNU Make is required to build libusdt; the build scripts will look for gmake in PATH first, and then for make.

CAVEATS

There is some overhead to probes, even when disabled. Probes are already using the "is-enabled" feature of DTrace to control execution of the arguments-gathering callback, but some work still needs to be done before that's checked. This overhead should not be a problem unless probes are placed in particularly hot code paths.

CONTRIBUTING

The source is available at:

https://github.com/chrisa/node-dtrace-provider.

For issues, please use the Github issue tracker linked to the repository. Github pull requests are very welcome.

RUNNING THE TESTS

$ npm install $ sudo ./node_modules/.bin/tap --tap test/*.test.js

OTHER IMPLEMENTATIONS

This node extension is derived from the ruby-dtrace gem, via the Perl module Devel::DTrace::Provider, both of which provide the same functionality to those languages.