/admin/send/alert

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/admin/send/alert

Sends a user generated alert to the monitoring system.

Input Parameter Description

NameTypeDescription
messagestringAlert message body. The default value is ''.
labelstringLabel to add to alert message. The default value is ''.
log_levelstring

Alert message logging criteria The supported values are:

  • fatal
  • error
  • warn
  • info
  • debug
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

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'admin_send_alert_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /admin/send/alert endpoint:

NameTypeDescription
infomap of string to stringsAdditional information.

Empty string in case of an error.