google / nel-reporter-java

Network Error Logging (NEL) Java Reporter

Network Error Logging reporter

This library implements a reporter for the Reporting and Network Error Logging (NEL) specifications. These specs allow site owners to instruct browsers and other user agents to collect and report on reliability information about the site. This gives you the same information as you'd get from your server logs, but collected from your clients. This client-side data set will include information about failed requests that never made it to your serving infrastructure.

This library provides a full working implementation of the specs, with one glaring omission: we don't handle any of the actual communication of sending and receiving HTTP requests. This lets you plug this library into any HTTP request library; we take of parsing and managing the reporting instructions for each origin, caching reports, and deciding which collector to send each report to. You provide an implementation of the ReportDeliverer interface to handle the actual HTTP communication using the library that you're integrating with.

nel-reporter-java's Issues

Hook interface for receiving headers and delivering reports

The readme mentions a ReportDeliverer interface, which is how you'd embed this library in an actual HTTP client library. You'd have a specific implementation of that interface for the HTTP library, which would handle the actual HTTP communication. When it makes any HTTPS request, it would extract out the Report-To and NEL headers from the response and hand them over to us. And it would hand over information about whether the request succeeded or failed, which we would turn into Reports and cache. And lastly, it would allow us to trigger report uploads, either on demand (i.e., under the control of the embedder), or in a background thread.

Automatically enforce style guide

We should use Maven's checkstyle plugin to automatically enforce the style guide.

Parse Report-To and NEL headers

We need to parse the values of Report-To and NEL headers to create all of the endpoint-related state described in the spec.

Set up Travis for CI

We should add Travis hooks to automatically run the test suite, and require passing tests before PRs can be merged.