dtrace-provider - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name" : "dtrace-provider",
-  "version" : "0.0.1",
+  "version" : "0.0.2",
   "description" : "Native DTrace providers for node.js applications",
@@ -5,0 +5,0 @@ "keywords" : ["dtrace"],

README.md

@@ -12,8 +12,12 @@ # dtrace-provider - Native DTrace providers for Node.js apps.
 
-The provider is not created in the usual way, by declaring it, and
-then changing the build process to include it, but dynamically at
+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 invocation. The process creating the provider need not run as
-root.
+compiler or dtrace(1) invocation. The process creating the provider
+need not run as root.
 
+## INSTALL
+
+    $ npm install dtrace-provider
+
 ## EXAMPLE
@@ -28,5 +32,5 @@
     dtp.addProbe("probe2", "char *");
-    dtp.enable();
-    dtp.fire("probe1", function(p) { return [1, 2]; });
-    dtp.fire("probe2", function(p) { return ["hello, dtrace"]; });
+    dtp.enable();	   
+    dtp.fire("probe1", function() { return [1, 2]; });
+    dtp.fire("probe2", function() { return ["hello, dtrace"]; });
 
@@ -47,2 +51,5 @@ This example creates a provider called "nodeapp", and adds two
 
+Arguments are captured by a callback only executed when the probe is
+enabled. This means you can do more expensive work to gather arguments.
+
 ## PLATFORM SUPPORT
@@ -64,10 +71,22 @@
 
-This is the first working version, and there are a number of important
-cleanups to be made. Creating a provider will leak memory, although
-firing a probe should not. 
-
 Performance is not where it should be, most especially the
 disabled-probe effect. Probes are already using the "is-enabled"
-feature of DTrace, but too much work needs to be done before that's
+feature of DTrace to control execution of the arguments-gathering
+callback, but too much work needs to be done before that's
 checked. Improving this may imply changes to the API shown in the
-example above.
+example above. Please see TODO.md for the details. 
+
+## 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. 
+
+## 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.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

35707

increased by30.03%

Number of package files

15

increased by66.67%

Lines of code

38

increased by90%

Number of lines in readme file

89

increased by27.14%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes