/export/query/metrics

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/export/query/metrics

Export query metrics to a given destination. Returns query metrics.

Input Parameter Description

NameTypeDescription
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
expressionFilter for multi query export
filepathPath to export target specified as a filename or existing directory.
format

Specifies which format to export the metrics The default value is json.

Supported ValuesDescription
jsonGeneric json output
json_trace_eventChromium/Perfetto trace event format
job_idExport query metrics for the currently running job
limitRecord limit per file for multi query export

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'export_query_metrics_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /export/query/metrics endpoint:

NameTypeDescription
infomap of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys)Parameter Description
exported_filesComma separated list of filenames exported if applicable
outputExported metrics if no other destination specified

Empty string in case of an error.