From dacdd080dc60679f94081956ba8a08d44b553989 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Fri, 1 Aug 2014 16:38:33 -0700 Subject: [PATCH] add note about separate dtrace-provider installation necessity --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e56ba73..9959ae7 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,17 @@ to get the bunyan CLI on your PATH, then use local bunyan installs for node.js library usage of bunyan in your apps. +To use the DTrace features (on platforms that support dtrace) you need +to manually install the dtrace-provider library separately: + + npm install dtrace-provider + +Yes, this sucks. This used to be in "optionalDependencies" but +[this](https://github.com/trentm/node-bunyan/issues/135) and other issues showed +burden and confusion for users. I'm looking forward to coming *core* tracing +facilities in node 0.12 to which bunyan can switch. + + # Features - elegant [log method API](#log-method-api) @@ -50,7 +61,7 @@ node.js library usage of bunyan in your apps. [`src: true`](#src) - light-weight specialization of Logger instances with [`log.child`](#logchild) - custom rendering of logged objects with ["serializers"](#serializers) -- [Runtime log snooping via Dtrace support](#dtrace-support) +- [Runtime log snooping via DTrace support](#dtrace-support) # Introduction @@ -821,6 +832,9 @@ This example emits: # Runtime log snooping via DTrace +**Note**: To use Bunyan's DTrace facilities you need to manually install +the "dtrace-provider" lib separately via `npm install dtrace-provider`. + On systems that support DTrace (e.g., MacOS, FreeBSD, illumos derivatives like SmartOS and OmniOS), Bunyan will create a DTrace provider (`bunyan`) that makes available the following probes: