[NIFI-9291] Add Configurable HTTP Access Logging

• Type: New Feature
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.16.0
• Component/s: Core Framework, Security
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 08/Oct/21 12:26
• Updated: 16/Mar/22 17:05
• Resolved: 18/Nov/21 17:18

Description

The NiFi REST API includes a RequestLogger implemented as a Java Servlet Filter which logs requests using the following format:

Attempting request for (<IDENTITY>) <METHOD> <URL> (source ip: <REMOTE_IP>)

The RequestLogger writes this message prior to request completion, so it is does not include HTTP response status information.

The identity field may not include username information when authenticating using a JWT. Additional information, such as User Agent and negotiated TLS version could also provide useful details.

HTTP request logging should be improved to include additional details and output information in a standardized format.

The W3C Extended Log File Format provides one potential option for access logging. The Common Log Format and Combined Log Format also provide de facto standards for access logging, while omitting some fields.

Issue Links

• relates to: NIFI-9394 Remove RequestLogger Filter and TimerFilter
• links to: GitHub Pull Request #5527