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

[FVM] let cadence runtime record generic traces #1189

Merged
merged 10 commits into from
Sep 16, 2021
Merged

[FVM] let cadence runtime record generic traces #1189

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1f06e6d
let cadence record generic traces
ramtinms Aug 23, 2021
a1d259c
Merge branch 'master' into ramtin/add-generic-tracing-to-cadence-inte…
ramtinms Aug 23, 2021
afbda1b
make span name child a bit faster
ramtinms Aug 23, 2021
b338ab3
Merge branch 'ramtin/add-generic-tracing-to-cadence-interface' of git…
ramtinms Aug 23, 2021
12ef20f
nest logs checks
ramtinms Aug 23, 2021
7e34dfd
Merge branch 'master' into ramtin/add-generic-tracing-to-cadence-inte…
ramtinms Sep 15, 2021
357271e
Merge branch 'master' into ramtin/add-generic-tracing-to-cadence-inte…
ramtinms Sep 16, 2021
e2ded3a
Merge branch 'master' into ramtin/add-generic-tracing-to-cadence-inte…
ramtinms Sep 16, 2021
cbeb996
Merge branch 'master' into ramtin/add-generic-tracing-to-cadence-inte…
ramtinms Sep 16, 2021
5e57d61
reduce nesting
ramtinms Sep 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 17 additions & 44 deletions fvm/scriptEnv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,70 +660,43 @@ func (e *ScriptEnv) ImplementationDebugLog(message string) error {
return nil
}

func (e *ScriptEnv) ProgramParsed(location common.Location, duration time.Duration) {
func (e *ScriptEnv) RecordTrace(operation string, location common.Location, duration time.Duration, logs []opentracing.LogRecord) {
if e.isTraceable() {
ramtinms marked this conversation as resolved.
Show resolved Hide resolved
locStr := ""
if location != nil {
locStr = location.String()
if logs == nil {
logs = make([]opentracing.LogRecord, 0)
}
logs = append(logs, opentracing.LogRecord{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", location.String())},
})
}
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceParseProgram, duration,
[]opentracing.LogRecord{
{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", locStr)},
},
},
)
spanName := trace.FVMCadenceTrace.Child(operation)
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, spanName, duration, logs)
}
}

func (e *ScriptEnv) ProgramParsed(location common.Location, duration time.Duration) {
e.RecordTrace("parseProgram", location, duration, nil)
e.metrics.ProgramParsed(location, duration)
}

func (e *ScriptEnv) ProgramChecked(location common.Location, duration time.Duration) {
if e.isTraceable() {
locStr := ""
if location != nil {
locStr = location.String()
}
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceCheckProgram, duration,
[]opentracing.LogRecord{{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", locStr)},
},
},
)
}
ramtinms marked this conversation as resolved.
Show resolved Hide resolved
e.RecordTrace("checkProgram", location, duration, nil)
e.metrics.ProgramChecked(location, duration)
}

func (e *ScriptEnv) ProgramInterpreted(location common.Location, duration time.Duration) {
if e.isTraceable() {
locStr := ""
if location != nil {
locStr = location.String()
}
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceInterpretProgram, duration,
[]opentracing.LogRecord{{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", locStr)},
},
},
)
}
e.RecordTrace("interpretProgram", location, duration, nil)
e.metrics.ProgramInterpreted(location, duration)
}

func (e *ScriptEnv) ValueEncoded(duration time.Duration) {
if e.isTraceable() {
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceEncodeValue, duration,
[]opentracing.LogRecord{},
)
}
e.RecordTrace("encodeValue", nil, duration, nil)
e.metrics.ValueEncoded(duration)
}

func (e *ScriptEnv) ValueDecoded(duration time.Duration) {
if e.isTraceable() {
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceDecodeValue, duration,
[]opentracing.LogRecord{},
)
}
e.RecordTrace("decodeValue", nil, duration, nil)
e.metrics.ValueDecoded(duration)
}

Expand Down
62 changes: 18 additions & 44 deletions fvm/transactionEnv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -933,70 +933,44 @@ func (e *TransactionEnv) ImplementationDebugLog(message string) error {
return nil
}

func (e *TransactionEnv) ProgramParsed(location common.Location, duration time.Duration) {
func (e *TransactionEnv) RecordTrace(operation string, location common.Location, duration time.Duration, logs []opentracing.LogRecord) {
if e.isTraceable() {
ramtinms marked this conversation as resolved.
Show resolved Hide resolved
locStr := ""
if location != nil {
locStr = location.String()
if logs == nil {
logs = make([]opentracing.LogRecord, 0)
}
logs = append(logs, opentracing.LogRecord{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", location.String())},
})
}
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceParseProgram, duration,
[]opentracing.LogRecord{
{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", locStr)},
},
},
)

spanName := trace.FVMCadenceTrace.Child(operation)
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, spanName, duration, logs)
}
}

func (e *TransactionEnv) ProgramParsed(location common.Location, duration time.Duration) {
e.RecordTrace("parseProgram", location, duration, nil)
e.metrics.ProgramParsed(location, duration)
}

func (e *TransactionEnv) ProgramChecked(location common.Location, duration time.Duration) {
if e.isTraceable() {
locStr := ""
if location != nil {
locStr = location.String()
}
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceCheckProgram, duration,
[]opentracing.LogRecord{{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", locStr)},
},
},
)
}
e.RecordTrace("checkProgram", location, duration, nil)
e.metrics.ProgramChecked(location, duration)
}

func (e *TransactionEnv) ProgramInterpreted(location common.Location, duration time.Duration) {
if e.isTraceable() {
locStr := ""
if location != nil {
locStr = location.String()
}
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceInterpretProgram, duration,
[]opentracing.LogRecord{{Timestamp: time.Now(),
Fields: []traceLog.Field{traceLog.String("location", locStr)},
},
},
)
}
e.RecordTrace("interpretProgram", location, duration, nil)
e.metrics.ProgramInterpreted(location, duration)
}

func (e *TransactionEnv) ValueEncoded(duration time.Duration) {
if e.isTraceable() {
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceEncodeValue, duration,
[]opentracing.LogRecord{},
)
}
e.RecordTrace("encodeValue", nil, duration, nil)
e.metrics.ValueEncoded(duration)
}

func (e *TransactionEnv) ValueDecoded(duration time.Duration) {
if e.isTraceable() {
e.ctx.Tracer.RecordSpanFromParent(e.traceSpan, trace.FVMCadenceDecodeValue, duration,
[]opentracing.LogRecord{},
)
}
e.RecordTrace("decodeValue", nil, duration, nil)
e.metrics.ValueDecoded(duration)
}

Expand Down
6 changes: 1 addition & 5 deletions module/trace/constants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,7 @@ const (
FVMEnvRemoveAccountContractCode SpanName = "fvm.env.removeAccountContractCode"
FVMEnvGetSigningAccounts SpanName = "fvm.env.getSigningAccounts"

FVMCadenceParseProgram SpanName = "fvm.cadence.parseProgram"
FVMCadenceCheckProgram SpanName = "fvm.cadence.checkProgram"
FVMCadenceInterpretProgram SpanName = "fvm.cadence.interpretProgram"
FVMCadenceEncodeValue SpanName = "fvm.cadence.encodeValue"
FVMCadenceDecodeValue SpanName = "fvm.cadence.decodeValue"
janezpodhostnik marked this conversation as resolved.
Show resolved Hide resolved
FVMCadenceTrace SpanName = "fvm.cadence.trace"
)

// Tag names
Expand Down
4 changes: 4 additions & 0 deletions module/trace/trace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ import (

type SpanName string

func (s SpanName) Child(subOp string) SpanName {
return SpanName(string(s) + "." + subOp)
}

// OpenTracer is the implementation of the Tracer interface
type OpenTracer struct {
opentracing.Tracer
Expand Down