base types for events package

go.mod

@@ -22,6 +22,7 @@ require (
 	github.com/hashicorp/cap v0.0.0-20210518163718-e72205e8eaae
 	github.com/hashicorp/dbassert v0.0.0-20200930125617-6218396928df
 	github.com/hashicorp/errwrap v1.1.0
+	github.com/hashicorp/eventlogger v0.0.0-20210523164657-c216620e1746
 	github.com/hashicorp/go-bexpr v0.1.7
 	github.com/hashicorp/go-cleanhttp v0.5.2
 	github.com/hashicorp/go-hclog v0.16.1

go.sum

@@ -311,8 +311,9 @@ github.com/go-sql-driver/mysql v1.5.0 h1:ozyZYNQW3x3HtqT1jira07DN2PArx2v7/mN66gG
 github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/go-test/deep v1.0.2-0.20181118220953-042da051cf31/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
-github.com/go-test/deep v1.0.2 h1:onZX1rnHT3Wv6cqNgYyFOOlgVKJrksuCMCRvJStbMYw=
 github.com/go-test/deep v1.0.2/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
+github.com/go-test/deep v1.0.4 h1:u2CU3YKy9I2pmu9pX0eq50wCgjfGIt539SqR7FbHiho=
+github.com/go-test/deep v1.0.4/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
 github.com/gobuffalo/here v0.6.0/go.mod h1:wAG085dHOYqUpf+Ap+WOdrPTp5IYcDAs/x7PLa8Y5fM=
 github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee h1:s+21KNqlpePfkah2I+gwHF8xmJWRjooY+5248k6m4A0=
 github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee/go.mod h1:L0fX3K22YWvt/FAX9NnzrNzcI4wNYi9Yku4O0LKYflo=
@@ -449,6 +450,8 @@ github.com/hashicorp/dbassert v0.0.0-20200930125617-6218396928df/go.mod h1:+B5eZ
 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=
+github.com/hashicorp/eventlogger v0.0.0-20210523164657-c216620e1746 h1:uFLAYWBCufq4idhqjltAWb4s2JuJt1oE1hDRixwWqwY=
+github.com/hashicorp/eventlogger v0.0.0-20210523164657-c216620e1746/go.mod h1:LG0lqGlYKC9FD5m5Umh7FW8SeJlciNUZv400J4+j094=
 github.com/hashicorp/go-bexpr v0.1.7 h1:z48qzCgJkvdnMO/LDy3XHNyCyxnHiFGx9uTKLv0jW2Y=
 github.com/hashicorp/go-bexpr v0.1.7/go.mod h1:oxlubA2vC/gFVfX1A6JGp7ls7uCDlfJn732ehYYg+g0=
 github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
@@ -984,6 +987,8 @@ go.uber.org/atomic v1.5.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
 go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
 go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
 go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
+go.uber.org/goleak v1.0.0 h1:qsup4IcBdlmsnGfqyLl4Ntn3C2XCCuKAE7DwHpScyUo=
+go.uber.org/goleak v1.0.0/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A=
 go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
 go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU=
@@ -1232,6 +1237,7 @@ golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtn
 golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.0.0-20191108193012-7d206e10da11/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20191112195655-aa38f8e97acc/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20191113191852-77e3bb0ad9e7/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20191115202509-3a792d9c32b2/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=

internal/observability/events/context.go

@@ -0,0 +1,231 @@
+package event
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/boundary/internal/errors"
+	"github.com/hashicorp/go-hclog"
+)
+
+type key int
+
+const (
+	eventerKey key = iota
+	requestInfoKey
+)
+
+// NewEventerContext will return a context containing a value of the provided Eventer
+func NewEventerContext(ctx context.Context, eventer *Eventer) (context.Context, error) {
+	const op = "event.NewEventerContext"
+	if ctx == nil {
+		return nil, errors.New(errors.InvalidParameter, op, "missing context")
+	}
+	if eventer == nil {
+		return nil, errors.New(errors.InvalidParameter, op, "missing eventer")
+	}
+	return context.WithValue(ctx, eventerKey, eventer), nil
+}
+
+// EventerFromContext attempts to get the eventer value from the context provided
+func EventerFromContext(ctx context.Context) (*Eventer, bool) {
+	if ctx == nil {
+		return nil, false
+	}
+	eventer, ok := ctx.Value(eventerKey).(*Eventer)
+	return eventer, ok
+}
+
+// NewRequestInfoContext will return a context containing a value for the
+// provided RequestInfo
+func NewRequestInfoContext(ctx context.Context, info *RequestInfo) (context.Context, error) {
+	const op = "event.NewRequestInfoContext"
+	if ctx == nil {
+		return nil, errors.New(errors.InvalidParameter, op, "missing context")
+	}
+	if info == nil {
+		return nil, errors.New(errors.InvalidParameter, op, "missing request info")
+	}
+	if info.Id == "" {
+		return nil, errors.New(errors.InvalidParameter, op, "missing request info id")
+	}
+	return context.WithValue(ctx, requestInfoKey, info), nil
+}
+
+// RequestInfoFromContext attempts to get the RequestInfo value from the context
+// provided
+func RequestInfoFromContext(ctx context.Context) (*RequestInfo, bool) {
+	if ctx == nil {
+		return nil, false
+	}
+	reqInfo, ok := ctx.Value(requestInfoKey).(*RequestInfo)
+	return reqInfo, ok
+}
+
+// WriteObservation will write an observation event.  It will first check the
+// ctx for an eventer, then try event.SysEventer() and if no eventer can be
+// found an error is returned.
+//
+// At least one and any combination of the supported options may be used:
+// WithHeader, WithDetails, WithId, WithFlush and WithRequestInfo. All other
+// options are ignored.
+func WriteObservation(ctx context.Context, caller Op, opt ...Option) error {
+	const op = "event.WriteObservation"
+	if ctx == nil {
+		return errors.New(errors.InvalidParameter, op, "missing context")
+	}
+	if caller == "" {
+		return errors.New(errors.InvalidParameter, op, "missing operation")
+	}
+	eventer, ok := EventerFromContext(ctx)
+	if !ok {
+		eventer = SysEventer()
+		if eventer == nil {
+			return errors.New(errors.InvalidParameter, op, "missing both context and system eventer")
+		}
+	}
+	opts := getOpts(opt...)
+	if opts.withDetails == nil && opts.withHeader == nil && !opts.withFlush {
+		return errors.New(errors.InvalidParameter, op, "you must specify either header or details options for an event payload")
+	}
+	if opts.withRequestInfo == nil {
+		var err error
+		if opt, err = addCtxOptions(ctx, opt...); err != nil {
+			return errors.Wrap(err, op)
+		}
+	}
+	e, err := newObservation(caller, opt...)
+	if err != nil {
+		return errors.Wrap(err, op)
+	}
+	if err := eventer.writeObservation(ctx, e); err != nil {
+		return errors.Wrap(err, op)
+	}
+	return nil
+}
+
+// WriteError will write an error event.  It will first check the
+// ctx for an eventer, then try event.SysEventer() and if no eventer can be
+// found an hclog.Logger will be created and used.
+//
+// The options WithId and WithRequestInfo are supported and all other options
+// are ignored.
+func WriteError(ctx context.Context, caller Op, e error, opt ...Option) {
+	const op = "event.WriteError"
+	// EventerFromContext will handle a nil ctx appropriately. If e or caller is
+	// missing, newError(...) will handle them appropriately.
+	eventer, ok := EventerFromContext(ctx)
+	if !ok {
+		eventer = SysEventer()
+		if eventer == nil {
+			logger := hclog.New(nil)
+			logger.Error(fmt.Sprintf("%s: no eventer available to write error: %s", op, e))
+			return
+		}
+	}
+	opts := getOpts(opt...)
+	if opts.withRequestInfo == nil {
+		var err error
+		if opt, err = addCtxOptions(ctx, opt...); err != nil {
+			eventer.logger.Error(errors.Wrap(err, op).Error())
+			eventer.logger.Error(fmt.Sprintf("%s: unable to process context options to write error: %s", op, e))
+			return
+		}
+	}
+	ev, err := newError(caller, e, opt...)
+	if err != nil {
+		eventer.logger.Error(errors.Wrap(err, op).Error())
+		eventer.logger.Error(fmt.Sprintf("%s: unable to create new error to write error: %s", op, e))
+		return
+	}
+	if err := eventer.writeError(ctx, ev); err != nil {
+		eventer.logger.Error(errors.Wrap(err, op).Error())
+		eventer.logger.Error(fmt.Sprintf("%s: unable to write error: %s", op, e))
+		return
+	}
+}
+
+// WriteAudit will write an audit event.  It will first check the ctx for an
+// eventer, then try event.SysEventer() and if no eventer can be found an error
+// is returned.
+//
+// At least one and any combination of the supported options may be used:
+// WithRequest, WithResponse, WithAuth, WithId, WithFlush and WithRequestInfo.
+// All other options are ignored.
+func WriteAudit(ctx context.Context, caller Op, opt ...Option) error {
+	const op = "event.WriteAudit"
+	if ctx == nil {
+		return errors.New(errors.InvalidParameter, op, "missing context")
+	}
+	if caller == "" {
+		return errors.New(errors.InvalidParameter, op, "missing operation")
+	}
+	eventer, ok := EventerFromContext(ctx)
+	if !ok {
+		eventer = SysEventer()
+		if eventer == nil {
+			return errors.New(errors.InvalidParameter, op, "missing both context and system eventer")
+		}
+	}
+	opts := getOpts(opt...)
+	if opts.withRequestInfo == nil {
+		var err error
+		if opt, err = addCtxOptions(ctx, opt...); err != nil {
+			return errors.Wrap(err, op)
+		}
+	}
+	e, err := newAudit(caller, opt...)
+	if err != nil {
+		return errors.Wrap(err, op)
+	}
+	if err := eventer.writeAudit(ctx, e); err != nil {
+		return errors.Wrap(err, op)
+	}
+	return nil
+}
+
+func addCtxOptions(ctx context.Context, opt ...Option) ([]Option, error) {
+	const op = "event.addCtxOptions"
+	opts := getOpts(opt...)
+	retOpts := make([]Option, 0, len(opt))
+	retOpts = append(retOpts, opt...)
+	if opts.withRequestInfo == nil {
+		reqInfo, ok := RequestInfoFromContext(ctx)
+		if !ok {
+			// there's no RequestInfo, so there's no id associated with the
+			// observation and we'll generate one and flush the observation
+			// since there will never be another with the same id
+			id, err := newId(string(ObservationType))
+			if err != nil {
+				return nil, errors.Wrap(err, op)
+			}
+			retOpts = append(retOpts, WithId(id))
+			if !opts.withFlush {
+				retOpts = append(retOpts, WithFlush())
+			}
+			return retOpts, nil
+		}
+		retOpts = append(retOpts, WithRequestInfo(reqInfo))
+		if reqInfo.Id != "" {
+			retOpts = append(retOpts, WithId(reqInfo.Id))
+		}
+		switch reqInfo.Id {
+		case "":
+			// there's no RequestInfo.Id associated with the observation, so we'll
+			// generate one and flush the observation since there will never be
+			// another with the same id
+			id, err := newId(string(ObservationType))
+			if err != nil {
+				return nil, errors.Wrap(err, op)
+			}
+			retOpts = append(retOpts, WithId(id))
+			if !opts.withFlush {
+				retOpts = append(retOpts, WithFlush())
+			}
+			return retOpts, nil
+		default:
+			retOpts = append(retOpts, WithId(reqInfo.Id))
+		}
+	}
+	return retOpts, nil
+}