Function ToLogKey

base/log_keys.go:198–228

ToLogKey takes a slice of case-sensitive log key names and will return a LogKeyMask bitfield and a slice of deferred log functions for any warnings that may occur.

(ctx context.Context, keysStr []string)

// ToLogKey takes a slice of case-sensitive log key names and will return a LogKeyMask bitfield
// and a slice of deferred log functions for any warnings that may occur.
func ToLogKey(ctx context.Context, keysStr []string) (logKeys LogKeyMask) {

	for _, key := range keysStr {
		// Take a copy of key, so we can use it in a closure outside the scope
		// of this loop (the warnings returned are logged asyncronously)
		originalKey := key

		// Some old log keys (like HTTP+), we want to handle slightly (map to a different key)
		if newLogKeys, ok := convertSpecialLogKey(key); ok {
			for _, newLogKey := range newLogKeys {
				logKeys.Enable(newLogKey)
			}
			continue
		}

		// Strip a single "+" suffix in log keys and warn (for backwards compatibility)
		if strings.HasSuffix(key, "+") {
			newLogKey := strings.TrimSuffix(key, "+")
			WarnfCtx(ctx, "Deprecated log key: %q found. Changing to: %q.", originalKey, newLogKey)
			key = newLogKey
		}

		if logKey, ok := logKeyNamesInverse[key]; ok {
			logKeys.Enable(logKey)
		} else {
			WarnfCtx(ctx, "Invalid log key: %v", originalKey)
		}
	}

	return logKeys
}

func inverselogKeyNames(in [LogKeyCount]string) map[string]LogKey {
	var out = make(map[string]LogKey, len(in))