Documentation, Provide a way to send Liberty Access Logs to OpenTelemetry

[tonyreigns]

Feature epic details

• For the title of this issue, type: Documentation, Development epic name
• Link to development epic: Provide a way to send Liberty Access Logs to OpenTelemetry
• Target GA release: 25.0.0.4

Operating systems

Does the documentation apply to all operating systems?

• Yes
• No; specify operating systems: ______

Summary

Provide a concise summary of your feature. What is the update, why does it matter, and to whom? What do 80% of target users need to know to be most easily productive using your runtime update?

Liberty Access logs can now also be collected to OpenTelemetry using the mpTelemetry-2.0 feature, along with the access logs configuration, in addition to Open Liberty runtime log sources (messages, traces, ffdcs, audit) and application logs generated via java.util.logging (JUL). Just a note, audit is being added in the same release.

Configuration

List any new or changed properties, parameters, elements, attributes, etc. Include default values and configuration examples where relevant:

To enable the MicroProfile Telemetry 2.0 feature to collect access logs, add the httpEndpoint and optionally the httpAccessLogging configuration attribute(s), the new access log source to the source attribute for the server configuration element and either default or logFormat for the accessLogFields attribute, as stated in the following configuration to your server.xml:

<httpAccessLogging id="accessLogging" logFormat='%h %u %{t}W "%r" %s %b %D %{R}W'/>
<httpEndpoint id="defaultHttpEndpoint" accessLoggingRef="accessLogging" httpPort="9080" httpsPort="9443"/>

<mpTelemetry accessLogFields=“logFormat” source=“message,trace,ffdc,accessLog”/>

Updates to existing topics

Documentation to be updated: https://openliberty.io/docs/latest/reference/feature/mpTelemetry-2.0.html#logs

• Add the accessLog log source:
• Mention that the access logging needs to be configured in the server configuration, along with the accessLog source in the source list for the access log events to be collected by OpenTelemetry.

Documentation to be updated: https://openliberty.io/docs/latest/mptel-log-events-list.html

Add a reference table for access events, with the correct OTel field mappings:
(Refer to Table A in Slide 12 in the UFO: https://ibm.ent.box.com/s/nq85gc51xe3qf15975o9s8dva7lr0y3c)

[is273]

Hi @tonyreigns a couple of questions:

Refer to Table A in Slide 12 in the UFO: https://ibm.ent.box.com/s/nq85gc51xe3qf15975o9s8dva7lr0y3c

• To clarify, are we including all of the information in the tables that are on Slide 11 and Slide 12 or only the information on Slide 12?
• For the OpenTelemetry Collector output for a access event from an application, does all the information on Slide 13 apply?

[tonyreigns]

Hi @is273

• I apologize, I meant all the information on both slides 11 and 12.
• Slide 13 does apply but it's a very vague sample and may not be completely accurate. I don't think that slide is needed.

Also, my team decided to push this feature release to 25005 instead of 25004. So please omit this from this upcoming release, sorry about that.

Thanks!

[is273]

@tonyreigns No worries, thank you for the heads up!