Add logstash structured arg support #14959
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.logback.appender.v1_0; | ||
|
|
||
| import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; | ||
|
|
||
| import io.opentelemetry.api.common.AttributeKey; | ||
| import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension; | ||
| import io.opentelemetry.sdk.common.InstrumentationScopeInfo; | ||
| import io.opentelemetry.sdk.resources.Resource; | ||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import net.logstash.logback.marker.Markers; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class LogstashMarkerTest { | ||
|
||
| private static final Logger logger = LoggerFactory.getLogger("TestLogger"); | ||
|
|
||
| @RegisterExtension | ||
| private static final LibraryInstrumentationExtension testing = | ||
| LibraryInstrumentationExtension.create(); | ||
|
|
||
| private static Resource resource; | ||
| private static InstrumentationScopeInfo instrumentationScopeInfo; | ||
|
|
||
| @BeforeAll | ||
| static void setupAll() { | ||
| resource = Resource.getDefault(); | ||
| instrumentationScopeInfo = InstrumentationScopeInfo.create("TestLogger"); | ||
|
|
||
| OpenTelemetryAppender.install(testing.getOpenTelemetry()); | ||
| } | ||
|
|
||
| @Test | ||
| void logstash() { | ||
| Map<String, Object> entries = new HashMap<>(); | ||
| entries.put("field2", 2); | ||
| entries.put("field3", "value3"); | ||
|
|
||
| logger | ||
| .atInfo() | ||
| .setMessage("log message 1") | ||
| .addMarker(Markers.append("field1", "value1")) | ||
| .addMarker(Markers.append("event.name", "MyEventName")) | ||
| .addMarker(Markers.appendEntries(entries)) | ||
| .log(); | ||
|
|
||
| testing.waitAndAssertLogRecords( | ||
| logRecord -> | ||
| logRecord | ||
| .hasResource(resource) | ||
| .hasInstrumentationScope(instrumentationScopeInfo) | ||
| .hasBody("log message 1") | ||
| .hasTotalAttributeCount(3) // 3 markers (event.name handled separately) | ||
| .hasEventName("MyEventName") | ||
| .hasAttributesSatisfying( | ||
| equalTo(AttributeKey.stringKey("field1"), "value1"), | ||
| equalTo(AttributeKey.longKey("field2"), 2L), | ||
| equalTo(AttributeKey.stringKey("field3"), "value3"))); | ||
| } | ||
|
|
||
| @Test | ||
| void logstashVariousValues() { | ||
| Map<String, Object> entries = new HashMap<>(); | ||
| entries.put("map1", 1); | ||
| entries.put("map2", 2.0); | ||
| entries.put("map3", "text-5"); | ||
| entries.put("map4", null); | ||
|
|
||
| logger | ||
| .atInfo() | ||
| .setMessage("log message 1") | ||
| .addMarker(Markers.append("field1", 1)) | ||
| .addMarker(Markers.append("field2", 2.0)) | ||
| .addMarker(Markers.append("field3", "text-1")) | ||
| .addMarker(Markers.append("field4", true)) | ||
| .addMarker(Markers.append("field5", new Integer[] {1, null, 2, 3})) | ||
| .addMarker(Markers.append("field6", new double[] {1.0, 2.0, 3.0})) | ||
| .addMarker(Markers.append("field7", new String[] {"text-2", "text-3", "text-4", null})) | ||
| .addMarker(Markers.append("field8", new Boolean[] {true, false, true})) | ||
| .addMarker(Markers.appendArray("field9", 1, 2.0, true, "text")) | ||
| .addMarker(Markers.appendRaw("field10", "raw value")) | ||
| .addMarker(Markers.append("field11", Arrays.asList(1, 2, 3))) | ||
| .addMarker(Markers.appendEntries(entries)) | ||
| .log(); | ||
|
|
||
| testing.waitAndAssertLogRecords( | ||
| logRecord -> | ||
| logRecord | ||
| .hasResource(resource) | ||
| .hasInstrumentationScope(instrumentationScopeInfo) | ||
| .hasBody("log message 1") | ||
| // 14 fields (including map keys) | ||
| .hasTotalAttributeCount(14) | ||
| .hasAttributesSatisfying( | ||
| equalTo(AttributeKey.longKey("field1"), 1L), | ||
| equalTo(AttributeKey.doubleKey("field2"), 2.0), | ||
| equalTo(AttributeKey.stringKey("field3"), "text-1"), | ||
| equalTo(AttributeKey.booleanKey("field4"), true), | ||
| equalTo(AttributeKey.longArrayKey("field5"), Arrays.asList(1L, 2L, 3L)), | ||
| equalTo(AttributeKey.doubleArrayKey("field6"), Arrays.asList(1.0, 2.0, 3.0)), | ||
| equalTo( | ||
| AttributeKey.stringArrayKey("field7"), | ||
| Arrays.asList("text-2", "text-3", "text-4")), | ||
| equalTo( | ||
| AttributeKey.booleanArrayKey("field8"), Arrays.asList(true, false, true)), | ||
| equalTo( | ||
| AttributeKey.stringArrayKey("field9"), | ||
| Arrays.asList("1", "2.0", "true", "text")), | ||
| equalTo(AttributeKey.stringKey("field10"), "raw value"), | ||
| equalTo(AttributeKey.stringArrayKey("field11"), Arrays.asList("1", "2", "3")), | ||
| equalTo(AttributeKey.longKey("map1"), 1L), | ||
| equalTo(AttributeKey.doubleKey("map2"), 2.0), | ||
| equalTo(AttributeKey.stringKey("map3"), "text-5"))); | ||
| } | ||
|
|
||
| @Test | ||
| void logstashEmptyAndNullValues() { | ||
| Map<String, Object> noEntries = new HashMap<>(); | ||
|
|
||
| logger | ||
| .atInfo() | ||
| .setMessage("log message 1") | ||
| .addMarker(Markers.appendEntries(noEntries)) | ||
| .addMarker(Markers.append("field2", null)) | ||
| .addMarker(Markers.append("field3", new int[0])) | ||
| .addMarker(Markers.append("field4", new String[0])) | ||
| .addMarker(Markers.appendArray("field5")) | ||
| .addMarker(Markers.appendArray("field6", (Object) null)) | ||
| .addMarker(Markers.appendArray("field7", null, null, null)) | ||
| .log(); | ||
|
|
||
| testing.waitAndAssertLogRecords( | ||
| logRecord -> | ||
| logRecord | ||
| .hasResource(resource) | ||
| .hasInstrumentationScope(instrumentationScopeInfo) | ||
| .hasBody("log message 1") | ||
| .hasTotalAttributeCount(0)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <configuration> | ||
|
|
||
| <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> | ||
| <encoder> | ||
| <pattern> | ||
| %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n | ||
| </pattern> | ||
| </encoder> | ||
| </appender> | ||
|
|
||
| <appender name="OpenTelemetry" | ||
| class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender"> | ||
| <captureLogstashMarkerAttributes>true</captureLogstashMarkerAttributes> | ||
| <captureEventName>true</captureEventName> | ||
| </appender> | ||
|
|
||
| <root level="INFO"> | ||
| <appender-ref ref="console"/> | ||
| <appender-ref ref="OpenTelemetry"/> | ||
| </root> | ||
|
|
||
| </configuration> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
renamed
capture-logstash-attributesto be more specific:capture-logstash-marker-attributesto avoid confusion with the new
capture-logstash-structured-arguments