diff --git a/en/reference/vespa-cli/vespa.md b/en/reference/vespa-cli/vespa.md index 952667df61..4f955f7c58 100644 --- a/en/reference/vespa-cli/vespa.md +++ b/en/reference/vespa-cli/vespa.md @@ -52,6 +52,7 @@ vespa [flags] * [vespa document](vespa_document.html) - Issue a single document operation to Vespa * [vespa feed](vespa_feed.html) - Feed multiple document operations to Vespa * [vespa fetch](vespa_fetch.html) - Download a deployed application package +* [vespa inspect](vespa_inspect.html) - Provides insight * [vespa log](vespa_log.html) - Show the Vespa log * [vespa prepare](vespa_prepare.html) - Prepare an application package for activation * [vespa prod](vespa_prod.html) - Deploy an application package to production in Vespa Cloud diff --git a/en/reference/vespa-cli/vespa_inspect.md b/en/reference/vespa-cli/vespa_inspect.md new file mode 100644 index 0000000000..116f5d07a4 --- /dev/null +++ b/en/reference/vespa-cli/vespa_inspect.md @@ -0,0 +1,36 @@ +--- +title: vespa inspect +render_with_liquid: false +--- + +## vespa inspect + +Provides insight + +### Synopsis + +Provides subcommands to inspect various things in more detail + +### Options + +``` + -h, --help help for inspect +``` + +### Options inherited from parent commands + +``` + -a, --application string The application to use (cloud only). Format "tenant.application.instance" - instance is optional + -C, --cluster string The container cluster to use. This is only required for applications with multiple clusters + -c, --color string Whether to use colors in output. Must be "auto", "never", or "always" (default "auto") + -i, --instance string The instance of the application to use (cloud only) + -q, --quiet Print only errors + -t, --target string The target platform to use. Must be "local", "cloud", "hosted" or an URL (default "local") + -z, --zone string The zone to use. This defaults to a dev zone (cloud only) +``` + +### SEE ALSO + +* [vespa](vespa.html) - The command-line tool for Vespa.ai +* [vespa inspect profile](vespa_inspect_profile.html) - Inspect profiling results + diff --git a/en/reference/vespa-cli/vespa_inspect_profile.md b/en/reference/vespa-cli/vespa_inspect_profile.md new file mode 100644 index 0000000000..5556069fa7 --- /dev/null +++ b/en/reference/vespa-cli/vespa_inspect_profile.md @@ -0,0 +1,43 @@ +--- +title: vespa inspect profile +render_with_liquid: false +--- + +## vespa inspect profile + +Inspect profiling results + +### Synopsis + +Inspect profiling results previously obtained by vespa query --profile + +Note: this feature is experimental and currently under development +profiling results can also be analyzed with vespa-query-analyzer (part of vespa installation) + +``` +vespa inspect profile [flags] +``` + +### Options + +``` + -h, --help help for profile + -f, --profile-file string Name of the profile file to inspect (default "vespa_query_profile_result.json") +``` + +### Options inherited from parent commands + +``` + -a, --application string The application to use (cloud only). Format "tenant.application.instance" - instance is optional + -C, --cluster string The container cluster to use. This is only required for applications with multiple clusters + -c, --color string Whether to use colors in output. Must be "auto", "never", or "always" (default "auto") + -i, --instance string The instance of the application to use (cloud only) + -q, --quiet Print only errors + -t, --target string The target platform to use. Must be "local", "cloud", "hosted" or an URL (default "local") + -z, --zone string The zone to use. This defaults to a dev zone (cloud only) +``` + +### SEE ALSO + +* [vespa inspect](vespa_inspect.html) - Provides insight + diff --git a/en/reference/vespa-cli/vespa_query.md b/en/reference/vespa-cli/vespa_query.md index e94008a317..233fea5ca8 100644 --- a/en/reference/vespa-cli/vespa_query.md +++ b/en/reference/vespa-cli/vespa_query.md @@ -29,13 +29,15 @@ $ vespa query --header="X-First-Name: Joe" "yql=select * from music where album ### Options ``` - --file string Read query parameters from the given JSON file and send a POST request, with overrides from arguments - --format string Output format. Must be 'human' (human-readable) or 'plain' (no formatting) (default "human") - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for query - -T, --timeout int Timeout for the query in seconds (default 10) - -v, --verbose Print the equivalent curl command for the query - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + --file string Read query parameters from the given JSON file and send a POST request, with overrides from arguments + --format string Output format. Must be 'human' (human-readable) or 'plain' (no formatting) (default "human") + --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times + -h, --help help for query + --profile Enable profiling mode (Note: this feature is experimental) + --profile-file string Profiling result file (default "vespa_query_profile_result.json") + -T, --timeout int Timeout for the query in seconds (default 10) + -v, --verbose Print the equivalent curl command for the query + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands