A pure JavaScript PProf encoder and decoder library with zero dependencies and
browser support. No protobuf, because the pprof spec only uses a tiny fraction
of the features. Uint8Arrays rather than Node.js buffers so it can work in the
browser. Carefully tuned to be as fast as possible.
Install
npm install pprof-format
Usage
import { Function, Label, Line, Location, Mapping, Profile, Sample, ValueType, StringTable} from 'pprof-format'const stringTable = new StringTable()const periodType = new ValueType({ type: stringTable.dedup('cpu'), unit: stringTable.dedup('nanoseconds')})const fun = new Function({ id: 1, name: stringTable.dedup('name'), systemName: stringTable.dedup('system name'), filename: stringTable.dedup('filename'), startLine: 123})const mapping = new Mapping({ id: 1})const location = new Location({ id: 1, mappingId: mapping.id, address: 123, line: [ new Line({ functionId: fun.id, line: 1234 }) ]})const profile = new Profile({ sampleType: [ new ValueType({ type: stringTable.dedup('sample'), unit: stringTable.dedup('count') }), periodType ], sample: [ new Sample({ locationId: [location.id], value: [123, 456], label: [ new Label({ key: stringTable.dedup('label key'), str: stringTable.dedup('label str') }), new Label({ key: stringTable.dedup('label key'), num: 12345, numUnit: stringTable.dedup('label num unit') }) ] }) ], mapping: [mapping], location: [location], 'function': [fun], stringTable, timeNanos: BigInt(Date.now()) * 1_000_000n, durationNanos: 1234, periodType, period: 1234 / 2, comment: [ stringTable.dedup('some comment') ]})// Encode to Uint8Arrayconsole.log(profile.encode())// Decode from Uint8Arrayconst copied = Profile.decode(profile.encode())// Should match the structure of the original profile objectconsole.log(copied)
OpenTelemetry profiles
The pprof-format/otel entry point encodes and decodes the OpenTelemetry
profiles signal, as defined by
opentelemetry-proto
v1.11.1. The signal is still in development, so its messages may change.
Its classes mirror the proto messages, with camelCase field names. Profiles
refer to functions, locations, stacks, strings and other entries by index into
a dictionary shared by all profiles of a request. Each dictionary table starts
with the zero value of its type at index 0, which means "not set"; tables that
aren't given default to just that entry.