diff options
| author | Bert Belder <bertbelder@gmail.com> | 2014-12-09 16:03:24 +0100 |
|---|---|---|
| committer | Bert Belder <bertbelder@gmail.com> | 2014-12-09 17:57:19 +0100 |
| commit | 2b6a0f85f3fafa8afee0ddf09c50ebc5f3a7c6a8 (patch) | |
| tree | 1f567e2b6f28b4a208922f0cd6d8766c1df2ab20 /doc | |
| parent | e96100f052a54499bf4fda19a01507971bb19da9 (diff) | |
| download | node-new-2b6a0f85f3fafa8afee0ddf09c50ebc5f3a7c6a8.tar.gz | |
src: remove the tracing module entirely
PR-URL: https://github.com/iojs/io.js/pull/124
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/all.markdown | 1 | ||||
| -rw-r--r-- | doc/api/tracing.markdown | 66 |
2 files changed, 0 insertions, 67 deletions
diff --git a/doc/api/all.markdown b/doc/api/all.markdown index 5ccef037f5..2a164abb78 100644 --- a/doc/api/all.markdown +++ b/doc/api/all.markdown @@ -35,4 +35,3 @@ @include debugger @include cluster @include smalloc -@include tracing diff --git a/doc/api/tracing.markdown b/doc/api/tracing.markdown deleted file mode 100644 index 8802e29914..0000000000 --- a/doc/api/tracing.markdown +++ /dev/null @@ -1,66 +0,0 @@ -# Tracing - - Stability: 1 - Experimental - -The tracing module is designed for instrumenting your Node application. It is -not meant for general purpose use. - -`require('tracing')` to use this module. - -## v8 - -The `v8` property is an [EventEmitter][], it exposes events and interfaces -specific to the version of `v8` built with node. These interfaces are subject -to change by upstream and are therefore not covered under the stability index. - -### Event: 'gc' - -`function (before, after) { }` - -Emitted each time a GC run is completed. - -`before` and `after` are objects with the following properties: - -``` -{ - type: 'mark-sweep-compact', - flags: 0, - timestamp: 905535650119053, - total_heap_size: 6295040, - total_heap_size_executable: 4194304, - total_physical_size: 6295040, - used_heap_size: 2855416, - heap_size_limit: 1535115264 -} -``` - -### getHeapStatistics() - -Returns an object with the following properties - -``` -{ - total_heap_size: 7326976, - total_heap_size_executable: 4194304, - total_physical_size: 7326976, - used_heap_size: 3476208, - heap_size_limit: 1535115264 -} -``` - -### setFlagsFromString() - -Set additional V8 command line flags. Use with care; changing settings -after the VM has started may result in unpredictable behavior, including -crashes and data loss. Or it may simply do nothing. - -Usage: - -``` -// Print GC events to stdout for one minute. -var v8 = require('tracing').v8; -v8.setFlagsFromString('--trace_gc'); -setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3); -``` - - |