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.

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

Open telemetry GCP trace support #21

Draft
wants to merge 5 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Autodetect open telemetry so to remap some MDC fields so that GCP tra…
…cing picks them up
  • Loading branch information
skjolber committed Jun 19, 2024
commit f38501b4f1f2a058f70796fc0485aa1f3e3c2dad
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import net.logstash.logback.composite.loggingevent.LogLevelJsonProvider;
import net.logstash.logback.composite.loggingevent.LogLevelValueJsonProvider;
import net.logstash.logback.composite.loggingevent.LoggingEventJsonProviders;
import net.logstash.logback.composite.loggingevent.MdcJsonProvider;
import net.logstash.logback.composite.loggingevent.MessageJsonProvider;
import net.logstash.logback.composite.loggingevent.StackTraceJsonProvider;
import net.logstash.logback.composite.loggingevent.TagsJsonProvider;
Expand Down Expand Up @@ -34,6 +35,8 @@ protected AbstractCompositeJsonFormatter<ILoggingEvent> createFormatter() {
LoggingEventJsonProviders loggingEventJsonProviders = formatter.getProviders();
List<JsonProvider<ILoggingEvent>> providers = new ArrayList<>(loggingEventJsonProviders.getProviders());

boolean openTelemetry = detectOpenTelemetry(); // TODO check if open telemetry is on class path

for (JsonProvider<ILoggingEvent> jsonProvider : providers) {
if(jsonProvider instanceof MessageJsonProvider) {
loggingEventJsonProviders.removeProvider(jsonProvider);
Expand All @@ -49,13 +52,31 @@ protected AbstractCompositeJsonFormatter<ILoggingEvent> createFormatter() {
// stackdriver supports the equivalent functionality as the log level value directly in queries
// see https://cloud.google.com/logging/docs/view/advanced-filters
loggingEventJsonProviders.removeProvider(jsonProvider);
} else if(jsonProvider instanceof MdcJsonProvider p) {
if(openTelemetry) {
p.addExcludeMdcKeyName("traceId");
p.addExcludeMdcKeyName("spanId");
}
}
}

if(openTelemetry) {
loggingEventJsonProviders.addProvider(new StackdriverOpenTelemetryTraceJsonProvider());
}

loggingEventJsonProviders.addProvider(new StackdriverLogSeverityJsonProvider());
loggingEventJsonProviders.addProvider(new StackdriverMessageJsonProvider());

return formatter;
}


private boolean detectOpenTelemetry() {
try {
Class.forName("io.opentelemetry.api.OpenTelemetry");
return true;
} catch (Exception e) {
return false;
}
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package no.entur.logging.cloud.gcp.logback.logstash;

import ch.qos.logback.classic.spi.ILoggingEvent;
import com.fasterxml.jackson.core.JsonGenerator;
import net.logstash.logback.composite.AbstractJsonProvider;

import java.io.IOException;
import java.util.Map;

/**
*
* Add fields so to rename the traceId MDC field to trace for use with GCP Trace explorer.<br>
* <br>
* See https://cloud.google.com/logging/docs/structured-logging for more info.
* <br><br>
* Note: Exclude traceId and spanId in MDC provider.
*
*/

public class StackdriverOpenTelemetryTraceJsonProvider extends AbstractJsonProvider<ILoggingEvent> {

@Override
public void writeTo(JsonGenerator generator, ILoggingEvent iLoggingEvent) throws IOException {
Map<String, String> mdcPropertyMap = iLoggingEvent.getMDCPropertyMap();

// copy value to another field name
String trace = mdcPropertyMap.get("traceId");
if(trace != null) {
generator.writeStringField("trace", trace);
}

// copy through
String spanId = mdcPropertyMap.get("spanId");
if(spanId != null) {
generator.writeStringField("spanId", spanId);
}
}
}
Loading