Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[OneCollectorExporter] Add LogRecord.Body support #1321

Merged
merged 3 commits into from
Aug 25, 2023
Merged

[OneCollectorExporter] Add LogRecord.Body support #1321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e712a3
Add LogRecord.Body support to OneCollectorExporter.
CodeBlanch Aug 24, 2023
82fd577
CHANGELOG patch.
CodeBlanch Aug 24, 2023
84e2372
Merge branch 'main' into onecollector-logrecord-body
CodeBlanch Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/OpenTelemetry.Exporter.OneCollector/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@
`RegisterPayloadTransmittedCallback` API.
([#1309](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1309))

* Added support for sending `LogRecord.Body` as common schema `body` if
`{OriginalFormat}` key is not found.
([#1321](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1321))

* Added support for sending `LogRecord.FormattedMessage` (if set) as common
schema `formattedMessage` if it differs from the detected template (either
`{OriginalFormat}` key or `LogRecord.Body`).
([#1321](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1321))

## 1.5.1

Released 2023-Aug-07
Expand Down
33 changes: 27 additions & 6 deletions ...metry.Exporter.OneCollector/Internal/Serialization/LogRecordCommonSchemaJsonSerializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ internal sealed class LogRecordCommonSchemaJsonSerializer : CommonSchemaJsonSeri
private static readonly JsonEncodedText SeverityTextProperty = JsonEncodedText.Encode("severityText");
private static readonly JsonEncodedText SeverityNumberProperty = JsonEncodedText.Encode("severityNumber");
private static readonly JsonEncodedText BodyProperty = JsonEncodedText.Encode("body");
private static readonly JsonEncodedText FormattedMessageProperty = JsonEncodedText.Encode("formattedMessage");
private static readonly JsonEncodedText DistributedTraceExtensionProperty = JsonEncodedText.Encode("dt");
private static readonly JsonEncodedText DistributedTraceExtensionTraceIdProperty = JsonEncodedText.Encode("traceId");
private static readonly JsonEncodedText DistributedTraceExtensionSpanIdProperty = JsonEncodedText.Encode("spanId");
Expand Down Expand Up @@ -131,7 +132,7 @@ protected override void SerializeItemToJson(Resource resource, LogRecord item, C
writer.WriteString(SeverityTextProperty, LogLevelToSeverityTextMappings[logLevel]);
writer.WriteNumber(SeverityNumberProperty, LogLevelToSeverityNumberMappings[logLevel]);

string? body = null;
string? originalFormat = null;

if (item.Attributes != null)
{
Expand All @@ -146,7 +147,7 @@ protected override void SerializeItemToJson(Resource resource, LogRecord item, C

if (attribute.Key == "{OriginalFormat}")
{
body = attribute.Value as string;
originalFormat = attribute.Value as string;
continue;
}

Expand All @@ -160,13 +161,29 @@ protected override void SerializeItemToJson(Resource resource, LogRecord item, C
}
}

if (!string.IsNullOrEmpty(body))
var hasBody = false;

if (!string.IsNullOrEmpty(originalFormat))
{
writer.WriteString(BodyProperty, originalFormat);
hasBody = true;
}
else if (!string.IsNullOrEmpty(item.Body))
{
writer.WriteString(BodyProperty, body);
writer.WriteString(BodyProperty, item.Body);
hasBody = true;
}
else if (!string.IsNullOrEmpty(item.FormattedMessage))
{
writer.WriteString(BodyProperty, item.FormattedMessage);
writer.WriteString(FormattedMessageProperty, item.FormattedMessage);
}

if (hasBody
&& !string.IsNullOrEmpty(item.FormattedMessage)
&& item.Body != item.FormattedMessage)
{
writer.WriteString(FormattedMessageProperty, item.FormattedMessage);
}

SerializeResourceToJsonInsideCurrentObject(resource, serializationState);
Expand All @@ -184,8 +201,9 @@ private void SerializeExtensionPropertiesToJson(LogRecord item, Utf8JsonWriter w
{
var hasTraceContext = item.TraceId != default;
var hasException = item.Exception != null;
var hasExtensions = serializationState.ExtensionAttributeCount > 0;

if (!hasTraceContext && !hasException && serializationState.ExtensionAttributeCount <= 0)
if (!hasTraceContext && !hasException && !hasExtensions)
{
return;
}
Expand Down Expand Up @@ -215,7 +233,10 @@ private void SerializeExtensionPropertiesToJson(LogRecord item, Utf8JsonWriter w
writer.WriteEndObject();
}

serializationState.SerializeExtensionPropertiesToJson(writeExtensionObjectEnvelope: false);
if (hasExtensions)
{
serializationState.SerializeExtensionPropertiesToJson(writeExtensionObjectEnvelope: false);
}

writer.WriteEndObject();
}
Expand Down
18 changes: 16 additions & 2 deletions test/OpenTelemetry.Exporter.OneCollector.Tests/LogRecordCommonSchemaJsonSerializerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,21 @@ public void LogRecordOriginalFormatBodyJsonTest()
});

Assert.Equal(
$"{{\"ver\":\"4.0\",\"name\":\"Namespace.Name\",\"time\":\"2032-01-18T10:11:12Z\",\"iKey\":\"o:tenant-token\",\"data\":{{\"severityText\":\"Trace\",\"severityNumber\":1,\"body\":\"hello world\"}}}}\n",
$"{{\"ver\":\"4.0\",\"name\":\"Namespace.Name\",\"time\":\"2032-01-18T10:11:12Z\",\"iKey\":\"o:tenant-token\",\"data\":{{\"severityText\":\"Trace\",\"severityNumber\":1,\"body\":\"hello world\",\"formattedMessage\":\"goodbye world\"}}}}\n",
json);
}

[Fact]
public void LogRecordBodyJsonTest()
{
string json = GetLogRecordJson(1, (index, logRecord) =>
{
logRecord.Body = "hello world";
logRecord.FormattedMessage = "goodbye world";
});

Assert.Equal(
$"{{\"ver\":\"4.0\",\"name\":\"Namespace.Name\",\"time\":\"2032-01-18T10:11:12Z\",\"iKey\":\"o:tenant-token\",\"data\":{{\"severityText\":\"Trace\",\"severityNumber\":1,\"body\":\"hello world\",\"formattedMessage\":\"goodbye world\"}}}}\n",
json);
}

Expand All @@ -132,7 +146,7 @@ public void LogRecordFormattedMessageBodyJsonTest()
});

Assert.Equal(
$"{{\"ver\":\"4.0\",\"name\":\"Namespace.Name\",\"time\":\"2032-01-18T10:11:12Z\",\"iKey\":\"o:tenant-token\",\"data\":{{\"severityText\":\"Trace\",\"severityNumber\":1,\"body\":\"goodbye world\"}}}}\n",
$"{{\"ver\":\"4.0\",\"name\":\"Namespace.Name\",\"time\":\"2032-01-18T10:11:12Z\",\"iKey\":\"o:tenant-token\",\"data\":{{\"severityText\":\"Trace\",\"severityNumber\":1,\"body\":\"goodbye world\",\"formattedMessage\":\"goodbye world\"}}}}\n",
json);
}

Expand Down
Loading