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

feat(server): support event properties header #3179

Merged
merged 2 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions server/analytics/analytics.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package analytics

import (
"encoding/json"
"fmt"
"os"
)
Expand Down Expand Up @@ -67,3 +68,21 @@ func SendEvent(name, category, clientID string, data *map[string]string) error {

return err
}

func InjectProperties(data map[string]string, properties string) map[string]string {
if properties == "" {
return data
}

var p map[string]string
err := json.Unmarshal([]byte(properties), &p)
if err != nil {
return data
}

for k, v := range p {
data[k] = v
}

return data
}
10 changes: 7 additions & 3 deletions server/app/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -368,11 +368,15 @@ func analyticsMW(next http.Handler) http.Handler {
routeName := mux.CurrentRoute(r).GetName()
machineID := r.Header.Get("x-client-id")
source := r.Header.Get("x-source")
eventProperties := r.Header.Get("x-event-properties")

eventData := map[string]string{
"source": source,
}
eventData = analytics.InjectProperties(eventData, eventProperties)

if routeName != "" {
analytics.SendEvent(toWords(routeName), "test", machineID, &map[string]string{
"source": source,
})
analytics.SendEvent(toWords(routeName), "test", machineID, &eventData)
}

next.ServeHTTP(w, r)
Expand Down
3 changes: 3 additions & 0 deletions server/executor/assertion_runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"github.com/kubeshop/tracetest/server/analytics"
"github.com/kubeshop/tracetest/server/expression"
"github.com/kubeshop/tracetest/server/http/middleware"
"github.com/kubeshop/tracetest/server/model/events"
"github.com/kubeshop/tracetest/server/pkg/maps"
"github.com/kubeshop/tracetest/server/pkg/pipeline"
Expand Down Expand Up @@ -80,6 +81,7 @@ func (e *defaultAssertionRunner) runAssertionsAndUpdateResult(ctx context.Contex
run = run.AssertionFailed(err)
analytics.SendEvent("test_run_finished", "error", "", &map[string]string{
"finalState": string(run.State),
"tenant_id": middleware.TenantIDFromContext(ctx),
})

return test.Run{}, e.updater.Update(ctx, run)
Expand Down Expand Up @@ -139,6 +141,7 @@ func (e *defaultAssertionRunner) executeAssertions(ctx context.Context, req Job)

analytics.SendEvent("test_run_finished", "successful", "", &map[string]string{
"finalState": string(run.State),
"tenant_id": middleware.TenantIDFromContext(ctx),
})

return run, nil
Expand Down
2 changes: 2 additions & 0 deletions server/executor/linter_runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"log"

"github.com/kubeshop/tracetest/server/analytics"
"github.com/kubeshop/tracetest/server/http/middleware"
"github.com/kubeshop/tracetest/server/linter"
"github.com/kubeshop/tracetest/server/linter/analyzer"
"github.com/kubeshop/tracetest/server/model/events"
Expand Down Expand Up @@ -131,6 +132,7 @@ func (e *defaultLinterRunner) onError(ctx context.Context, job Job, run test.Run

analytics.SendEvent("test_run_finished", "error", "", &map[string]string{
"finalState": string(run.State),
"tenant_id": middleware.TenantIDFromContext(ctx),
})

run = run.LinterError(err)
Expand Down
2 changes: 2 additions & 0 deletions server/executor/trace_poller.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"github.com/kubeshop/tracetest/server/analytics"
"github.com/kubeshop/tracetest/server/executor/pollingprofile"
"github.com/kubeshop/tracetest/server/http/middleware"
"github.com/kubeshop/tracetest/server/model/events"
"github.com/kubeshop/tracetest/server/pkg/pipeline"
"github.com/kubeshop/tracetest/server/subscription"
Expand Down Expand Up @@ -204,6 +205,7 @@ func (tp tracePoller) handleTraceDBError(ctx context.Context, job Job, err error
run = run.TraceFailed(err)
analytics.SendEvent("test_run_finished", "error", "", &map[string]string{
"finalState": string(run.State),
"tenant_id": middleware.TenantIDFromContext(ctx),
})

tp.handleDBError(tp.updater.Update(ctx, run))
Expand Down
2 changes: 2 additions & 0 deletions server/executor/tracepollerworker/evaluator_worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/kubeshop/tracetest/server/analytics"
"github.com/kubeshop/tracetest/server/datastore"
"github.com/kubeshop/tracetest/server/executor"
"github.com/kubeshop/tracetest/server/http/middleware"
"github.com/kubeshop/tracetest/server/model/events"
"github.com/kubeshop/tracetest/server/pkg/pipeline"
"github.com/kubeshop/tracetest/server/resourcemanager"
Expand Down Expand Up @@ -98,6 +99,7 @@ func (w *tracePollerEvaluatorWorker) ProcessItem(ctx context.Context, job execut
run := job.Run.TraceFailed(err)
analytics.SendEvent("test_run_finished", "error", "", &map[string]string{
"finalState": string(run.State),
"tenant_id": middleware.TenantIDFromContext(ctx),
})

handleDBError(w.state.updater.Update(ctx, run))
Expand Down
6 changes: 4 additions & 2 deletions server/executor/trigger_result_processor_worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"

"github.com/kubeshop/tracetest/server/analytics"
"github.com/kubeshop/tracetest/server/http/middleware"
"github.com/kubeshop/tracetest/server/model"
"github.com/kubeshop/tracetest/server/model/events"
"github.com/kubeshop/tracetest/server/pkg/pipeline"
Expand Down Expand Up @@ -61,7 +62,7 @@ func (r triggerResultProcessorWorker) ProcessItem(ctx context.Context, job Job)
ctx, pollingSpan := r.tracer.Start(ctx, "Start processing trigger response")
defer pollingSpan.End()

job.Run = r.handleExecutionResult(job.Run)
job.Run = r.handleExecutionResult(job.Run, ctx)
triggerResult := job.Run.TriggerResult
if triggerResult.Error != nil {
err := triggerResult.Error.Error()
Expand Down Expand Up @@ -120,13 +121,14 @@ func (r triggerResultProcessorWorker) emitMismatchEndpointEvent(ctx context.Cont
}
}

func (r triggerResultProcessorWorker) handleExecutionResult(run test.Run) test.Run {
func (r triggerResultProcessorWorker) handleExecutionResult(run test.Run, ctx context.Context) test.Run {
run = run.TriggerCompleted(run.TriggerResult)
if run.TriggerResult.Error != nil {
run = run.TriggerFailed(fmt.Errorf(run.TriggerResult.Error.ErrorMessage))

analytics.SendEvent("test_run_finished", "error", "", &map[string]string{
"finalState": string(run.State),
"tenant_id": middleware.TenantIDFromContext(ctx),
})

return run
Expand Down