request-id
Advanced tools
Readme
Allows you to identify client requests within non-sequential logs such as Syslog by adding a response header of
X-Request-Id. Allows setting value via query parameter or request header. For Koa and Express.
$ npm install request-id
# koa
var requestId = require('request-id');
var app = require('koa')();
app.use(requestId());
# express
var requestId = require('request-id/express');
var app = require('express')();
app.use(requestId());
% curl example.com
//=> X-Client-ID: a37cacc3-71d5-40f0-a329-a051a3949ced
% curl -H 'X-Request-ID:a37cacc3-71d5-40f0-a329-a051a3949ced' example.com
//=> X-Request-ID: a37cacc3-71d5-40f0-a329-a051a3949ced
% curl example.com?requestId=a37cacc3-71d5-40f0-a329-a051a3949ced
//=> X-Request-ID: a37cacc3-71d5-40f0-a329-a051a3949ced
X-Request-Id)app.use(requestId({
resHeader: 'X-Client-ID'
}));
% curl example.com
//=> X-Client-ID: a37cacc3-71d5-40f0-a329-a051a3949ced
X-Request-Id)Keep in mind that changing the request header does not have any effect on the default response header. If you want them to match, you'll need to set both
.resHeaderand.reqHeader.
app.use(requestId({
reqHeader: 'X-Client-ID'
}));
% curl -H 'X-Client-ID:a37cacc3-71d5-40f0-a329-a051a3949ced' example.com
//=> X-Request-ID: a37cacc3-71d5-40f0-a329-a051a3949ced
requestId)app.use(requestId({
paramName: 'requestId'
}));
% curl example.com?requestId=a37cacc3-71d5-40f0-a329-a051a3949ced
//=> X-Request-ID: a37cacc3-71d5-40f0-a329-a051a3949ced
app.use(requestId({
generator: function () { return 'ABC'; }
}));
% curl example.com
//=> X-Request-ID: ABC
FAQs
Allows you to identify client requests within non-sequential logs such as Syslog by adding a response header of `X-Request-Id`. Allows setting value via query parameter or request header. For Koa and Express.
The npm package request-id receives a total of 712 weekly downloads. As such, request-id popularity was classified as not popular.
We found that request-id demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.