MG-234 - Improve Logging Middleware

[Musilah]

What type of PR is this?

This is an optimisation for Logging.

What does this do?

This improves Logging by updating the filtering and searchability through structured logs.

Which issue(s) does this PR fix/relate to?

• Related Issue MG-234 - Improve Logging #255

Have you included tests for your changes?

No.

Did you document any new/modified feature?

No.

Notes

N/A.

[dborovcanin]

Let's use Warn. The correct log level, however, can only be set properly by inspecting the error; we'll not do that in this PR.

[ianmuchyri]

Suggested change

	args = append(args, slog.String("error", err.Error()))
	args = append(args, slog.Any("error", err))

Do this for the rest. It returns a better error format

[rodneyosodo]

I have reviewed logging in ws, users, things, twins, readers, provision and messaging use that information to change the other services

Also have a look at this case

func (lm *loggingMiddleware) Cert(token, thingID, duration string) (cert, key string, err error) {
	defer func(begin time.Time) {
		args := []interface{}{
			slog.String("duration", time.Since(begin).String()),
			slog.String("thing_id", thingID),
			slog.String("duration", duration),
		}
		if err != nil {
			args = append(args, slog.String("error", err.Error()))
			lm.logger.Warn("Cert failed to complete successfully", args...)
			return
		}
		lm.logger.Info("Cert completed successfully", args...)
	}(time.Now())

	return lm.svc.Cert(token, thingID, duration)
}

This is found in provision. This logs is not informative or clear on what it does Cert completed successfully because the underlying function creates a certificate. Use go docs to infer what a function does and make the log statemes clear and concise as to what is happening

[rodneyosodo]

Some packages have not been updated for example consumers/writers/api/logging.go

[dborovcanin]

Use any instead of interface{}.

[dborovcanin]

Do the same for all the other cases.

[dborovcanin]

Let's flatten Policy by using a single Group here, like:

Suggested change

	slog.Group(
	"object",
	slog.String("type", pr.ObjectType),
	),
	slog.Group(
	"subject",
	slog.String("id", pr.Subject),
	slog.String("type", pr.SubjectType),
	slog.Group(
	"policy_request",
	slog.String("object_type", pr.ObjectType),
	slog.String("subject_id", pr.Subject),
	slog.String("subject_type", pr.SubjectType))

[dborovcanin]

We need to make this user ID, rather than the token. Let's open a ticket for this, it's out of the scope for this PR.