useragent

Documentation

Index

• func PluginString(env *logical.PluginEnvironment, pluginName string, comments ...string) string
• func String(comments ...string) string

Functions

func PluginString

func PluginString(env *logical.PluginEnvironment, pluginName string, comments ...string) string

PluginString is usable by plugins to return a user-agent string reflecting the running Vault version and an optional plugin name.

e.g. Vault/0.10.4 (+https://www.vaultproject.io/; azure-auth; go1.10.1)

Given comments will be appended to the semicolon-delimited comment section.

e.g. Vault/0.10.4 (+https://www.vaultproject.io/; azure-auth; go1.10.1; comment-0; comment-1)

Returns an empty string if the given env is nil.

func String

func String(comments ...string) string

String returns the consistent user-agent string for Vault.

e.g. Vault/0.10.4 (+https://www.vaultproject.io/; go1.10.1)

Given comments will be appended to the semicolon-delimited comment section.

e.g. Vault/0.10.4 (+https://www.vaultproject.io/; go1.10.1; comment-0; comment-1)