From dae8a00f0c1a4fd3fded1f24a16c8bdc5cddb4e8 Mon Sep 17 00:00:00 2001 From: VAL Date: Tue, 15 Feb 2022 10:43:49 -0800 Subject: [PATCH] Typo and clarity fixes (#14081) --- command/base_helpers.go | 4 ++-- command/kv_delete.go | 4 ++-- command/kv_destroy.go | 2 +- command/kv_get.go | 2 +- command/kv_helpers.go | 2 +- command/kv_list.go | 2 +- command/kv_metadata_delete.go | 2 +- command/kv_metadata_get.go | 2 +- command/kv_metadata_patch.go | 2 +- command/kv_metadata_put.go | 2 +- command/kv_patch.go | 2 +- command/kv_put.go | 2 +- command/kv_rollback.go | 2 +- command/kv_undelete.go | 2 +- vault/logical_system.go | 2 +- website/content/docs/internals/telemetry.mdx | 2 +- 16 files changed, 18 insertions(+), 18 deletions(-) diff --git a/command/base_helpers.go b/command/base_helpers.go index 6de31ec02e..f20cfebf71 100644 --- a/command/base_helpers.go +++ b/command/base_helpers.go @@ -51,7 +51,7 @@ func ensureTrailingSlash(s string) string { return s } -// ensureNoTrailingSlash ensures the given string has a trailing slash. +// ensureNoTrailingSlash ensures the given string does not have a trailing slash. func ensureNoTrailingSlash(s string) string { s = strings.TrimSpace(s) if s == "" { @@ -64,7 +64,7 @@ func ensureNoTrailingSlash(s string) string { return s } -// ensureNoLeadingSlash ensures the given string has a trailing slash. +// ensureNoLeadingSlash ensures the given string does not have a leading slash. func ensureNoLeadingSlash(s string) string { s = strings.TrimSpace(s) if s == "" { diff --git a/command/kv_delete.go b/command/kv_delete.go index 73583d171d..59e558fbf5 100644 --- a/command/kv_delete.go +++ b/command/kv_delete.go @@ -138,7 +138,7 @@ func (c *KVDeleteCommand) deleteV2(path, mountPath string, client *api.Client) ( var secret *api.Secret switch { case len(c.flagVersions) > 0: - path = addPrefixToVKVPath(path, mountPath, "delete") + path = addPrefixToKVPath(path, mountPath, "delete") if err != nil { return nil, err } @@ -150,7 +150,7 @@ func (c *KVDeleteCommand) deleteV2(path, mountPath string, client *api.Client) ( secret, err = client.Logical().Write(path, data) default: - path = addPrefixToVKVPath(path, mountPath, "data") + path = addPrefixToKVPath(path, mountPath, "data") if err != nil { return nil, err } diff --git a/command/kv_destroy.go b/command/kv_destroy.go index 6902460787..53a1416a78 100644 --- a/command/kv_destroy.go +++ b/command/kv_destroy.go @@ -104,7 +104,7 @@ func (c *KVDestroyCommand) Run(args []string) int { c.UI.Error("Destroy not supported on KV Version 1") return 1 } - path = addPrefixToVKVPath(path, mountPath, "destroy") + path = addPrefixToKVPath(path, mountPath, "destroy") if err != nil { c.UI.Error(err.Error()) return 2 diff --git a/command/kv_get.go b/command/kv_get.go index e0a519c5d1..3a7130626e 100644 --- a/command/kv_get.go +++ b/command/kv_get.go @@ -102,7 +102,7 @@ func (c *KVGetCommand) Run(args []string) int { var versionParam map[string]string if v2 { - path = addPrefixToVKVPath(path, mountPath, "data") + path = addPrefixToKVPath(path, mountPath, "data") if c.flagVersion > 0 { versionParam = map[string]string{ diff --git a/command/kv_helpers.go b/command/kv_helpers.go index d60acaa56e..1442be6ed7 100644 --- a/command/kv_helpers.go +++ b/command/kv_helpers.go @@ -105,7 +105,7 @@ func isKVv2(path string, client *api.Client) (string, bool, error) { return mountPath, version == 2, nil } -func addPrefixToVKVPath(p, mountPath, apiPrefix string) string { +func addPrefixToKVPath(p, mountPath, apiPrefix string) string { if p == mountPath || p == strings.TrimSuffix(mountPath, "/") { return path.Join(mountPath, apiPrefix) } diff --git a/command/kv_list.go b/command/kv_list.go index 4a066952a2..b6b665c6f5 100644 --- a/command/kv_list.go +++ b/command/kv_list.go @@ -90,7 +90,7 @@ func (c *KVListCommand) Run(args []string) int { } if v2 { - path = addPrefixToVKVPath(path, mountPath, "metadata") + path = addPrefixToKVPath(path, mountPath, "metadata") if err != nil { c.UI.Error(err.Error()) return 2 diff --git a/command/kv_metadata_delete.go b/command/kv_metadata_delete.go index 03eb70d126..3b9509a2df 100644 --- a/command/kv_metadata_delete.go +++ b/command/kv_metadata_delete.go @@ -83,7 +83,7 @@ func (c *KVMetadataDeleteCommand) Run(args []string) int { return 1 } - path = addPrefixToVKVPath(path, mountPath, "metadata") + path = addPrefixToKVPath(path, mountPath, "metadata") if secret, err := client.Logical().Delete(path); err != nil { c.UI.Error(fmt.Sprintf("Error deleting %s: %s", path, err)) if secret != nil { diff --git a/command/kv_metadata_get.go b/command/kv_metadata_get.go index f5be942c36..c37e0db653 100644 --- a/command/kv_metadata_get.go +++ b/command/kv_metadata_get.go @@ -87,7 +87,7 @@ func (c *KVMetadataGetCommand) Run(args []string) int { return 1 } - path = addPrefixToVKVPath(path, mountPath, "metadata") + path = addPrefixToKVPath(path, mountPath, "metadata") secret, err := client.Logical().Read(path) if err != nil { c.UI.Error(fmt.Sprintf("Error reading %s: %s", path, err)) diff --git a/command/kv_metadata_patch.go b/command/kv_metadata_patch.go index 83ec3d45d5..c2a0956e14 100644 --- a/command/kv_metadata_patch.go +++ b/command/kv_metadata_patch.go @@ -151,7 +151,7 @@ func (c *KVMetadataPatchCommand) Run(args []string) int { return 1 } - path = addPrefixToVKVPath(path, mountPath, "metadata") + path = addPrefixToKVPath(path, mountPath, "metadata") data := map[string]interface{}{} diff --git a/command/kv_metadata_put.go b/command/kv_metadata_put.go index 5b9537ad56..67a951731f 100644 --- a/command/kv_metadata_put.go +++ b/command/kv_metadata_put.go @@ -149,7 +149,7 @@ func (c *KVMetadataPutCommand) Run(args []string) int { return 1 } - path = addPrefixToVKVPath(path, mountPath, "metadata") + path = addPrefixToKVPath(path, mountPath, "metadata") data := map[string]interface{}{} if c.flagMaxVersions >= 0 { diff --git a/command/kv_patch.go b/command/kv_patch.go index b241cb9b50..7b54fb64fd 100644 --- a/command/kv_patch.go +++ b/command/kv_patch.go @@ -159,7 +159,7 @@ func (c *KVPatchCommand) Run(args []string) int { return 2 } - path = addPrefixToVKVPath(path, mountPath, "data") + path = addPrefixToKVPath(path, mountPath, "data") if err != nil { c.UI.Error(err.Error()) return 2 diff --git a/command/kv_put.go b/command/kv_put.go index a33b67f86f..90349f6f34 100644 --- a/command/kv_put.go +++ b/command/kv_put.go @@ -130,7 +130,7 @@ func (c *KVPutCommand) Run(args []string) int { } if v2 { - path = addPrefixToVKVPath(path, mountPath, "data") + path = addPrefixToKVPath(path, mountPath, "data") data = map[string]interface{}{ "data": data, "options": map[string]interface{}{}, diff --git a/command/kv_rollback.go b/command/kv_rollback.go index 6a34028641..c9f3eb3621 100644 --- a/command/kv_rollback.go +++ b/command/kv_rollback.go @@ -115,7 +115,7 @@ func (c *KVRollbackCommand) Run(args []string) int { return 2 } - path = addPrefixToVKVPath(path, mountPath, "data") + path = addPrefixToKVPath(path, mountPath, "data") if err != nil { c.UI.Error(err.Error()) return 2 diff --git a/command/kv_undelete.go b/command/kv_undelete.go index 5c86d5df47..b734ff876a 100644 --- a/command/kv_undelete.go +++ b/command/kv_undelete.go @@ -104,7 +104,7 @@ func (c *KVUndeleteCommand) Run(args []string) int { return 1 } - path = addPrefixToVKVPath(path, mountPath, "undelete") + path = addPrefixToKVPath(path, mountPath, "undelete") data := map[string]interface{}{ "versions": kvParseVersionsFlags(c.flagVersions), } diff --git a/vault/logical_system.go b/vault/logical_system.go index 6d853dee44..8c07e6fdd1 100644 --- a/vault/logical_system.go +++ b/vault/logical_system.go @@ -4298,7 +4298,7 @@ func checkListingVisibility(visibility ListingVisibilityType) error { case ListingVisibilityHidden: case ListingVisibilityUnauth: default: - return fmt.Errorf("invalid listing visilibity type") + return fmt.Errorf("invalid listing visibility type") } return nil diff --git a/website/content/docs/internals/telemetry.mdx b/website/content/docs/internals/telemetry.mdx index a0061af62c..db9455e84b 100644 --- a/website/content/docs/internals/telemetry.mdx +++ b/website/content/docs/internals/telemetry.mdx @@ -89,7 +89,7 @@ These metrics represent operational aspects of the running Vault instance. | `vault.core.activity.segment_write` | Duration of time taken writing activity log segments to storage. | ms | summary | | `vault.core.check_token` | Duration of time taken by token checks handled by Vault core | ms | summary | | `vault.core.fetch_acl_and_token` | Duration of time taken by ACL and corresponding token entry fetches handled by Vault core | ms | summary | -| `vault.core.handle_request` | Duration of time taken by requests handled by Vault core | ms | summary | +| `vault.core.handle_request` | Duration of time taken by non-login requests handled by Vault core | ms | summary | | `vault.core.handle_login_request` | Duration of time taken by login requests handled by Vault core | ms | summary | | `vault.core.in_flight_requests` | Number of in-flight requests. | requests | gauge | | `vault.core.leadership_setup_failed` | Duration of time taken by cluster leadership setup failures which have occurred in a highly available Vault cluster. This should be monitored and alerted on for overall cluster leadership status. | ms | summary |