Skip to content

trace_events: add more process metadata #21785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

trace_events: add more process metadata #21785

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e55bab0
trace_events: add more process metadata
jasnell Jul 12, 2018
2f37de4
[Squash] Use a TraceStateObserver
jasnell Jul 12, 2018
8e2c8c9
[Squash] missed a delete
jasnell Jul 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions src/node.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1966,11 +1966,14 @@ void SetupProcessObject(Environment* env,
v8::None,
SideEffectType::kHasNoSideEffect).FromJust());

auto trace_process = tracing::TracedValue::Create();

// process.version
READONLY_PROPERTY(process,
"version",
FIXED_ONE_BYTE_STRING(env->isolate(), NODE_VERSION));

trace_process->BeginDictionary("versions");
// process.versions
Local<Object> versions = Object::New(env->isolate());
READONLY_PROPERTY(process, "versions", versions);
Expand All @@ -1983,39 +1986,52 @@ void SetupProcessObject(Environment* env,
READONLY_PROPERTY(versions,
"http_parser",
FIXED_ONE_BYTE_STRING(env->isolate(), http_parser_version));
trace_process->SetString("http_parser", http_parser_version);

// +1 to get rid of the leading 'v'
READONLY_PROPERTY(versions,
"node",
OneByteString(env->isolate(), NODE_VERSION + 1));
trace_process->SetString("node", NODE_VERSION_STRING);

READONLY_PROPERTY(versions,
"v8",
OneByteString(env->isolate(), V8::GetVersion()));
trace_process->SetString("v8", V8::GetVersion());

READONLY_PROPERTY(versions,
"uv",
OneByteString(env->isolate(), uv_version_string()));
trace_process->SetString("uv", uv_version_string());

READONLY_PROPERTY(versions,
"zlib",
FIXED_ONE_BYTE_STRING(env->isolate(), ZLIB_VERSION));
trace_process->SetString("zlib", ZLIB_VERSION);

READONLY_PROPERTY(versions,
"ares",
FIXED_ONE_BYTE_STRING(env->isolate(), ARES_VERSION_STR));
trace_process->SetString("ares", ARES_VERSION_STR);

const char node_modules_version[] = NODE_STRINGIFY(NODE_MODULE_VERSION);
READONLY_PROPERTY(
versions,
"modules",
FIXED_ONE_BYTE_STRING(env->isolate(), node_modules_version));
trace_process->SetString("modules", node_modules_version);

READONLY_PROPERTY(versions,
"nghttp2",
FIXED_ONE_BYTE_STRING(env->isolate(), NGHTTP2_VERSION));
trace_process->SetString("nghttp2", NGHTTP2_VERSION);

const char node_napi_version[] = NODE_STRINGIFY(NAPI_VERSION);
READONLY_PROPERTY(
versions,
"napi",
FIXED_ONE_BYTE_STRING(env->isolate(), node_napi_version));
trace_process->SetString("napi", node_napi_version);

#if HAVE_OPENSSL
// Stupid code to slice out the version string.
Expand All @@ -2037,27 +2053,38 @@ void SetupProcessObject(Environment* env,
versions,
"openssl",
OneByteString(env->isolate(), &OPENSSL_VERSION_TEXT[i], j - i));
trace_process->SetString("openssl",
std::string(&OPENSSL_VERSION_TEXT[i], j - i));
}
#endif
trace_process->EndDictionary();

// process.arch
READONLY_PROPERTY(process, "arch", OneByteString(env->isolate(), NODE_ARCH));
trace_process->SetString("arch", NODE_ARCH);

// process.platform
READONLY_PROPERTY(process,
"platform",
OneByteString(env->isolate(), NODE_PLATFORM));
trace_process->SetString("platform", NODE_PLATFORM);

// process.release
Local<Object> release = Object::New(env->isolate());
READONLY_PROPERTY(process, "release", release);
READONLY_PROPERTY(release, "name",
OneByteString(env->isolate(), NODE_RELEASE));

trace_process->BeginDictionary("release");
auto traced_release = tracing::TracedValue::Create();
trace_process->SetString("name", NODE_RELEASE);

#if NODE_VERSION_IS_LTS
READONLY_PROPERTY(release, "lts",
OneByteString(env->isolate(), NODE_VERSION_LTS_CODENAME));
trace_process->SetString("lts", NODE_VERSION_LTS_CODENAME);
#endif
trace_process->EndDictionary();

// if this is a release build and no explicit base has been set
// substitute the standard release download URL
Expand Down Expand Up @@ -2092,19 +2119,28 @@ void SetupProcessObject(Environment* env,

// process.argv
Local<Array> arguments = Array::New(env->isolate(), argc);
trace_process->BeginArray("argv");
for (int i = 0; i < argc; ++i) {
arguments->Set(i, String::NewFromUtf8(env->isolate(), argv[i]));
trace_process->AppendString(argv[i]);
}
trace_process->EndArray();
process->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "argv"), arguments);

// process.execArgv
Local<Array> exec_arguments = Array::New(env->isolate(), exec_argc);
trace_process->BeginArray("execArgv");
for (int i = 0; i < exec_argc; ++i) {
exec_arguments->Set(i, String::NewFromUtf8(env->isolate(), exec_argv[i]));
trace_process->AppendString(exec_argv[i]);
}
trace_process->EndArray();
process->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "execArgv"),
exec_arguments);

TRACE_EVENT_METADATA1("__metadata", "node",
"process", std::move(trace_process));

// create process.env
Local<ObjectTemplate> process_env_template =
ObjectTemplate::New(env->isolate());
Expand Down
1 change: 1 addition & 0 deletions src/node_internals.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
#include "uv.h"
#include "v8.h"
#include "tracing/trace_event.h"
#include "tracing/traced_value.h"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we include these headers where they are used, rather than (almost) globally?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

#include "node_perf_common.h"
#include "node_debug_options.h"
#include "node_api.h"
Expand Down
46 changes: 38 additions & 8 deletions test/parallel/test-trace-events-metadata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,55 @@ const proc = cp.spawn(process.execPath,
proc.once('exit', common.mustCall(() => {
assert(common.fileExists(FILE_NAME));
fs.readFile(FILE_NAME, common.mustCall((err, data) => {
const traces = JSON.parse(data.toString()).traceEvents;
const traces = JSON.parse(data.toString()).traceEvents
.filter((trace) => trace.cat === '__metadata');
assert(traces.length > 0);
assert(traces.some((trace) =>
trace.cat === '__metadata' && trace.name === 'thread_name' &&
trace.name === 'thread_name' &&
trace.args.name === 'JavaScriptMainThread'));
assert(traces.some((trace) =>
trace.cat === '__metadata' && trace.name === 'thread_name' &&
trace.name === 'thread_name' &&
trace.args.name === 'BackgroundTaskRunner'));
assert(traces.some((trace) =>
trace.cat === '__metadata' && trace.name === 'version' &&
trace.name === 'version' &&
trace.args.node === process.versions.node));

assert(traces.some((trace) =>
trace.name === 'node' &&
trace.args.process.versions.http_parser ===
process.versions.http_parser &&
trace.args.process.versions.node ===
process.versions.node &&
trace.args.process.versions.v8 ===
process.versions.v8 &&
trace.args.process.versions.uv ===
process.versions.uv &&
trace.args.process.versions.zlib ===
process.versions.zlib &&
trace.args.process.versions.ares ===
process.versions.ares &&
trace.args.process.versions.modules ===
process.versions.modules &&
trace.args.process.versions.nghttp2 ===
process.versions.nghttp2 &&
trace.args.process.versions.napi ===
process.versions.napi &&
trace.args.process.versions.openssl ===
process.versions.openssl &&
trace.args.process.arch === process.arch &&
trace.args.process.platform === process.platform &&
trace.args.process.release.name === process.release.name &&
(!process.release.lts ||
trace.args.process.release.lts === process.release.lts) &&
Array.isArray(trace.args.process.argv) &&
Array.isArray(trace.args.process.execArgv)));

if (!common.isSunOS) {
// Changing process.title is currently unsupported on SunOS/SmartOS
assert(traces.some((trace) =>
trace.cat === '__metadata' && trace.name === 'process_name' &&
trace.args.name === 'foo'));
trace.name === 'process_name' && trace.args.name === 'foo'));
assert(traces.some((trace) =>
trace.cat === '__metadata' && trace.name === 'process_name' &&
trace.args.name === 'bar'));
trace.name === 'process_name' && trace.args.name === 'bar'));
}
}));
}));