Function LogRequest

internal/logging/logging.go:93–139

LogRequest creates a logging message with the given parameters - log *logrus.Entry - level the message must have - reqType is the request type - Optional. params for self-created string messages to be appended to the created log message. The elements do not need a space at the beginning of the messa

(log *logrus.Entry, level logrus.Level, reqType RequestType, req api.PayloadRequest, params ...string)

//
//	"*orchestrator.AuditScope created with ID 'AuditScope1234' for Certification Target '00000000-0000-0000-0000-000000000000' and Catalog 'EUCS'."
func LogRequest(log *logrus.Entry, level logrus.Level, reqType RequestType, req api.PayloadRequest, params ...string) {
	var (
		buffer bytes.Buffer
	)

	// Check if inputs are available
	if log == nil || util.IsNil(req) {
		return
	}

	// Retrieve the payload from the request. The request itself is usually
	// a wrapper around the sent object.
	payload := req.GetPayload()
	if util.IsNil(payload) {
		return
	}

	// We can retrieve the name via the proto descriptor. This should be
	// sufficiently fast and also gives us the non-pointer type in comparison to
	// the %T printf directive.
	name := req.GetPayload().ProtoReflect().Descriptor().Name()

	// Check, if our payload has an ID field
	idreq, ok := payload.(interface{ GetId() string })
	if ok && idreq.GetId() != "" {
		buffer.WriteString(fmt.Sprintf("%s with ID '%s' %s", name, idreq.GetId(), reqType.String()))
	} else {
		buffer.WriteString(fmt.Sprintf("%s %s", name, reqType.String()))
	}

	// Check, if it is a certification target request. In this case we can append the
	// information about the target certification target. However, we only want to do
	// that, if the payload type is not a certification target itself.
	ctreq, ok := req.(api.CertificationTargetRequest)
	if name != "CertificationTarget" && ok {
		buffer.WriteString(fmt.Sprintf(" for Certification Target '%s'", ctreq.GetCertificationTargetId()))
	}

	// If params is not empty, the elements are joined and added to the message
	if len(params) > 0 {
		buffer.WriteString(" " + strings.Join(params, " "))
	}

	buffer.WriteString(".")

	log.Log(level, buffer.String())
}