From deb62f52d0682ab3c55452271aaa591975d9582e Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Sun, 21 Jan 2024 12:41:49 +0200 Subject: [PATCH 1/6] initial manual instrumentation support --- go.work.sum | 35 ++++++- sample-app/go.mod | 2 +- sample-app/main.go | 45 +++++---- semconv-ai/attributes.go | 36 +++++++ semconv-ai/go.mod | 5 + semconv-ai/go.sum | 12 +++ traceloop-sdk/dto/tracing.go | 30 ++++++ traceloop-sdk/go.mod | 26 ++++- traceloop-sdk/go.sum | 46 ++++++++- traceloop-sdk/prompt_registry.go | 109 ++++++++++++++++++++ traceloop-sdk/sdk.go | 164 +++++++++++-------------------- traceloop-sdk/tracing.go | 67 +++++++++++++ traceloop-sdk/utils.go | 4 +- 13 files changed, 443 insertions(+), 138 deletions(-) create mode 100644 semconv-ai/attributes.go create mode 100644 semconv-ai/go.mod create mode 100644 semconv-ai/go.sum create mode 100644 traceloop-sdk/dto/tracing.go create mode 100644 traceloop-sdk/prompt_registry.go create mode 100644 traceloop-sdk/tracing.go diff --git a/go.work.sum b/go.work.sum index b65bd2c..2fc93f2 100644 --- a/go.work.sum +++ b/go.work.sum @@ -1,8 +1,39 @@ +cloud.google.com/go/compute v1.23.0/go.mod h1:4tCnrn48xsqlwSAiLf1HXMQk8CONslYbdiEZc9FEIbM= +cloud.google.com/go/compute/metadata v0.2.3/go.mod h1:VAV5nSsACxMJvgaAuX6Pk2AawlZn8kiOGuCv6gTkwuA= dario.cat/mergo v1.0.0/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk= github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM= +github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/census-instrumentation/opencensus-proto v0.4.1/go.mod h1:4T9NM4+4Vw91VeyqjLS6ao50K5bOcLKN6Q42XnYaRYw= +github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/cloudflare/circl v1.3.3/go.mod h1:5XYMA4rFBvNIrhs50XuiBJ15vF2pZn4nnUKZrLbUZFA= +github.com/cncf/udpa/go v0.0.0-20220112060539-c52dc94e7fbe/go.mod h1:6pvJx4me5XPnfI9Z40ddWsdw2W/uZgQLFXToKeRcDiI= +github.com/cncf/xds/go v0.0.0-20230607035331-e9ce68804cb4/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/elazarl/goproxy v0.0.0-20230808193330-2592e75ae04a/go.mod h1:Ro8st/ElPeALwNFlcTpWmkr6IoMFfkjXAvTHpevnDsM= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/envoyproxy/protoc-gen-validate v1.0.2/go.mod h1:GpiZQP3dDbg4JouG/NNS7QWXpgx6x8QiMKdmN72jogE= +github.com/gliderlabs/ssh v0.3.5/go.mod h1:8XB4KraRrX39qHhT6yxPsHedjA08I/uBVwj4xC+/+z4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= -github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/uuid v1.3.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= github.com/klauspost/compress v1.15.15/go.mod h1:ZcK2JAFqKOpnBlxcLsJzYfrS9X1akm9fHZNnD9+Vo/4= +github.com/onsi/gomega v1.27.10/go.mod h1:RsS8tutOdbdgzbPtzzATp12yT7kM5I5aElG3evPbQ0M= +github.com/pjbgf/sha1cd v0.3.0/go.mod h1:nZ1rrWOcGJ5uZgEEVL1VUM9iRQiZvWdbZjkKyFzPPsI= +github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= +github.com/skeema/knownhosts v1.2.1/go.mod h1:xYbVRSPxqBZFrdmDyMmsOs+uX1UZC3nTN3ThzgDxUwo= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.16.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4= golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/oauth2 v0.13.0/go.mod h1:/JMhi4ZRXAf4HG9LiNmxvk+45+96RUlVThiH8FzNBn0= +golang.org/x/term v0.15.0/go.mod h1:BDl952bC7+uMoWR75FIrCDx79TPU9oHkTZ9yRbYOrX0= +golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +google.golang.org/appengine v1.6.8/go.mod h1:1jJ3jBArFh5pcgW8gCtRJnepW8FzD1V44FJffLiz/Ds= +google.golang.org/genproto v0.0.0-20231002182017-d307bd883b97 h1:SeZZZx0cP0fqUyA+oRzP9k7cSwJlvDFiROO72uwD6i0= +google.golang.org/genproto v0.0.0-20231002182017-d307bd883b97/go.mod h1:t1VqOqqvce95G3hIDCT5FeO3YUc6Q4Oe24L/+rNMxRk= +google.golang.org/genproto/googleapis/api v0.0.0-20230530153820-e85fd2cbaebc/go.mod h1:vHYtlOoi6TsQ3Uk2yxR7NI5z8uoV+3pZtR4jmHIkRig= +google.golang.org/genproto/googleapis/rpc v0.0.0-20230530153820-e85fd2cbaebc/go.mod h1:66JfowdXAEgad5O9NnYcsNPLCPZJD++2L9X0PCMODrA= +google.golang.org/grpc v1.56.2/go.mod h1:I9bI3vqKfayGqPUAwGdOSu7kt6oIJLixfffKrpXqQ9s= diff --git a/sample-app/go.mod b/sample-app/go.mod index e3fc172..b7720b2 100644 --- a/sample-app/go.mod +++ b/sample-app/go.mod @@ -1,5 +1,5 @@ module github.com/traceloop/go-openllmetry/sample-app -go 1.21.4 +go 1.21 require github.com/sashabaranov/go-openai v1.18.1 diff --git a/sample-app/main.go b/sample-app/main.go index fd61ee9..7e4c2eb 100644 --- a/sample-app/main.go +++ b/sample-app/main.go @@ -2,38 +2,41 @@ package main import ( "context" - "fmt" "os" - openai "github.com/sashabaranov/go-openai" sdk "github.com/traceloop/go-openllmetry/traceloop-sdk" "github.com/traceloop/go-openllmetry/traceloop-sdk/config" ) func main() { + ctx := context.Background() + traceloop := sdk.NewClient(config.Config{ - BaseURL: "https://api-staging.traceloop.com", + BaseURL: "api-staging.traceloop.com", APIKey: os.Getenv("TRACELOOP_API_KEY"), }) - traceloop.Initialize() + traceloop.Initialize(ctx) + - request, err := traceloop.GetOpenAIChatCompletionRequest("eval-test", map[string]interface{}{ "a": "workout" }) - if err != nil { - fmt.Printf("GetOpenAIChatCompletionRequest error: %v\n", err) - return - } + // request, err := traceloop.GetOpenAIChatCompletionRequest("eval-test", map[string]interface{}{ "a": "workout" }) + // if err != nil { + // fmt.Printf("GetOpenAIChatCompletionRequest error: %v\n", err) + // return + // } - client := openai.NewClient(os.Getenv("OPENAI_API_KEY")) - resp, err := client.CreateChatCompletion( - context.Background(), - *request, - ) - - if err != nil { - fmt.Printf("ChatCompletion error: %v\n", err) - return - } - - fmt.Println(resp.Choices[0].Message.Content) + // client := openai.NewClient(os.Getenv("OPENAI_API_KEY")) + // resp, err := client.CreateChatCompletion( + // context.Background(), + // *request, + // ) + + // if err != nil { + // fmt.Printf("ChatCompletion error: %v\n", err) + // return + // } + + // fmt.Println(resp.Choices[0].Message.Content) + + traceloop.LogPrompt(ctx) } diff --git a/semconv-ai/attributes.go b/semconv-ai/attributes.go new file mode 100644 index 0000000..4578fa2 --- /dev/null +++ b/semconv-ai/attributes.go @@ -0,0 +1,36 @@ +package semconvai + +import "go.opentelemetry.io/otel/attribute" + +const ( + // LLM + LLMVendor = attribute.Key("llm.vendor") + LLMRequestType = attribute.Key("llm.request.type") + LLMRequestModel = attribute.Key("llm.request.model") + LLMResponseModel = attribute.Key("llm.response.model") + LLMRequestMaxTokens = attribute.Key("llm.request.max_tokens") + LLMUsageTotalTokens = attribute.Key("llm.usage.total_tokens") + LLMUsageCompletionTokens = attribute.Key("llm.usage.completion_tokens") + LLMUsagePromptTokens = attribute.Key("llm.usage.prompt_tokens") + LLMTemperature = attribute.Key("llm.temperature") + LLMUser = attribute.Key("llm.user") + LLMHeaders = attribute.Key("llm.headers") + LLMTopP = attribute.Key("llm.top_p") + LLMTopK = attribute.Key("llm.top_k") + LLMFrequencyPenalty = attribute.Key("llm.frequency_penalty") + LLMPresencePenalty = attribute.Key("llm.presence_penalty") + LLMPrompts = attribute.Key("llm.prompts") + LLMCompletions = attribute.Key("llm.completions") + LLMChatStopSequence = attribute.Key("llm.chat.stop_sequences") + LLMRequestFunctions = attribute.Key("llm.request.functions") + + // Vector DB + VectorDBVendor = attribute.Key("vector_db.vendor") + VectorDBQueryTopK = attribute.Key("vector_db.query.top_k") + + // LLM Workflows + TraceloopSpanKind = attribute.Key("traceloop.span.kind") + TraceloopWorkflowName = attribute.Key("traceloop.workflow.name") + TraceloopEntityName = attribute.Key("traceloop.entity.name") + TraceloopAssociationProperties = attribute.Key("traceloop.association.properties") +) \ No newline at end of file diff --git a/semconv-ai/go.mod b/semconv-ai/go.mod new file mode 100644 index 0000000..e0bbac9 --- /dev/null +++ b/semconv-ai/go.mod @@ -0,0 +1,5 @@ +module github.com/traceloop/go-openllmetry/semconv-ai + +go 1.21 + +require go.opentelemetry.io/otel v1.22.0 diff --git a/semconv-ai/go.sum b/semconv-ai/go.sum new file mode 100644 index 0000000..4d1278e --- /dev/null +++ b/semconv-ai/go.sum @@ -0,0 +1,12 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +go.opentelemetry.io/otel v1.22.0 h1:xS7Ku+7yTFvDfDraDIJVpw7XPyuHlB9MCiqqX5mcJ6Y= +go.opentelemetry.io/otel v1.22.0/go.mod h1:eoV4iAi3Ea8LkAEI9+GFT44O6T/D0GWAVFyZVCC6pMI= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/traceloop-sdk/dto/tracing.go b/traceloop-sdk/dto/tracing.go new file mode 100644 index 0000000..f050529 --- /dev/null +++ b/traceloop-sdk/dto/tracing.go @@ -0,0 +1,30 @@ +package dto + +type Message struct { + Index int `json:"index"` + Role string `json:"role"` + Content string `json:"content"` +} + +type Prompt struct { + Vendor string `json:"vendor"` + Model string `json:"model"` + Mode string `json:"mode"` + Temperature float32 `json:"temperature"` + TopP float32 `json:"top_p"` + Stop []string `json:"stop"` + FrequencyPenalty float32 `json:"frequency_penalty"` + PresencePenalty float32 `json:"presence_penalty"` + Messages []Message `json:"messages"` +} + +type Completion struct { + Model string `json:"model"` + Messages []Message `json:"messages"` +} + +type TraceloopAttributes struct { + WorkflowName string `json:"workflow_name"` + EntityName string `json:"entity_name"` + AssociationProperties map[string]string `json:"association_properties"` +} diff --git a/traceloop-sdk/go.mod b/traceloop-sdk/go.mod index a60d608..b44979c 100644 --- a/traceloop-sdk/go.mod +++ b/traceloop-sdk/go.mod @@ -1,11 +1,28 @@ module github.com/traceloop/go-openllmetry/traceloop-sdk -go 1.21.4 +go 1.21 require ( - github.com/cenkalti/backoff/v4 v4.2.1 github.com/kluctl/go-jinja2 v0.0.0-20240108142937-8839259d2537 github.com/sashabaranov/go-openai v1.18.1 + go.opentelemetry.io/otel v1.22.0 + go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.22.0 + go.opentelemetry.io/otel/trace v1.22.0 +) + +require ( + github.com/cenkalti/backoff/v4 v4.2.1 // indirect + github.com/go-logr/logr v1.4.1 // 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/metric v1.22.0 // indirect + go.opentelemetry.io/proto/otlp v1.0.0 // indirect + golang.org/x/text v0.14.0 // indirect + google.golang.org/genproto/googleapis/api v0.0.0-20231002182017-d307bd883b97 // indirect + google.golang.org/genproto/googleapis/rpc v0.0.0-20231002182017-d307bd883b97 // indirect + google.golang.org/grpc v1.60.1 // indirect + google.golang.org/protobuf v1.32.0 // indirect ) require ( @@ -21,8 +38,11 @@ require ( github.com/kluctl/go-embed-python v0.0.0-3.11.6-20231002-1 // indirect github.com/rogpeppe/go-internal v1.11.0 // indirect github.com/sirupsen/logrus v1.9.3 // indirect + go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.22.0 + go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.22.0 + go.opentelemetry.io/otel/sdk v1.22.0 golang.org/x/net v0.19.0 // indirect golang.org/x/sync v0.5.0 // indirect - golang.org/x/sys v0.15.0 // indirect + golang.org/x/sys v0.16.0 // indirect gopkg.in/warnings.v0 v0.1.2 // indirect ) diff --git a/traceloop-sdk/go.sum b/traceloop-sdk/go.sum index def4774..e4f1d96 100644 --- a/traceloop-sdk/go.sum +++ b/traceloop-sdk/go.sum @@ -13,8 +13,21 @@ github.com/go-git/go-billy/v5 v5.5.0 h1:yEY4yhzCDuMGSv83oGxiBotRzhwhNr8VZyphhiu+ github.com/go-git/go-billy/v5 v5.5.0/go.mod h1:hmexnoNsr2SJU1Ju67OaNz5ASJY3+sHgFRpCtpDCKow= github.com/go-git/go-git/v5 v5.11.0 h1:XIZc1p+8YzypNr34itUfSvYJcv+eYdTnTvOZ2vD3cA4= github.com/go-git/go-git/v5 v5.11.0/go.mod h1:6GFcX2P3NM7FPBfpePbpLd21XxsgdAt+lKqXmCUiUCY= +github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= +github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ= +github.com/go-logr/logr v1.4.1/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/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y= github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +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.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +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/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= @@ -46,13 +59,42 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +go.opentelemetry.io/otel v1.22.0 h1:xS7Ku+7yTFvDfDraDIJVpw7XPyuHlB9MCiqqX5mcJ6Y= +go.opentelemetry.io/otel v1.22.0/go.mod h1:eoV4iAi3Ea8LkAEI9+GFT44O6T/D0GWAVFyZVCC6pMI= +go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.22.0 h1:9M3+rhx7kZCIQQhQRYaZCdNu1V73tm4TvXs2ntl98C4= +go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.22.0/go.mod h1:noq80iT8rrHP1SfybmPiRGc9dc5M8RPmGvtwo7Oo7tc= +go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.22.0 h1:FyjCyI9jVEfqhUh2MoSkmolPjfh5fp2hnV0b0irxH4Q= +go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.22.0/go.mod h1:hYwym2nDEeZfG/motx0p7L7J1N1vyzIThemQsb4g2qY= +go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.22.0 h1:zr8ymM5OWWjjiWRzwTfZ67c905+2TMHYp2lMJ52QTyM= +go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.22.0/go.mod h1:sQs7FT2iLVJ+67vYngGJkPe1qr39IzaBzaj9IDNNY8k= +go.opentelemetry.io/otel/metric v1.22.0 h1:lypMQnGyJYeuYPhOM/bgjbFM6WE44W1/T45er4d8Hhg= +go.opentelemetry.io/otel/metric v1.22.0/go.mod h1:evJGjVpZv0mQ5QBRJoBF64yMuOf4xCWdXjK8pzFvliY= +go.opentelemetry.io/otel/sdk v1.22.0 h1:6coWHw9xw7EfClIC/+O31R8IY3/+EiRFHevmHafB2Gw= +go.opentelemetry.io/otel/sdk v1.22.0/go.mod h1:iu7luyVGYovrRpe2fmj3CVKouQNdTOkxtLzPvPz1DOc= +go.opentelemetry.io/otel/trace v1.22.0 h1:Hg6pPujv0XG9QaVbGOBVHunyuLcCC3jN7WEhPx83XD0= +go.opentelemetry.io/otel/trace v1.22.0/go.mod h1:RbbHXVqKES9QhzZq/fE5UnOSILqRt40a21sPw2He1xo= +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= golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c= golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U= golang.org/x/sync v0.5.0 h1:60k92dhOjHxJkrqnwsfl8KuaHbn/5dl0lUPUklKo3qE= golang.org/x/sync v0.5.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc= -golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU= +golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/genproto/googleapis/api v0.0.0-20231002182017-d307bd883b97 h1:W18sezcAYs+3tDZX4F80yctqa12jcP1PUS2gQu1zTPU= +google.golang.org/genproto/googleapis/api v0.0.0-20231002182017-d307bd883b97/go.mod h1:iargEX0SFPm3xcfMI0d1domjg0ZF4Aa0p2awqyxhvF0= +google.golang.org/genproto/googleapis/rpc v0.0.0-20231002182017-d307bd883b97 h1:6GQBEOdGkX6MMTLT9V+TjtIRZCw9VPD5Z+yHY9wMgS0= +google.golang.org/genproto/googleapis/rpc v0.0.0-20231002182017-d307bd883b97/go.mod h1:v7nGkzlmW8P3n/bKmWBn2WpBjpOEx8Q6gMueudAmKfY= +google.golang.org/grpc v1.60.1 h1:26+wFr+cNqSGFcOXcabYC0lUVJVRa2Sb2ortSK7VrEU= +google.golang.org/grpc v1.60.1/go.mod h1:OlCHIeLYqSSsLi6i49B5QGdzaMZK9+M7LXN2FKz4eGM= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +google.golang.org/protobuf v1.32.0 h1:pPC6BG5ex8PDFnkbrGU3EixyhKcQ2aDuBS36lqK/C7I= +google.golang.org/protobuf v1.32.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= diff --git a/traceloop-sdk/prompt_registry.go b/traceloop-sdk/prompt_registry.go new file mode 100644 index 0000000..abe6093 --- /dev/null +++ b/traceloop-sdk/prompt_registry.go @@ -0,0 +1,109 @@ +package traceloop + +import ( + "encoding/json" + "fmt" + "time" + + "github.com/kluctl/go-jinja2" + "github.com/sashabaranov/go-openai" + "github.com/traceloop/go-openllmetry/traceloop-sdk/dto" + "github.com/traceloop/go-openllmetry/traceloop-sdk/model" +) + +func (instance *Traceloop) populatePromptRegistry() { + resp, err := instance.fetchPathWithRetry(PromptsPath, instance.config.BackoffConfig.MaxRetries) + if err != nil { + fmt.Println(err) + return + } + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response dto.PromptsResponse + err = decoder.Decode(&response) + if err != nil { + fmt.Println(err) + } + + for _, prompt := range response.Prompts { + instance.promptRegistry[prompt.Key] = &prompt + } +} + +func (instance *Traceloop) pollPrompts() { + prompts := make(chan []model.Prompt) + errs := make(chan error) + + instance.populatePromptRegistry() + +go func() { + defer close(prompts) + defer close(errs) + + ticker := time.NewTicker(instance.config.PollingInterval) + + for range ticker.C { + instance.populatePromptRegistry() + } +}() +} + +func (instance *Traceloop) getPromptVersion(key string) (*model.PromptVersion, error) { + if instance.promptRegistry[key] == nil { + return nil, fmt.Errorf("prompt with key %s not found", key) + } + + if instance.promptRegistry[key].Target.Version == "" { + return nil, fmt.Errorf("prompt with key %s has no version", key) + } + + var promptVersion model.PromptVersion + for _, version := range instance.promptRegistry[key].Versions { + if version.Id == instance.promptRegistry[key].Target.Version { + promptVersion = version + } + } + + if promptVersion.Id == "" { + return nil, fmt.Errorf("prompt version was not found") + } + + return &promptVersion, nil +} + +func (instance *Traceloop) GetOpenAIChatCompletionRequest(key string, variables map[string]any) (*openai.ChatCompletionRequest, error) { + promptVersion, err := instance.getPromptVersion(key) + if err != nil { + return nil, err + } + + jinjaRenderer, err := jinja2.NewJinja2("renderer", 1, jinja2.WithGlobals(variables)) + if err != nil { + return nil, err + } + + var messages []openai.ChatCompletionMessage + + for _, message := range promptVersion.Messages { + renderedMessage, err := jinjaRenderer.RenderString(message.Template) + if err != nil { + return nil, err + } + + messages = append(messages, openai.ChatCompletionMessage{ + Role: message.Role, + Content: renderedMessage, + }) + } + + return &openai.ChatCompletionRequest{ + Model: promptVersion.LlmConfig.Model, + Temperature: promptVersion.LlmConfig.Temperature, + TopP: promptVersion.LlmConfig.TopP, + Stop: promptVersion.LlmConfig.Stop, + FrequencyPenalty: promptVersion.LlmConfig.FrequencyPenalty, + PresencePenalty: promptVersion.LlmConfig.PresencePenalty, + Messages: messages, + }, nil +} \ No newline at end of file diff --git a/traceloop-sdk/sdk.go b/traceloop-sdk/sdk.go index 2f9da88..1e3820c 100644 --- a/traceloop-sdk/sdk.go +++ b/traceloop-sdk/sdk.go @@ -1,15 +1,16 @@ package traceloop import ( - "encoding/json" + "context" "fmt" "net/http" "os" "time" - "github.com/kluctl/go-jinja2" - "github.com/sashabaranov/go-openai" + "go.opentelemetry.io/otel/attribute" + "go.opentelemetry.io/otel/trace" + semconvai "github.com/traceloop/go-openllmetry/semconv-ai" "github.com/traceloop/go-openllmetry/traceloop-sdk/config" "github.com/traceloop/go-openllmetry/traceloop-sdk/dto" "github.com/traceloop/go-openllmetry/traceloop-sdk/model" @@ -18,138 +19,87 @@ import ( const PromptsPath = "/v1/traceloop/prompts" type Traceloop struct { - Config config.Config - PromptRegistry model.PromptRegistry + config config.Config + promptRegistry model.PromptRegistry + tracer trace.Tracer http.Client } func NewClient(config config.Config) *Traceloop { return &Traceloop{ - Config: config, - PromptRegistry: make(model.PromptRegistry), + config: config, + promptRegistry: make(model.PromptRegistry), Client: http.Client{}, } } -func (instance *Traceloop) Initialize() { - instance.PromptRegistry = make(model.PromptRegistry) - - if instance.Config.BaseURL == "" { +func (instance *Traceloop) Initialize(ctx context.Context) { + if instance.config.BaseURL == "" { baseUrl := os.Getenv("TRACELOOP_BASE_URL") if baseUrl == "" { - instance.Config.BaseURL = "https://api.traceloop.com" + instance.config.BaseURL = "https://api.traceloop.com" } else { - instance.Config.BaseURL = baseUrl + instance.config.BaseURL = baseUrl } } - if instance.Config.PollingInterval == 0 { + if instance.config.PollingInterval == 0 { pollingInterval := os.Getenv("TRACELOOP_SECONDS_POLLING_INTERVAL") if pollingInterval == "" { - instance.Config.PollingInterval = 5 * time.Second + instance.config.PollingInterval = 5 * time.Second } else { - instance.Config.PollingInterval, _ = time.ParseDuration(pollingInterval) + instance.config.PollingInterval, _ = time.ParseDuration(pollingInterval) } } - fmt.Printf("Traceloop %s SDK initialized. Connecting to %s\n", instance.GetVersion(), instance.Config.BaseURL) + fmt.Printf("Traceloop %s SDK initialized. Connecting to %s\n", instance.GetVersion(), instance.config.BaseURL) + instance.initTracer(ctx, "GoExampleService") instance.pollPrompts() } -func (instance *Traceloop) populatePromptRegistry() { - resp, err := instance.fetchPathWithRetry(PromptsPath, instance.Config.BackoffConfig.MaxRetries) - if err != nil { - fmt.Println(err) - return - } - defer resp.Body.Close() - decoder := json.NewDecoder(resp.Body) - - var response dto.PromptsResponse - err = decoder.Decode(&response) - if err != nil { - fmt.Println(err) - } - - for _, prompt := range response.Prompts { - instance.PromptRegistry[prompt.Key] = &prompt - } -} - -func (instance *Traceloop) pollPrompts() { - prompts := make(chan []model.Prompt) - errs := make(chan error) - - instance.populatePromptRegistry() - -go func() { - defer close(prompts) - defer close(errs) - - ticker := time.NewTicker(instance.Config.PollingInterval) - - for range ticker.C { - instance.populatePromptRegistry() - } -}() -} - -func (instance *Traceloop) getPromptVersion(key string) (*model.PromptVersion, error) { - if instance.PromptRegistry[key] == nil { - return nil, fmt.Errorf("prompt with key %s not found", key) +func (instance *Traceloop) LogPrompt(ctx context.Context, prompt dto.Prompt, completion dto.Completion, traceloopAttrs dto.TraceloopAttributes) error { + spanName := fmt.Sprintf("%s.%s", prompt.Vendor, prompt.Mode) + _, span := instance.tracer.Start(ctx, spanName) + + span.SetAttributes( + semconvai.LLMVendor.String(prompt.Vendor), + semconvai.LLMRequestModel.String(prompt.Model), + semconvai.LLMRequestType.String(prompt.Mode), + semconvai.LLMResponseModel.String(completion.Model), + semconvai.TraceloopWorkflowName.String(traceloopAttrs.WorkflowName), + semconvai.TraceloopEntityName.String(traceloopAttrs.EntityName), + ) + + for _, message := range prompt.Messages { + attrsPrefix := fmt.Sprintf("llm.prompts.%d", message.Index) + span.SetAttributes( + attribute.KeyValue{ + Key: attribute.Key(attrsPrefix + ".content"), + Value: attribute.StringValue(message.Content), + }, + attribute.KeyValue{ + Key: attribute.Key(attrsPrefix + ".role"), + Value: attribute.StringValue(message.Role), + }, + ) } - if instance.PromptRegistry[key].Target.Version == "" { - return nil, fmt.Errorf("prompt with key %s has no version", key) + for _, message := range completion.Messages { + attrsPrefix := fmt.Sprintf("llm.completions.%d", message.Index) + span.SetAttributes( + attribute.KeyValue{ + Key: attribute.Key(attrsPrefix + ".content"), + Value: attribute.StringValue(message.Content), + }, + attribute.KeyValue{ + Key: attribute.Key(attrsPrefix + ".role"), + Value: attribute.StringValue(message.Role), + }, + ) } - var promptVersion model.PromptVersion - for _, version := range instance.PromptRegistry[key].Versions { - if version.Id == instance.PromptRegistry[key].Target.Version { - promptVersion = version - } - } - - if promptVersion.Id == "" { - return nil, fmt.Errorf("prompt version was not found") - } - - return &promptVersion, nil -} - -func (instance *Traceloop) GetOpenAIChatCompletionRequest(key string, variables map[string]any) (*openai.ChatCompletionRequest, error) { - promptVersion, err := instance.getPromptVersion(key) - if err != nil { - return nil, err - } - - jinjaRenderer, err := jinja2.NewJinja2("renderer", 1, jinja2.WithGlobals(variables)) - if err != nil { - return nil, err - } - - var messages []openai.ChatCompletionMessage - - for _, message := range promptVersion.Messages { - renderedMessage, err := jinjaRenderer.RenderString(message.Template) - if err != nil { - return nil, err - } - - messages = append(messages, openai.ChatCompletionMessage{ - Role: message.Role, - Content: renderedMessage, - }) - } + defer span.End() - return &openai.ChatCompletionRequest{ - Model: promptVersion.LlmConfig.Model, - Temperature: promptVersion.LlmConfig.Temperature, - TopP: promptVersion.LlmConfig.TopP, - Stop: promptVersion.LlmConfig.Stop, - FrequencyPenalty: promptVersion.LlmConfig.FrequencyPenalty, - PresencePenalty: promptVersion.LlmConfig.PresencePenalty, - Messages: messages, - }, nil + return nil } diff --git a/traceloop-sdk/tracing.go b/traceloop-sdk/tracing.go new file mode 100644 index 0000000..dd15857 --- /dev/null +++ b/traceloop-sdk/tracing.go @@ -0,0 +1,67 @@ +package traceloop + +import ( + "context" + "fmt" + + "go.opentelemetry.io/otel" + otlp "go.opentelemetry.io/otel/exporters/otlp/otlptrace" + otlpclient "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp" + stdoutexp "go.opentelemetry.io/otel/exporters/stdout/stdouttrace" + "go.opentelemetry.io/otel/sdk/resource" + "go.opentelemetry.io/otel/sdk/trace" + semconv "go.opentelemetry.io/otel/semconv/v1.17.0" +) + +func newOtlpExporter(ctx context.Context, endpoint string, apiKey string) (*otlp.Exporter, error) { + return otlp.New( + ctx, + otlpclient.NewClient( + otlpclient.WithEndpoint(endpoint), + otlpclient.WithHeaders(map[string]string{ + "Authorization": fmt.Sprintf("Bearer %s", apiKey), + }), + ), + ) +} + +func newStdoutExporter(ctx context.Context) (*stdoutexp.Exporter, error) { + return stdoutexp.New(stdoutexp.WithPrettyPrint()) +} + +func newTracerProvider(ctx context.Context, serviceName string, exp trace.SpanExporter) *trace.TracerProvider { + r, err := resource.New( + ctx, + resource.WithAttributes( + semconv.ServiceNameKey.String(serviceName), + ), + ) + + if err != nil { + panic(err) + } + + return trace.NewTracerProvider( + trace.WithBatcher(exp), + trace.WithResource(r), + ) +} + +func (instance *Traceloop) initTracer(ctx context.Context, serviceName string) error{ + fmt.Println("init tracer") + + // exp, err := newOtlpExporter(ctx, instance.config.BaseURL, instance.config.APIKey) + exp, err := newStdoutExporter(ctx) + if err != nil { + panic(err) + } + + tp := newTracerProvider(ctx, serviceName, exp) + defer func() { _ = tp.Shutdown(ctx) }() + + otel.SetTracerProvider(tp) + + instance.tracer = tp.Tracer(serviceName) + + return nil +} diff --git a/traceloop-sdk/utils.go b/traceloop-sdk/utils.go index 9da679b..62bf17e 100644 --- a/traceloop-sdk/utils.go +++ b/traceloop-sdk/utils.go @@ -19,12 +19,12 @@ func (instance *Traceloop) GetVersion() string { } func (instance *Traceloop) fetchPath(path string) (*http.Response, error) { - req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s/%s", instance.Config.BaseURL, path), nil) + req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("https://%s/%s", instance.config.BaseURL, path), nil) if err != nil { return nil, err } - req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", instance.Config.APIKey)) + req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", instance.config.APIKey)) req.Header.Set("X-Traceloop-SDK-Version", instance.GetVersion()) return instance.Client.Do(req) From a7107644905f361e90a7217c62d9d4066dcc8ed2 Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Sun, 21 Jan 2024 17:26:46 +0200 Subject: [PATCH 2/6] initial working prompt loging --- sample-app/main.go | 70 ++++++++++++++++++++++++-------- traceloop-sdk/dto/tracing.go | 14 +++++++ traceloop-sdk/prompt_registry.go | 16 ++++---- traceloop-sdk/sdk.go | 63 ++++++++++++++-------------- traceloop-sdk/tracing.go | 18 ++------ traceloop-sdk/utils.go | 4 ++ 6 files changed, 115 insertions(+), 70 deletions(-) diff --git a/sample-app/main.go b/sample-app/main.go index 7e4c2eb..5790a38 100644 --- a/sample-app/main.go +++ b/sample-app/main.go @@ -2,10 +2,14 @@ package main import ( "context" + "fmt" "os" + "time" + "github.com/sashabaranov/go-openai" sdk "github.com/traceloop/go-openllmetry/traceloop-sdk" "github.com/traceloop/go-openllmetry/traceloop-sdk/config" + "github.com/traceloop/go-openllmetry/traceloop-sdk/dto" ) func main() { @@ -15,28 +19,62 @@ func main() { BaseURL: "api-staging.traceloop.com", APIKey: os.Getenv("TRACELOOP_API_KEY"), }) + defer func() { traceloop.Shutdown(ctx) }() traceloop.Initialize(ctx) - // request, err := traceloop.GetOpenAIChatCompletionRequest("eval-test", map[string]interface{}{ "a": "workout" }) - // if err != nil { - // fmt.Printf("GetOpenAIChatCompletionRequest error: %v\n", err) - // return - // } + request, err := traceloop.GetOpenAIChatCompletionRequest("example-prompt", map[string]interface{}{ "date": time.Now().Format("01/02") }) + if err != nil { + fmt.Printf("GetOpenAIChatCompletionRequest error: %v\n", err) + return + } - // client := openai.NewClient(os.Getenv("OPENAI_API_KEY")) - // resp, err := client.CreateChatCompletion( - // context.Background(), - // *request, - // ) + client := openai.NewClient(os.Getenv("OPENAI_API_KEY")) + resp, err := client.CreateChatCompletion( + context.Background(), + *request, + ) - // if err != nil { - // fmt.Printf("ChatCompletion error: %v\n", err) - // return - // } + if err != nil { + fmt.Printf("ChatCompletion error: %v\n", err) + return + } - // fmt.Println(resp.Choices[0].Message.Content) + fmt.Println(resp.Choices[0].Message.Content) - traceloop.LogPrompt(ctx) + + log := dto.PromptLogAttributes{ + Prompt: dto.Prompt{ + Vendor: "openai", + Mode: "chat", + Model: request.Model, + }, + Completion: dto.Completion{ + Model: resp.Model, + }, + Usage: dto.Usage{ + TotalTokens: resp.Usage.TotalTokens, + CompletionTokens: resp.Usage.CompletionTokens, + PromptTokens: resp.Usage.PromptTokens, + }, + } + + for i, message := range request.Messages { + log.Prompt.Messages = append(log.Prompt.Messages, dto.Message{ + Index: i, + Content: message.Content, + Role: message.Role, + }) + } + + for _, choice := range resp.Choices { + log.Completion.Messages = append(log.Completion.Messages, dto.Message{ + Index: choice.Index, + Content: choice.Message.Content, + Role: choice.Message.Role, + }) + } + + traceloop.LogPrompt(ctx, log) } diff --git a/traceloop-sdk/dto/tracing.go b/traceloop-sdk/dto/tracing.go index f050529..948b0f4 100644 --- a/traceloop-sdk/dto/tracing.go +++ b/traceloop-sdk/dto/tracing.go @@ -28,3 +28,17 @@ type TraceloopAttributes struct { EntityName string `json:"entity_name"` AssociationProperties map[string]string `json:"association_properties"` } + +type Usage struct { + TotalTokens int `json:"total_tokens"` + CompletionTokens int `json:"completion_tokens"` + PromptTokens int `json:"prompt_tokens"` +} + +type PromptLogAttributes struct { + Prompt Prompt `json:"prompt"` + Completion Completion `json:"completion"` + Traceloop TraceloopAttributes `json:"traceloop"` + Usage Usage `json:"usage"` + Duration int `json:"duration"` +} diff --git a/traceloop-sdk/prompt_registry.go b/traceloop-sdk/prompt_registry.go index abe6093..3302358 100644 --- a/traceloop-sdk/prompt_registry.go +++ b/traceloop-sdk/prompt_registry.go @@ -37,16 +37,16 @@ func (instance *Traceloop) pollPrompts() { instance.populatePromptRegistry() -go func() { - defer close(prompts) - defer close(errs) + go func() { + defer close(prompts) + defer close(errs) - ticker := time.NewTicker(instance.config.PollingInterval) + ticker := time.NewTicker(instance.config.PollingInterval) - for range ticker.C { - instance.populatePromptRegistry() - } -}() + for range ticker.C { + instance.populatePromptRegistry() + } + }() } func (instance *Traceloop) getPromptVersion(key string) (*model.PromptVersion, error) { diff --git a/traceloop-sdk/sdk.go b/traceloop-sdk/sdk.go index 1e3820c..c0a5c83 100644 --- a/traceloop-sdk/sdk.go +++ b/traceloop-sdk/sdk.go @@ -8,7 +8,8 @@ import ( "time" "go.opentelemetry.io/otel/attribute" - "go.opentelemetry.io/otel/trace" + "go.opentelemetry.io/otel/sdk/trace" + apitrace "go.opentelemetry.io/otel/trace" semconvai "github.com/traceloop/go-openllmetry/semconv-ai" "github.com/traceloop/go-openllmetry/traceloop-sdk/config" @@ -21,7 +22,7 @@ const PromptsPath = "/v1/traceloop/prompts" type Traceloop struct { config config.Config promptRegistry model.PromptRegistry - tracer trace.Tracer + tracerProvider *trace.TracerProvider http.Client } @@ -54,26 +55,14 @@ func (instance *Traceloop) Initialize(ctx context.Context) { fmt.Printf("Traceloop %s SDK initialized. Connecting to %s\n", instance.GetVersion(), instance.config.BaseURL) - instance.initTracer(ctx, "GoExampleService") instance.pollPrompts() + instance.initTracer(ctx, "GoExampleService") } -func (instance *Traceloop) LogPrompt(ctx context.Context, prompt dto.Prompt, completion dto.Completion, traceloopAttrs dto.TraceloopAttributes) error { - spanName := fmt.Sprintf("%s.%s", prompt.Vendor, prompt.Mode) - _, span := instance.tracer.Start(ctx, spanName) - - span.SetAttributes( - semconvai.LLMVendor.String(prompt.Vendor), - semconvai.LLMRequestModel.String(prompt.Model), - semconvai.LLMRequestType.String(prompt.Mode), - semconvai.LLMResponseModel.String(completion.Model), - semconvai.TraceloopWorkflowName.String(traceloopAttrs.WorkflowName), - semconvai.TraceloopEntityName.String(traceloopAttrs.EntityName), - ) - - for _, message := range prompt.Messages { - attrsPrefix := fmt.Sprintf("llm.prompts.%d", message.Index) - span.SetAttributes( +func setMessagesAttribute(span *apitrace.Span, prefix string, messages []dto.Message) { + for _, message := range messages { + attrsPrefix := fmt.Sprintf("%s.%d", prefix, message.Index) + (*span).SetAttributes( attribute.KeyValue{ Key: attribute.Key(attrsPrefix + ".content"), Value: attribute.StringValue(message.Content), @@ -84,22 +73,32 @@ func (instance *Traceloop) LogPrompt(ctx context.Context, prompt dto.Prompt, com }, ) } +} - for _, message := range completion.Messages { - attrsPrefix := fmt.Sprintf("llm.completions.%d", message.Index) - span.SetAttributes( - attribute.KeyValue{ - Key: attribute.Key(attrsPrefix + ".content"), - Value: attribute.StringValue(message.Content), - }, - attribute.KeyValue{ - Key: attribute.Key(attrsPrefix + ".role"), - Value: attribute.StringValue(message.Role), - }, - ) - } +func (instance *Traceloop) LogPrompt(ctx context.Context, attrs dto.PromptLogAttributes) error { + spanName := fmt.Sprintf("%s.%s", attrs.Prompt.Vendor, attrs.Prompt.Mode) + _, span := (*instance.tracerProvider).Tracer(os.Args[0]).Start(ctx, spanName) + + span.SetAttributes( + semconvai.LLMVendor.String(attrs.Prompt.Vendor), + semconvai.LLMRequestModel.String(attrs.Prompt.Model), + semconvai.LLMRequestType.String(attrs.Prompt.Mode), + semconvai.LLMResponseModel.String(attrs.Completion.Model), + semconvai.LLMUsageTotalTokens.Int(attrs.Usage.TotalTokens), + semconvai.LLMUsageCompletionTokens.Int(attrs.Usage.CompletionTokens), + semconvai.LLMUsagePromptTokens.Int(attrs.Usage.PromptTokens), + semconvai.TraceloopWorkflowName.String(attrs.Traceloop.WorkflowName), + semconvai.TraceloopEntityName.String(attrs.Traceloop.EntityName), + ) + + setMessagesAttribute(&span, "llm.prompts", attrs.Prompt.Messages) + setMessagesAttribute(&span, "llm.completions", attrs.Completion.Messages) defer span.End() return nil } + +func (instance *Traceloop) Shutdown(ctx context.Context) { + instance.tracerProvider.Shutdown(ctx) +} diff --git a/traceloop-sdk/tracing.go b/traceloop-sdk/tracing.go index dd15857..eedf985 100644 --- a/traceloop-sdk/tracing.go +++ b/traceloop-sdk/tracing.go @@ -7,7 +7,6 @@ import ( "go.opentelemetry.io/otel" otlp "go.opentelemetry.io/otel/exporters/otlp/otlptrace" otlpclient "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp" - stdoutexp "go.opentelemetry.io/otel/exporters/stdout/stdouttrace" "go.opentelemetry.io/otel/sdk/resource" "go.opentelemetry.io/otel/sdk/trace" semconv "go.opentelemetry.io/otel/semconv/v1.17.0" @@ -25,10 +24,6 @@ func newOtlpExporter(ctx context.Context, endpoint string, apiKey string) (*otlp ) } -func newStdoutExporter(ctx context.Context) (*stdoutexp.Exporter, error) { - return stdoutexp.New(stdoutexp.WithPrettyPrint()) -} - func newTracerProvider(ctx context.Context, serviceName string, exp trace.SpanExporter) *trace.TracerProvider { r, err := resource.New( ctx, @@ -47,21 +42,16 @@ func newTracerProvider(ctx context.Context, serviceName string, exp trace.SpanEx ) } -func (instance *Traceloop) initTracer(ctx context.Context, serviceName string) error{ - fmt.Println("init tracer") - - // exp, err := newOtlpExporter(ctx, instance.config.BaseURL, instance.config.APIKey) - exp, err := newStdoutExporter(ctx) +func (instance *Traceloop) initTracer(ctx context.Context, serviceName string) error { + exp, err := newOtlpExporter(ctx, instance.config.BaseURL, instance.config.APIKey) if err != nil { panic(err) } tp := newTracerProvider(ctx, serviceName, exp) - defer func() { _ = tp.Shutdown(ctx) }() - otel.SetTracerProvider(tp) - instance.tracer = tp.Tracer(serviceName) - + instance.tracerProvider = tp + return nil } diff --git a/traceloop-sdk/utils.go b/traceloop-sdk/utils.go index 62bf17e..cf4dd02 100644 --- a/traceloop-sdk/utils.go +++ b/traceloop-sdk/utils.go @@ -21,6 +21,7 @@ func (instance *Traceloop) GetVersion() string { func (instance *Traceloop) fetchPath(path string) (*http.Response, error) { req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("https://%s/%s", instance.config.BaseURL, path), nil) if err != nil { + fmt.Printf("Failed to create request: %v\n", err) return nil, err } @@ -36,6 +37,9 @@ func (instance *Traceloop) fetchPathWithRetry(path string, maxRetries uint64) (* err := backoff.Retry(func() error { var err error resp, err = instance.fetchPath(path) + if err != nil { + fmt.Printf("Failed to fetch path: %v\n", err) + } return err }, backoff.WithMaxRetries(backoff.NewExponentialBackOff(), maxRetries)) From d63d166318355f77af4804e44d88dfe7239fd04e Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Sun, 21 Jan 2024 19:47:22 +0200 Subject: [PATCH 3/6] more descriptive error --- traceloop-sdk/prompt_registry.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/traceloop-sdk/prompt_registry.go b/traceloop-sdk/prompt_registry.go index 3302358..3d2b66e 100644 --- a/traceloop-sdk/prompt_registry.go +++ b/traceloop-sdk/prompt_registry.go @@ -23,7 +23,7 @@ func (instance *Traceloop) populatePromptRegistry() { var response dto.PromptsResponse err = decoder.Decode(&response) if err != nil { - fmt.Println(err) + fmt.Println("Failed to decode response", err) } for _, prompt := range response.Prompts { From 4386e27c353ff7722ee7c6e92e29f2d8bf1ca6d4 Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Sun, 21 Jan 2024 19:53:50 +0200 Subject: [PATCH 4/6] try to fix ci --- .github/workflows/ci.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 115dbe5..f982bf8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - go-version: ["1.18", "1.19", "1.20", "1.21.x"] + go-version: ["1.18", "1.19", "1.20", "1.21"] steps: - uses: actions/checkout@v4 @@ -20,8 +20,8 @@ jobs: with: go-version: ${{ matrix.go-version }} - name: Install dependencies - run: go get . + run: find . -name go.mod -execdir go get . \; - name: Build - run: go build -v ./... + run: find . -name go.mod -execdir go build . \; - name: Test - run: go test + run: find . -name go.mod -execdir go test ./... \; From 8763754e58948c7fca1b2b2614c613512d78a515 Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Sun, 21 Jan 2024 19:54:54 +0200 Subject: [PATCH 5/6] fix go version --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 67c5fab..95f57ee 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ module github.com/traceloop/go-openllmetry -go 1.21.4 +go 1.21 From 584aebf9482d6e2ec734559f04a29eeb691233f2 Mon Sep 17 00:00:00 2001 From: Gal Kleinman Date: Sun, 21 Jan 2024 19:58:24 +0200 Subject: [PATCH 6/6] trigger ci