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

feat: add manual instrumentation host functions to Go SDK #152

Merged
merged 9 commits into from
Jan 17, 2024
Merged

feat: add manual instrumentation host functions to Go SDK #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1821247
feat: add span_enter and span_exit to go sdk
mhmd-azeez Jan 10, 2024
2c64bb1
add more functions
mhmd-azeez Jan 14, 2024
f8f9571
test stdout adapter
mhmd-azeez Jan 15, 2024
99ccdae
test otelstdout
mhmd-azeez Jan 15, 2024
a286c09
logs and metrics
mhmd-azeez Jan 16, 2024
6b4e00b
stub out log and metric impl
mhmd-azeez Jan 16, 2024
37537de
cleanup
mhmd-azeez Jan 16, 2024
1cf0fa7
feat: don't associate logs and metrics with spans
mhmd-azeez Jan 16, 2024
51e1086
cleanup
mhmd-azeez Jan 16, 2024
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
15 changes: 15 additions & 0 deletions go/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"log"
"strings"
"time"

"github.com/tetratelabs/wazero"
Expand Down Expand Up @@ -109,6 +110,20 @@ func (b *AdapterBase) MakeOtelCallSpans(event CallEvent, parentId []byte, traceI
last.Attributes = append(last.Attributes, kv)
}
}
if tags, ok := ev.(SpanTagsEvent); ok {
last := spans[len(spans)-1]

for _, tag := range tags.Tags {
parts := strings.Split(tag, ":")
if len(parts) != 2 {
log.Printf("Invalid tag: %s\n", tag)
continue
}

kv := NewOtelKeyValueString(parts[0], parts[1])
last.Attributes = append(last.Attributes, kv)
}
}
}
return spans
}
Expand Down
13 changes: 13 additions & 0 deletions go/adapter/datadog/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"log"
"net/http"
"net/url"
"strings"
"time"

observe "github.com/dylibso/observe-sdk/go"
Expand Down Expand Up @@ -193,6 +194,18 @@ func (d *DatadogAdapter) makeCallSpans(event observe.CallEvent, parentId *uint64
span := spans[len(spans)-1]
span.AddAllocation(alloc.MemoryGrowAmount())
}
if tags, ok := ev.(observe.SpanTagsEvent); ok {
span := spans[len(spans)-1]
for _, tag := range tags.Tags {
parts := strings.Split(tag, ":")
if len(parts) != 2 {
log.Printf("Invalid tag: %s\n", tag)
continue
}

span.AddTag(parts[0], parts[1])
}
}
}

return spans
Expand Down
4 changes: 4 additions & 0 deletions go/adapter/datadog_formatter/format.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ func (s *Span) AddAllocation(amount uint32) {
}
}

func (s *Span) AddTag(key, value string) {
s.Meta[key] = value
}

func New() *DatadogFormatter {
return &DatadogFormatter{}
}
Expand Down
4 changes: 4 additions & 0 deletions go/adapter/honeycomb/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ func (h *HoneycombAdapter) Flush(evts []observe.TraceEvent) error {
log.Println("MemoryGrowEvent should be attached to a span")
case observe.CustomEvent:
log.Println("Honeycomb adapter does not respect custom events")
case observe.MetricEvent:
log.Println("Honeycomb adapter does not respect metric events")
case observe.LogEvent:
log.Println("Honeycomb adapter does not respect log events")
}
}

Expand Down
4 changes: 4 additions & 0 deletions go/adapter/lightstep/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ func (l *LightstepAdapter) Flush(evts []observe.TraceEvent) error {
log.Println("MemoryGrowEvent should be attached to a span")
case observe.CustomEvent:
log.Println("lightstep adapter does not respect custom events")
case observe.MetricEvent:
log.Println("lightstep adapter does not respect metric events")
case observe.LogEvent:
log.Println("lightstep adapter does not respect log events")
}
}

Expand Down
6 changes: 5 additions & 1 deletion go/adapter/opentelemetry/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type OTelAdapter struct {
Config *OTelConfig
}

// UseCustomClient accepts a pre-initialized client to allow for customization of how to get data into a collector
// UseCustomClient accepts a pre-initialized client to allow for customization of how to get data into a collector
func (a *OTelAdapter) UseCustomClient(client otlptrace.Client) {
if a.Config != nil {
a.Config.client = client
Expand Down Expand Up @@ -122,6 +122,10 @@ func (o *OTelAdapter) Flush(evts []observe.TraceEvent) error {
log.Println("MemoryGrowEvent should be attached to a span")
case observe.CustomEvent:
log.Println("opentelemetry adapter does not respect custom events")
case observe.MetricEvent:
log.Println("opentelemetry adapter does not respect metric events")
case observe.LogEvent:
log.Println("opentelemetry adapter does not respect log events")
}
}

Expand Down
4 changes: 4 additions & 0 deletions go/adapter/otel_stdout/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ func (o *OtelStdoutAdapter) Flush(evts []observe.TraceEvent) error {
log.Println("MemoryGrowEvent should be attached to a span")
case observe.CustomEvent:
log.Println("Otel adapter does not respect custom events")
case observe.MetricEvent:
log.Printf("metric: %s\n", event.Message)
case observe.LogEvent:
log.Println(event.Message)
}
}

Expand Down
7 changes: 7 additions & 0 deletions go/adapter/stdout/adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ func (s *StdoutAdapter) Flush(evts []observe.TraceEvent) error {
log.Println("Allocated", event.MemoryGrowAmount(), "pages of memory in", name)
case observe.CustomEvent:
log.Println(event.Name, event.Time)
case observe.MetricEvent:
log.Printf("metric: %s\n", event.Message)
case observe.LogEvent:
log.Println(event.Message)
}
}
}
Expand All @@ -55,6 +59,9 @@ func (s *StdoutAdapter) printEvents(event observe.CallEvent, indentation int) {
if alloc, ok := event.(observe.MemoryGrowEvent); ok {
log.Println(strings.Repeat(" ", indentation), "Allocated", alloc.MemoryGrowAmount(), "pages of memory in", name)
}
if spanTags, ok := event.(observe.SpanTagsEvent); ok {
log.Println(strings.Repeat(" ", indentation), "Span tags:", spanTags.Tags)
}
}
}

Expand Down
10 changes: 9 additions & 1 deletion go/bin/otelstdout/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"
"time"

observe "github.com/dylibso/observe-sdk/go"
"github.com/dylibso/observe-sdk/go/adapter/otel_stdout"
"github.com/tetratelabs/wazero"
"github.com/tetratelabs/wazero/imports/wasi_snapshot_preview1"
Expand All @@ -27,7 +28,14 @@ func main() {

cfg := wazero.NewRuntimeConfig().WithCustomSections(true)
rt := wazero.NewRuntimeWithConfig(ctx, cfg)
traceCtx, err := adapter.NewTraceCtx(ctx, rt, wasm, nil)
opts := observe.Options{
ChannelBufferSize: 1024,
SpanFilter: &observe.SpanFilter{
MinDuration: 0,
},
}

traceCtx, err := adapter.NewTraceCtx(ctx, rt, wasm, &opts)
if err != nil {
log.Panicln(err)
}
Expand Down
11 changes: 10 additions & 1 deletion go/bin/stdout/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"
"time"

observe "github.com/dylibso/observe-sdk/go"
"github.com/dylibso/observe-sdk/go/adapter/stdout"
"github.com/tetratelabs/wazero"
"github.com/tetratelabs/wazero/imports/wasi_snapshot_preview1"
Expand All @@ -27,7 +28,15 @@ func main() {

cfg := wazero.NewRuntimeConfig().WithCustomSections(true)
rt := wazero.NewRuntimeWithConfig(ctx, cfg)
traceCtx, err := adapter.NewTraceCtx(ctx, rt, wasm, nil)

opts := observe.Options{
ChannelBufferSize: 1024,
SpanFilter: &observe.SpanFilter{
MinDuration: 0,
},
}

traceCtx, err := adapter.NewTraceCtx(ctx, rt, wasm, &opts)
if err != nil {
log.Panicln(err)
}
Expand Down
51 changes: 51 additions & 0 deletions go/event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ const (
RawEnter RawEventKind = iota
RawExit
RawMemoryGrow
RawMetric
RawSpanTags
RawLog
)

type EventKind int
Expand All @@ -21,6 +24,15 @@ const (
Call EventKind = iota
MemoryGrow
Custom
Metric
SpanTags
Log
)

type MetricFormat int

const (
StatsdFormat MetricFormat = 1
)

// Represents the raw event in our Observe form.
Expand Down Expand Up @@ -77,11 +89,38 @@ func (e CustomEvent) RawEvents() []RawEvent {
return []RawEvent{}
}

type MetricEvent struct {
Time time.Time
Format MetricFormat
Message string
}

type SpanTagsEvent struct {
Raw RawEvent
Time time.Time
Tags []string
}

type MemoryGrowEvent struct {
Raw RawEvent
Time time.Time
}

type LogLevel int

const (
Error LogLevel = 1
Warn = 2
Info = 3
Debug = 4
)

type LogEvent struct {
Time time.Time
Message string
Level LogLevel
}

func (e MemoryGrowEvent) RawEvents() []RawEvent {
return []RawEvent{e.Raw}
}
Expand Down Expand Up @@ -113,3 +152,15 @@ func (e CallEvent) FunctionIndex() uint32 {
func (e MemoryGrowEvent) MemoryGrowAmount() uint32 {
return e.Raw.MemoryGrowAmount
}

func (e MetricEvent) RawEvents() []RawEvent {
return []RawEvent{}
}

func (e SpanTagsEvent) RawEvents() []RawEvent {
return []RawEvent{e.Raw}
}

func (e LogEvent) RawEvents() []RawEvent {
return []RawEvent{}
}
14 changes: 8 additions & 6 deletions go/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@ require (

require (
github.com/cenkalti/backoff/v4 v4.2.1 // indirect
github.com/go-logr/logr v1.2.4 // indirect
github.com/go-logr/logr v1.3.0 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/golang/protobuf v1.5.3 // indirect
github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0 // indirect
go.opentelemetry.io/otel v1.18.0 // indirect
go.opentelemetry.io/otel/metric v1.18.0 // indirect
go.opentelemetry.io/otel/sdk v1.18.0 // indirect
go.opentelemetry.io/otel/trace v1.18.0 // indirect
go.opentelemetry.io/otel v1.21.0 // indirect
go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v0.44.0 // indirect
go.opentelemetry.io/otel/metric v1.21.0 // indirect
go.opentelemetry.io/otel/sdk v1.21.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.21.0 // indirect
go.opentelemetry.io/otel/trace v1.21.0 // indirect
golang.org/x/net v0.17.0 // indirect
golang.org/x/sys v0.13.0 // indirect
golang.org/x/sys v0.14.0 // indirect
golang.org/x/text v0.13.0 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20230711160842-782d3b101e98 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20230711160842-782d3b101e98 // indirect
Expand Down
17 changes: 17 additions & 0 deletions go/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ=
github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/go-logr/logr v1.3.0 h1:2y3SDp0ZXuc6/cjLSZ+Q3ir+QB9T/iG5yYRXqsagWSY=
github.com/go-logr/logr v1.3.0/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/golang/glog v1.1.0 h1:/d3pCKDPWNnvIWe0vVUpNP32qc8U3PDVxySP/y360qE=
Expand All @@ -12,6 +14,7 @@ github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg
github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0 h1:YBftPWNWd4WwGqtY2yeZL2ef8rHAxPBD8KFhJpmcqms=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0/go.mod h1:YN5jB8ie0yfIUg6VvR9Kz84aCaG7AsGZnLjhHbUqwPg=
github.com/ianlancetaylor/demangle v0.0.0-20230524184225-eabc099b10ab h1:BA4a7pe6ZTd9F8kXETBoijjFJ/ntaa//1wiH9BZu4zU=
Expand All @@ -24,25 +27,39 @@ github.com/tetratelabs/wazero v1.2.1 h1:J4X2hrGzJvt+wqltuvcSjHQ7ujQxA9gb6PeMs4ql
github.com/tetratelabs/wazero v1.2.1/go.mod h1:wYx2gNRg8/WihJfSDxA1TIL8H+GkfLYm+bIfbblu9VQ=
go.opentelemetry.io/otel v1.18.0 h1:TgVozPGZ01nHyDZxK5WGPFB9QexeTMXEH7+tIClWfzs=
go.opentelemetry.io/otel v1.18.0/go.mod h1:9lWqYO0Db579XzVuCKFNPDl4s73Voa+zEck3wHaAYQI=
go.opentelemetry.io/otel v1.21.0 h1:hzLeKBZEL7Okw2mGzZ0cc4k/A7Fta0uoPgaJCr8fsFc=
go.opentelemetry.io/otel v1.21.0/go.mod h1:QZzNPQPm1zLX4gZK4cMi+71eaorMSGT3A4znnUvNNEo=
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.18.0 h1:IAtl+7gua134xcV3NieDhJHjjOVeJhXAnYf/0hswjUY=
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.18.0/go.mod h1:w+pXobnBzh95MNIkeIuAKcHe/Uu/CX2PKIvBP6ipKRA=
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.18.0 h1:yE32ay7mJG2leczfREEhoW3VfSZIvHaB+gvVo1o8DQ8=
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.18.0/go.mod h1:G17FHPDLt74bCI7tJ4CMitEk4BXTYG4FW6XUpkPBXa4=
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.18.0 h1:6pu8ttx76BxHf+xz/H77AUZkPF3cwWzXqAUsXhVKI18=
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.18.0/go.mod h1:IOmXxPrxoxFMXdNy7lfDmE8MzE61YPcurbUm0SMjerI=
go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v0.44.0 h1:dEZWPjVN22urgYCza3PXRUGEyCB++y1sAqm6guWFesk=
go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v0.44.0/go.mod h1:sTt30Evb7hJB/gEk27qLb1+l9n4Tb8HvHkR0Wx3S6CU=
go.opentelemetry.io/otel/metric v1.18.0 h1:JwVzw94UYmbx3ej++CwLUQZxEODDj/pOuTCvzhtRrSQ=
go.opentelemetry.io/otel/metric v1.18.0/go.mod h1:nNSpsVDjWGfb7chbRLUNW+PBNdcSTHD4Uu5pfFMOI0k=
go.opentelemetry.io/otel/metric v1.21.0 h1:tlYWfeo+Bocx5kLEloTjbcDwBuELRrIFxwdQ36PlJu4=
go.opentelemetry.io/otel/metric v1.21.0/go.mod h1:o1p3CA8nNHW8j5yuQLdc1eeqEaPfzug24uvsyIEJRWM=
go.opentelemetry.io/otel/sdk v1.18.0 h1:e3bAB0wB3MljH38sHzpV/qWrOTCFrdZF2ct9F8rBkcY=
go.opentelemetry.io/otel/sdk v1.18.0/go.mod h1:1RCygWV7plY2KmdskZEDDBs4tJeHG92MdHZIluiYs/M=
go.opentelemetry.io/otel/sdk v1.21.0 h1:FTt8qirL1EysG6sTQRZ5TokkU8d0ugCj8htOgThZXQ8=
go.opentelemetry.io/otel/sdk v1.21.0/go.mod h1:Nna6Yv7PWTdgJHVRD9hIYywQBRx7pbox6nwBnZIxl/E=
go.opentelemetry.io/otel/sdk/metric v1.21.0 h1:smhI5oD714d6jHE6Tie36fPx4WDFIg+Y6RfAY4ICcR0=
go.opentelemetry.io/otel/sdk/metric v1.21.0/go.mod h1:FJ8RAsoPGv/wYMgBdUJXOm+6pzFY3YdljnXtv1SBE8Q=
go.opentelemetry.io/otel/trace v1.18.0 h1:NY+czwbHbmndxojTEKiSMHkG2ClNH2PwmcHrdo0JY10=
go.opentelemetry.io/otel/trace v1.18.0/go.mod h1:T2+SGJGuYZY3bjj5rgh/hN7KIrlpWC5nS8Mjvzckz+0=
go.opentelemetry.io/otel/trace v1.21.0 h1:WD9i5gzvoUPuXIXH24ZNBudiarZDKuekPqi/E8fpfLc=
go.opentelemetry.io/otel/trace v1.21.0/go.mod h1:LGbsEB0f9LGjN+OZaQQ26sohbOmiMR+BaslueVtS/qQ=
go.opentelemetry.io/proto/otlp v1.0.0 h1:T0TX0tmXU8a3CbNXzEKGeU5mIVOdf0oykP+u2lIVU/I=
go.opentelemetry.io/proto/otlp v1.0.0/go.mod h1:Sy6pihPLfYHkr3NkUbEhGHFhINUSI/v80hjKIs5JXpM=
go.uber.org/goleak v1.2.1 h1:NBol2c7O1ZokfZ0LEU9K6Whx/KnwvepVetCUhtKja4A=
golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.14.0 h1:Vz7Qs629MkJkGyHxUlRHizWJRG2j8fbQKjELVSNhy7Q=
golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
Expand Down
8 changes: 8 additions & 0 deletions go/listener.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ func (t *TraceCtx) Before(ctx context.Context, _ api.Module, def api.FunctionDef
case "instrument_memory_grow":
event.Kind = RawMemoryGrow
event.MemoryGrowAmount = uint32(inputs[0])

// manual events
case "span_enter":
event.Kind = RawEnter
case "span_exit":
event.Kind = RawExit
case "span_tags":
event.Kind = RawSpanTags
default:
return
}
Expand Down
Loading
Loading