Add initial code instrumentation with honeycomb

[vaijab]

Description

Changes proposed in this pull request:

• Add initial code instrumentation with honeycomb

Related issue(s)

[pkosiec]

overall it is OK, but please create a missing PR and test it E2E 👍 Thanks!

[pkosiec]

We cannot assume this will be unique in the whole Botkube Cloud. Probably there could be some duplication between orgs as we randomize just 4-5 chars AFAIR. Is it good enough for our use case?

[vaijab]

What would you suggest we change it to?

[pkosiec]

i just wanted to double check if that's OK - personally I think that should be good enough. If not, then we'd probably need to randomize it or use kube-system ns uid, like with telemetry 🤔

[vaijab]

service name property is used as a dataset name in honeycomb, so it's quite important I'd say. We don't want to have a gazillion datasets in honeycomb as that would be quite tricky to query. Maybe botkube-plugins-source-ai-brain?

[pkosiec]

Gotcha, so the goal is to group them all under a single static service name. Then yes, botkube-plugins-source-ai-brain or plugins-source-ai-brain sound good 👍

[mszostok]

Suggested change

	func (s *Source) HandleExternalRequest(ctx context.Context, in source.ExternalRequestInput) (source.ExternalRequestOutput, error) {
	func (s *Source) HandleExternalRequest(- context.Context, in source.ExternalRequestInput) (source.ExternalRequestOutput, error) {

[mszostok]

in order to make it work in all cases, you need to introduce named return param instead of var 👍

Suggested change

	func (i *assistant) handleThread(ctx context.Context, p *Payload) error {
	ctx, span := i.tracer.Start(ctx, "aibrain.assistant.handleThread")
	defer span.End()
	var thread openai.Thread
	var err error
	defer func() {
	if err != nil {
	span.RecordError(err)
	span.SetStatus(codes.Error, err.Error())
	}
	}()
	func (i *assistant) handleThread(ctx context.Context, p *Payload) (err error) {
	ctx, span := i.tracer.Start(ctx, "aibrain.assistant.handleThread")
	defer span.End()
	var thread openai.Thread
	defer func() {
	if err != nil {
	span.RecordError(err)
	span.SetStatus(codes.Error, err.Error())
	}
	}()

I double-checked that with this unit-test:

Details

func TestNamedParams(t *testing.T) {
	t.Log("here we will catch the error as it's assigned to the 'var err' before returning")
	_ = handleThread(t, false)
	t.Log("here we won't catch the error as it's directly returned")
	_ = handleThread(t, true)

	t.Log("named return params - this will work")
	_ = handleThreadV2(t, true)
}

func handleThread(t *testing.T, directFnReturn bool) error {
	var err error

	defer func() {
		if err != nil {
			t.Log("Error on defer:", err)
		}
	}()

	if !directFnReturn {
		err = errors.New("some error, directFnReturn = false")
		if err != nil {
			return fmt.Errorf("while creating a new message on a thread: %w", err)
		}
	}

	return returnError()
}

func handleThreadV2(t *testing.T, directFnReturn bool) (err error) {
	defer func() {
		if err != nil {
			t.Log("Error on defer:", err)
		}
	}()

	if !directFnReturn {
		err = errors.New("some error, directFnReturn = false")
		if err != nil {
			return fmt.Errorf("while creating a new message on a thread: %w", err)
		}
	}

	return returnError()
}

func returnError() error {
	return errors.New("some error, directFnReturn = true")
}