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

[o11y] Add traceId to user trace #3209

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −8
Draft

[o11y] Add traceId to user trace #3209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions src/workerd/api/trace.c++
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ kj::Array<jsg::Ref<OTelSpan>> getTraceSpans(const Trace& trace) {
return KJ_MAP(x, trace.spans) -> jsg::Ref<OTelSpan> { return jsg::alloc<OTelSpan>(x); };
}

kj::Maybe<kj::String> getTraceIdStr(const Trace& trace) {
return trace.traceId.map([](const auto& traceId) { return traceId.toNetworkOrderHex(); });
}

kj::Array<jsg::Ref<TraceDiagnosticChannelEvent>> getTraceDiagnosticChannelEvents(
jsg::Lock& js, const Trace& trace) {
return KJ_MAP(x, trace.diagnosticChannelEvents) -> jsg::Ref<TraceDiagnosticChannelEvent> {
Expand Down Expand Up @@ -207,6 +211,7 @@ TraceItem::TraceItem(jsg::Lock& js, const Trace& trace)
scriptTags(getTraceScriptTags(trace)),
executionModel(enumToStr(trace.executionModel)),
spans(getTraceSpans(trace)),
traceId(getTraceIdStr(trace)),
outcome(enumToStr(trace.outcome)),
cpuTime(trace.cpuTime / kj::MILLISECONDS),
wallTime(trace.wallTime / kj::MILLISECONDS),
Expand Down Expand Up @@ -292,6 +297,11 @@ kj::ArrayPtr<jsg::Ref<OTelSpan>> TraceItem::getSpans() {
return spans;
}

kj::StringPtr TraceItem::getTraceId() {
// TODO(o11y): Handle this better
return traceId.orDefault(kj::str());
}

kj::StringPtr TraceItem::getOutcome() {
return outcome;
}
Expand Down
3 changes: 3 additions & 0 deletions src/workerd/api/trace.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ class TraceItem final: public jsg::Object {
jsg::Optional<kj::Array<kj::StringPtr>> getScriptTags();
kj::StringPtr getExecutionModel();
kj::ArrayPtr<jsg::Ref<OTelSpan>> getSpans();
kj::StringPtr getTraceId();
kj::StringPtr getOutcome();

uint getCpuTime();
Expand All @@ -163,6 +164,7 @@ class TraceItem final: public jsg::Object {
JSG_LAZY_READONLY_INSTANCE_PROPERTY(logs, getLogs);
if (flags.getTailWorkerUserSpans()) {
JSG_LAZY_READONLY_INSTANCE_PROPERTY(spans, getSpans);
JSG_LAZY_READONLY_INSTANCE_PROPERTY(traceId, getTraceId);
}
JSG_LAZY_READONLY_INSTANCE_PROPERTY(exceptions, getExceptions);
JSG_LAZY_READONLY_INSTANCE_PROPERTY(diagnosticsChannelEvents, getDiagnosticChannelEvents);
Expand Down Expand Up @@ -191,6 +193,7 @@ class TraceItem final: public jsg::Object {
jsg::Optional<kj::Array<kj::String>> scriptTags;
kj::String executionModel;
kj::Array<jsg::Ref<OTelSpan>> spans;
kj::Maybe<kj::String> traceId;
kj::String outcome;
uint cpuTime;
uint wallTime;
Expand Down
26 changes: 24 additions & 2 deletions src/workerd/io/trace.c++
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,13 @@ kj::String TraceId::toW3C() const {
return kj::str(s.releaseAsArray());
}

// Return ID represented as a network-order/big endian hex string.
kj::String TraceId::toNetworkOrderHex() const {
kj::Vector<char> s(32);
addHex(s, __builtin_bswap64(low));
addHex(s, __builtin_bswap64(high));
return kj::str(s.releaseAsArray());
}
namespace {
uint64_t getRandom64Bit(const kj::Maybe<kj::EntropySource&>& entropySource) {
uint64_t ret = 0;
Expand Down Expand Up @@ -208,11 +215,11 @@ InvocationSpanContext InvocationSpanContext::newForInvocation(
TraceId::fromEntropy(entropySource), SpanId::fromEntropy(entropySource), kj::mv(parent));
}

TraceId TraceId::fromCapnp(rpc::InvocationSpanContext::TraceId::Reader reader) {
TraceId TraceId::fromCapnp(rpc::TraceId::Reader reader) {
return TraceId(reader.getLow(), reader.getHigh());
}

void TraceId::toCapnp(rpc::InvocationSpanContext::TraceId::Builder writer) const {
void TraceId::toCapnp(rpc::TraceId::Builder writer) const {
writer.setLow(low);
writer.setHigh(high);
}
Expand Down Expand Up @@ -595,6 +602,11 @@ void Trace::copyTo(rpc::Trace::Builder builder) {
spans[i].copyTo(list[i]);
}
}
// Add trace ID, if available.
KJ_IF_SOME(t, traceId) {
auto traceIdBuilder = builder.initTraceId();
t.toCapnp(traceIdBuilder);
}

{
auto list = builder.initExceptions(exceptions.size());
Expand Down Expand Up @@ -724,6 +736,10 @@ void Trace::mergeFrom(rpc::Trace::Reader reader, PipelineLogLevel pipelineLogLev
if (pipelineLogLevel != PipelineLogLevel::NONE) {
logs.addAll(reader.getLogs());
spans.addAll(reader.getSpans());
// Set traceId, if not set already
if (reader.hasSpans() && traceId == kj::none) {
traceId = tracing::TraceId::fromCapnp(reader.getTraceId());
}
exceptions.addAll(reader.getExceptions());
diagnosticChannelEvents.addAll(reader.getDiagnosticChannelEvents());
}
Expand Down Expand Up @@ -1754,6 +1770,12 @@ void WorkerTracer::addSpan(CompleteSpan&& span) {
trace->numSpans++;
}

void WorkerTracer::setTraceId(tracing::TraceId& traceId) {
if (trace->traceId == kj::none) {
trace->traceId = traceId;
}
}

Span::TagValue spanTagClone(const Span::TagValue& tag) {
KJ_SWITCH_ONEOF(tag) {
KJ_CASE_ONEOF(str, kj::String) {
Expand Down
12 changes: 10 additions & 2 deletions src/workerd/io/trace.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ class TraceId final {
// Replicates W3C Serialization
kj::String toW3C() const;

// Return network order hex representation
kj::String toNetworkOrderHex() const;

// Creates a random Trace Id, optionally using a given entropy source. If an
// entropy source is not given, then we fallback to using BoringSSL's RAND_bytes.
static TraceId fromEntropy(kj::Maybe<kj::EntropySource&> entropy = kj::none);
Expand All @@ -115,8 +118,8 @@ class TraceId final {
return high;
}

static TraceId fromCapnp(rpc::InvocationSpanContext::TraceId::Reader reader);
void toCapnp(rpc::InvocationSpanContext::TraceId::Builder writer) const;
static TraceId fromCapnp(rpc::TraceId::Reader reader);
void toCapnp(rpc::TraceId::Builder writer) const;

private:
uint64_t low = 0;
Expand Down Expand Up @@ -827,7 +830,11 @@ class Trace final: public kj::Refcounted {
kj::Maybe<kj::String> entrypoint;

kj::Vector<tracing::Log> logs;

// trace ID, if user spans are being recorded.
kj::Maybe<tracing::TraceId> traceId;
kj::Vector<CompleteSpan> spans;

// A request's trace can have multiple exceptions due to separate request/waitUntil tasks.
kj::Vector<tracing::Exception> exceptions;

Expand Down Expand Up @@ -945,6 +952,7 @@ class WorkerTracer final: public kj::Refcounted, public BaseTracer {

void addLog(kj::Date timestamp, LogLevel logLevel, kj::String message) override;
void addSpan(CompleteSpan&& span) override;
void setTraceId(tracing::TraceId& traceId);
void addException(kj::Date timestamp,
kj::String name,
kj::String message,
Expand Down
10 changes: 6 additions & 4 deletions src/workerd/io/worker-interface.capnp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ using import "/workerd/io/outcome.capnp".EventOutcome;
using import "/workerd/io/script-version.capnp".ScriptVersion;
using import "/workerd/io/trace.capnp".UserSpanData;

struct TraceId {
high @0 :UInt64;
low @1 :UInt64;
}

struct InvocationSpanContext {
struct TraceId {
high @0 :UInt64;
low @1 :UInt64;
}
traceId @0 :TraceId;
invocationId @1 :TraceId;
spanId @2 :UInt64;
Expand All @@ -44,6 +45,7 @@ struct Trace @0x8e8d911203762d34 {
}

spans @26 :List(UserSpanData);
traceId @27 :TraceId;

exceptions @1 :List(Exception);
struct Exception {
Expand Down
Loading