Registry / testing / zipkin-instrumentation-axios

zipkin-instrumentation-axios

JSON →
library0.1.0jsnpmunverified

A wrapper library to instrument axios HTTP-client with Zipkin distributed tracing. Version 0.1.0 provides a simple wrapAxios(axios, options) function that returns a traced axios instance. Integrates with the Zipkin Tracer and requires explicit context, recorder, and logger setup. Minimal documentation, low maintenance activity on GitHub. Differentiates from other HTTP instrumentation by focusing specifically on axios with a thin wrapper pattern.

testing
npm install zipkin-instrumentation-axios
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · ZIPKIN-INSTRUMENTA
Z
zipkin-instrumentation-axios
testingjavascriptv0.1.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

wrapAxios
✓ const wrapAxios = require('zipkin-instrumentation-axios');
✗ import wrapAxios from 'zipkin-instrumentation-axios';
Package uses CommonJS; named export is the default. No ESM exports.
wrapAxios
✓ import wrapAxios from 'zipkin-instrumentation-axios';
For ESM-compatible bundlers, default import works as the package has no named exports.

Demonstrates wrapping an axios instance with Zipkin tracing using ExplicitContext and BatchRecorder.

const axios = require('axios'); const wrapAxios = require('zipkin-instrumentation-axios'); const { Tracer, ExplicitContext, BatchRecorder } = require('zipkin'); const { HttpLogger } = require('zipkin-transport-http'); const ctxImpl = new ExplicitContext(); const recorder = new BatchRecorder({ logger: new HttpLogger({ endpoint: 'http://localhost:9411/api/v1/spans' }) }); const tracer = new Tracer({ ctxImpl, recorder }); const zipkinAxios = wrapAxios(axios, { tracer, serviceName: 'myService' }); zipkinAxios.get('http://example.com/api/data') .then(res => console.log(res.data)) .catch(err => console.error(err));
Debug
Known issues
gotchawrapAxios mutates the passed axios instance; do not reuse the original axios for untraced requests after wrapping.
fix
Create a fresh axios instance or use 'axios.create()' before wrapping.
affects: >=0.0.0
gotchaRequires zipkin and zipkin-transport-http packages to be installed separately.
fix
Run 'npm install zipkin zipkin-transport-http'.
affects: >=0.0.0
gotchaNo TypeScript definitions; type-checking may be absent in TS projects.
fix
Create a custom type declaration or use @ts-ignore.
affects: >=0.0.0
Errors
Common errors & fixes
Error: Cannot find module 'zipkin'
zipkin package not installed
fix
npm install zipkin
TypeError: wrapAxios is not a function
Incorrect import or require path
fix
const wrapAxios = require('zipkin-instrumentation-axios');
Upgrade
Version history
0.1.0latest on npm
Audit
Dependencies
zipkinrequiredZipkin tracer, context, and recorder required for instrumentation
Agent activity
40 hits · last 30 days
node
34
OpenAI (training)
1
Resources
githubhttps://github.com/uschmann/zipkin-instrumentation-axios ↗
packagezipkin-instrumentation-axios ↗
homepagehttps://github.com/uschmann/zipkin-instrumentation-axios#readme ↗
zipkin-instrumentation-axios — npm install zipkin-instrumentation-axios · libregistry