Add logstash structured arg support by trask · Pull Request #14959 · open-telemetry/opentelemetry-java-instrumentation

trask · 2025-10-11T18:28:14Z

Adds support for capturing Logstash StructuredArguments (e.g., StructuredArguments.v() and StructuredArguments.keyValue()) as OpenTelemetry log record attributes.

Key changes:

Adds new configuration option otel.instrumentation.logback-appender.experimental.capture-logstash-structured-arguments (defaults to false)
Renames existing capture-logstash-attributes config to capture-logstash-marker-attributes for clarity (with deprecation support)
Splits Logstash marker and structured arguments tests into separate test suites for better organization
Updates documentation with new configuration options

Resolves #14230

otelbot-java-instrumentation · 2025-10-11T18:36:36Z

🔧 The result from spotlessApply was committed to the PR branch.

otelbot-java-instrumentation · 2025-10-11T19:03:58Z

🔧 The result from spotlessApply was committed to the PR branch.

otelbot-java-instrumentation · 2025-10-11T19:45:27Z

🔧 The result from spotlessApply was committed to the PR branch.

otelbot-java-instrumentation · 2025-10-11T21:04:47Z

🔧 The result from spotlessApply was committed to the PR branch.

otelbot-java-instrumentation · 2025-10-12T00:53:30Z

🔧 The result from spotlessApply was committed to the PR branch.

otelbot-java-instrumentation · 2025-10-12T18:55:24Z

🔧 The result from spotlessApply was committed to the PR branch.

trask · 2025-10-12T20:17:07Z

 | `otel.instrumentation.logback-appender.experimental.capture-logger-context-attributes` | Boolean | `false` | Enable the capture of Logback logger context properties as attributes.                                                                                                                     |
 | `otel.instrumentation.logback-appender.experimental.capture-arguments`                 | Boolean | `false` | Enable the capture of Logback logger arguments.                                                                                                                                            |
-| `otel.instrumentation.logback-appender.experimental.capture-logstash-attributes`       | Boolean | `false` | Enable the capture of Logstash attributes, supported are those added to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()` and `Markers.appendRaw()` methods. |
+| `otel.instrumentation.logback-appender.experimental.capture-logstash-marker-attributes`          | Boolean | `false` | Enable the capture of Logstash markers, supported are those added to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()` and `Markers.appendRaw()` methods.    |


renamed capture-logstash-attributes to be more specific: capture-logstash-marker-attributes

to avoid confusion with the new capture-logstash-structured-arguments

trask · 2025-10-12T20:39:05Z

    },
    {
-      "name": "otel.instrumentation.logback-appender.experimental.capture-logstash-attributes",
+      "name": "otel.instrumentation.logback-appender.experimental.capture-logstash-marker-attributes",


@zeitlinger is it ok to remove deprecated property right away here?

trask · 2025-10-12T20:43:11Z

+ * any time.
+ */
+@SuppressWarnings("unused") // keep around for next time even if not currently used
+public final class DeprecatedConfigProperties {


modified version of class from javaagent-extension-api

otelbot-java-instrumentation · 2025-10-12T20:46:52Z

🔧 The result from spotlessApply was committed to the PR branch.

trask · 2025-10-12T20:50:22Z

+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class LogstashMarkerTest {


these tests are just move here from Slf4j2Test.java

trask · 2025-10-12T20:50:57Z

-                .hasInstrumentationScope(instrumentationScopeInfo)
-                .hasBody("log message 1")
-                .hasTotalAttributeCount(codeAttributesLogCount()));
-  }


these tests are just moved to LogstachMarkerTest.java

trask · 2025-10-12T20:51:32Z

+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class LogstashStructuredArgsTest {


new tests for the new feature

trask · 2025-10-12T20:52:16Z

+          }
+          implementation("net.logstash.logback:logstash-logback-encoder") {
+            version {
+              strictly("6.6")


StructuredArguments was introduced after LogstashMarker which is why separate test suite here

otelbot-java-instrumentation · 2025-10-12T20:54:33Z

🔧 The result from spotlessApply was committed to the PR branch.

laurit · 2025-10-13T11:17:19Z

 | `otel.instrumentation.logback-appender.experimental.capture-logger-context-attributes` | Boolean | `false` | Enable the capture of Logback logger context properties as attributes.                                                                                                                     |
 | `otel.instrumentation.logback-appender.experimental.capture-arguments`                 | Boolean | `false` | Enable the capture of Logback logger arguments.                                                                                                                                            |
-| `otel.instrumentation.logback-appender.experimental.capture-logstash-attributes`       | Boolean | `false` | Enable the capture of Logstash attributes, supported are those added to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()` and `Markers.appendRaw()` methods. |
+| `otel.instrumentation.logback-appender.experimental.capture-logstash-marker-attributes`          | Boolean | `false` | Enable the capture of Logstash markers, supported are those added to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()` and `Markers.appendRaw()` methods.    |


I think this file needs a reformat

laurit · 2025-10-13T11:23:16Z

 | `captureLoggerContext`             | Boolean | `false` | Enable the capture of Logback logger context properties as attributes.                                                                                                                                                                            |
 | `captureArguments`                 | Boolean | `false` | Enable the capture of Logback logger arguments.                                                                                                                                                                                                   |
-| `captureLogstashAttributes`        | Boolean | `false` | Enable the capture of Logstash attributes, supported are those added to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()` and `Markers.appendRaw()` methods.                                                        |
+| `captureLogstashMarkerAttributes`           | Boolean | `false` | Enable the capture of Logstash markers, supported are those added to logs via `Markers.append()`, `Markers.appendEntries()`, `Markers.appendArray()` and `Markers.appendRaw()` methods.                                                           |


I think this one also needs a reformat

…ashMarkerTest/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogstashMarkerTest.java Co-authored-by: Lauri Tulmin <[email protected]>

…ashStructuredArgsTest/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogstashStructuredArgsTest.java Co-authored-by: Lauri Tulmin <[email protected]>

Add logstash structured arg support

74d1a1e

docs

feda427

trask force-pushed the logstash-structured-args branch from ab6b5f7 to feda427 Compare October 11, 2025 18:54

github-actions Bot added the test native This label can be applied to PRs to trigger them to run native tests label Oct 11, 2025

trask force-pushed the logstash-structured-args branch from 1195199 to 9373335 Compare October 11, 2025 19:35

renames

25815fa

trask force-pushed the logstash-structured-args branch from df8dd85 to 25815fa Compare October 11, 2025 20:55

fix

5d8517e

trask force-pushed the logstash-structured-args branch from 71f14a8 to 5d8517e Compare October 11, 2025 21:10

trask and others added 3 commits October 11, 2025 14:16

spotless

7fa4c3b

fix

9e12b62

./gradlew spotlessApply

27fbe01

trask and others added 2 commits October 12, 2025 11:47

Better test split

f2a4384

./gradlew spotlessApply

3c54b6e

up

bc58d37

trask commented Oct 12, 2025

View reviewed changes

trask force-pushed the logstash-structured-args branch 4 times, most recently from f52feeb to e8a2d89 Compare October 12, 2025 20:37

trask commented Oct 12, 2025

View reviewed changes

up

23c2f6d

trask force-pushed the logstash-structured-args branch from e8a2d89 to 23c2f6d Compare October 12, 2025 20:40

sync

4ebc217

trask commented Oct 12, 2025

View reviewed changes

simple

b69a47d

trask force-pushed the logstash-structured-args branch from 796011a to b69a47d Compare October 12, 2025 20:47

trask commented Oct 12, 2025

View reviewed changes

trask added 2 commits October 12, 2025 14:32

spotless

08a16d6

fix

4b770a0

trask force-pushed the logstash-structured-args branch from 1b42518 to 4b770a0 Compare October 12, 2025 21:38

trask marked this pull request as ready for review October 12, 2025 22:27

trask requested a review from a team as a code owner October 12, 2025 22:27

laurit reviewed Oct 13, 2025

View reviewed changes

Comment thread ...rkerTest/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogstashMarkerTest.java Outdated

laurit reviewed Oct 13, 2025

View reviewed changes

Comment thread .../java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogstashStructuredArgsTest.java Outdated

laurit reviewed Oct 13, 2025

View reviewed changes

laurit approved these changes Oct 13, 2025

View reviewed changes

trask and others added 3 commits October 13, 2025 12:22

Update instrumentation/logback/logback-appender-1.0/library/src/logst…

cda71d4

…ashMarkerTest/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogstashMarkerTest.java Co-authored-by: Lauri Tulmin <[email protected]>

Update instrumentation/logback/logback-appender-1.0/library/src/logst…

9495361

…ashStructuredArgsTest/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogstashStructuredArgsTest.java Co-authored-by: Lauri Tulmin <[email protected]>

align columns

aad7ecb

trask force-pushed the logstash-structured-args branch from 7c49c5a to aad7ecb Compare October 13, 2025 19:26

trask mentioned this pull request Oct 13, 2025

Add automation for markdown table column alignment #14978

Open

trask added this to the v2.21.0 milestone Oct 13, 2025

trask merged commit dbe4196 into open-telemetry:main Oct 13, 2025
83 checks passed

trask deleted the logstash-structured-args branch October 13, 2025 20:57

trask added the deprecation label Oct 15, 2025

defields923 mentioned this pull request Nov 13, 2025

logback-appender structured arguments incorrect subclass #15290

Closed

Conversation

trask commented Oct 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

otelbot-java-instrumentation Bot commented Oct 11, 2025

Uh oh!

otelbot-java-instrumentation Bot commented Oct 11, 2025

Uh oh!

otelbot-java-instrumentation Bot commented Oct 11, 2025

Uh oh!

otelbot-java-instrumentation Bot commented Oct 11, 2025

Uh oh!

otelbot-java-instrumentation Bot commented Oct 12, 2025

Uh oh!

otelbot-java-instrumentation Bot commented Oct 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trask Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

otelbot-java-instrumentation Bot commented Oct 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

otelbot-java-instrumentation Bot commented Oct 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

trask commented Oct 11, 2025 •

edited

Loading

trask Oct 12, 2025 •

edited

Loading