@hypertrace/nodejsagent

Node.js Agent

nodejsagent provides a set of complementary instrumentation features for collecting relevant data to be processed by Hypertrace.

Development

Developing locally

Then run: npm run build, you can then install the generated .tgz as a normal dependency.

Note: Using npm link doesnt solve the local testing problem as it will use the hypertrace package dev-dependencies during instrumentation instead of the targetted node app

You can then run or debug the example application in the examples directory.

Updating protobuf definitions

If you want to update the protobuf definitions, first update the agent-config submodule. ex: git submodule update --init --recursive

You can then run npm run generate_pb

This will generate two files: ./src/instrumentation/config/generated.js & ./src/instrumentation/config.generated.d.ts

Tests

Tests should be added to the test directory, in a structure that matches that of the file you are attempting to test.

Ideally all functionality is testable in locally runnable unit-tests(as opposed to in a docker container), primarily for ease of debugging.

You can run all tests with npm run test