report-to
Version:
Report-To Middleware for Express
49 lines (39 loc) • 2.12 kB
Markdown
Report To
==============
[](https://badge.fury.io/js/report-to)
[](https://david-dm.org/Cherry/report-to)
[](https://github.com/Cherry/Report-to/actions)
[](https://coveralls.io/github/Cherry/report-to?branch=master)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FCherry%2Freport-to?ref=badge_shield)
This is Express middleware to set the `Report-To` HTTP response header. You can read more about it [here](https://www.w3.org/TR/reporting) and [here](https://scotthelme.co.uk/network-error-logging-deep-dive/).
To use:
```javascript
const reportTo = require('report-to')
// ...
app.use(reportTo({
groups: [
{
group: "endpoint-1",
max_age: 10886400,
include_subdomains: true,
endpoints: [
{
url: "https://example.com/reports",
priority: 1
},
{
url: "https://backup.com/reports",
priority: 2
}
]
}
]
}))
```
When set alone, this header doesn't do anything and will need to be set with a header that allows reporting, such as `Content-Security-Policy`, `NEL`, etc.
For example, using the above definition, a `NEL` header may look like the following, using `endpoint-1` as its `report-to` parameter:
```NEL: {"report_to":"endpoint-1","max_age":31536000,"include_subdomains":true}```
You can use [this module](https://github.com/Cherry/network-error-logging) to set an `NEL` header easily with express.
https://report-uri.com/ is a great reporting platform for monitoring CSP, NEL, etc. error logs.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2FCherry%2Freport-to?ref=badge_large)