Add sub-interface LogDescriptor.LogLine (and the extension to WebServerAccessLogLine)

Add sub-interface LogDescriptor.LogLine (and the extension to WebServerAccessLogLine), the first interface will simply provide one method that returns a line from the log.

LogDescriptor will need to be extended to provide all LogLines, which includes sub-interface specific parsing and retrieving the unrecognized lines up to a limit (100 for a start).

Sub-interface WebServerAccessLogLine, which extends LogLine, is more specific for access-logs and provides methods for all fields that contain useful data after the sanitation process, i.e., it doesn't provide all Apache log fields. (cf. discussion in #22983 (moved))

changed milestone to %metrics-lib 2.2.0

added component::metrics/library metrics-2018 milestone::metrics-lib 2.2.0 owner::iwakeh priority::medium resolution::fixed reviewer::karsten severity::normal status::closed type::enhancement labels

This needs confirmation about

• the unrecognized lines handling limit.
• the restriction the api to the fields varying in sanitized log lines

Setting to needs information.

Trac:
Status: new to needs_information

Trac:
Milestone: N/A to CollecTor 1.3.0

Trac:
Milestone: CollecTor 1.3.0 to metrics-lib 1.4.0

Trac:
Milestone: metrics-lib 1.4.0 to metrics-lib 2.1.0

Regarding the open questions,

• we discussed today that limiting unrecognized lines to 3 or 10 would be sufficient, and
• we didn't conclude on restricting the API to the fields varying in sanitized logs yet. However, after giving this some thought I'd say that we can indeed restrict the API for now and add new methods later if we need them. What we should not do is reject log lines with fields that typically do not vary in sanitized logs. But not providing getters for those fields sounds okay to me.

Move to next milestone in order to accommodate interim release.

Trac:
Milestone: metrics-lib 2.1.0 to metrics-lib 2.2.0

Trac:
Keywords: N/A deleted, metrics-2018 added

Trac:
Keywords: metrics-2018 deleted, metrics-2017 added

The first step is to provide the interface definitions and extensions based on the latest branch in #22983 (moved). Once everyone is happy with these definitions the implementation will follow.

Trac:
Owner: metrics-team to iwakeh
Status: needs_information to accepted

Will be completed in 2018.

Trac:
Keywords: metrics-2017 deleted, metrics-2018 added

Please review this branch based on the current master implementation.

Trac:
Status: accepted to needs_review
Cc: N/A to metrics-team

Will take a look.

Trac:
Reviewer: N/A to karsten

Please find some trivial tweaks in commit a4a66b1 of my task-23046 branch. If these look okay, I'll squash and push to master. Setting to needs_revision, but really revision here means looking those trivial tweaks only.

Trac:
Status: needs_review to needs_revision

All space corrections and especially the comments look fine! (I really write very generic/technical Javadoc while coding at the same time ;-)

Setting to merge ready.

Trac:
Status: needs_revision to merge_ready

And merged! Closing. Thanks!

Trac:
Status: merge_ready to closed
Resolution: N/A to fixed

This needs a revision: webstats log files can be large and thus, method

public List<? extends Line> logLines() throws DescriptorParseException;

of the current LogDescriptor interface should be replaced by

public Stream<? extends Line> logLines() throws DescriptorParseException;

Trac:
Status: closed to reopened
Resolution: fixed to N/A

Trac:
Status: reopened to accepted

Please review one commit (branch based on master).

Trac:
Status: accepted to needs_review

Replying to iwakeh:

Please review one commit (branch based on master).

Two issues:

• This patch has the same issue with count not being reset as #25317 (moved).
• The Javadocs for new parts in LogDescriptor are missing the @since 2.2.0 part. Also, the Line interface doesn't have a Javadoc comment at all.

Trac:
Status: needs_review to needs_revision

Please review the fixup commit.

Trac:
Status: needs_revision to needs_review

Looks good!

Trac:
Status: needs_review to merge_ready

Merged, closing. Thanks!

Trac:
Status: merge_ready to closed
Resolution: N/A to fixed

closed

mentioned in issue #25329 (moved)