AlertConfig

Description

API


    POST /api/alertconfig
    PUT /api/alertconfig/&ltkey>
    DELETE /api/alertconfig/&ltkey>
    GET /api/alertconfig
    GET /api/alertconfig/&ltkey>

CLI


    configure alertconfig &ltkey>
    show alertconfig &ltkey>

Data

AlertConfig

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description
Name of the alert configuration

summary

Type
string
Category
optional
Description
Summary of reason why alert is generated

description

Type
string
Category
optional
Description
A custom description field.

alert_rule

Type
AlertRule
Category
required
Description
list of filters matching on events or client logs used for triggering alerts.

threshold

Type
uint32
Category
optional
Description
An alert is created only when the number of events meets or exceeds this number within the chosen time frame.
Default
1

throttle

Type
uint32
Category
optional
Description
Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config.
Default
600

rolling_window

Type
uint32
Category
optional
Description
Only if the Number of Events is reached or exceeded within the Time Window will an alert be generated.
Default
300

expiry_time

Type
uint32
Category
optional
Description
An alert is expired and deleted after the expiry time has elapsed. The original event triggering the alert remains in the event's log.
Default
86400

source

Type
enum
Category
required
Description
Signifies system events or the type of client logsused in this alert configuration
Choices
EVENT_LOGS, CONN_LOGS, APP_LOGS, METRICS

obj_uuid

Type
string
Category
optional
Description
UUID of the resource for which alert was raised

category

Type
enum
Category
required
Description
Determines whether an alert is raised as soon as the event occurs (Realtime) or the Controller should wait until the specified number of events has occured in the rolling window's time interval.
Default
REALTIME
Choices
ROLLINGWINDOW, WATERMARK, REALTIME

recommendation

Type
string
Category
optional
Description

enabled

Type
bool
Category
optional
Description
Enable or disable this alert config from generating new alerts.
Default
True

action_group_ref

Type
Reference to ActionGroupConfig
Category
optional
Description
The alert config will trigger the selected alert action, which send send notifications or execute custom scripts.

autoscale_alert

Type
bool
Category
optional
Description
This alert config applies to auto scale alerts

tenant_ref

Type
Reference to Tenant
Category
optional
Description

AlertRule

sys_event_rule

Type
AlertRuleEvent
Category
repeated
Description

conn_app_log_rule

Type
AlertFilter
Category
optional
Description

event_match_filter

Type
string
Category
optional
Description

metrics_rule

Type
AlertRuleMetric
Category
repeated
Description

operator

Type
enum
Category
optional
Description
Default
OPERATOR_AND
Choices
OPERATOR_AND, OPERATOR_OR

AlertRuleEvent

event_id

Type
enum
Category
optional
Description
When the selected event occurs, trigger this alert.
Choices
VS_REMOVED_SE, SERVER_UP_HA_ACTIVE, AVG_UPTIME_CHANGE, NEW_PROBABLE_SRVR, POOL_SE_HA_ACTIVE, VS_SCALEIN_FAILED, SE_SERVER_DELETED, VS_SCALEOUT_DONE_AWAITING_MORE_SE, SE_UPGRADING, CONTROLLER_LEADER_FAILOVER, CACHE_OBJ_ALLOC_FAIL, CC_UPDATE_VIP_FAILURE, DEL_NW_SE, VINFRA_DISC_NW, REBALANCE_VS_SCALEIN, MESOS_CREATE_SE_FAIL, VS_SCALEIN_COMPLETE, USER_LOGIN, OPENSTACK_SE_VM_DELETED, VS_RPC_FAILED_EVENT, CONTROLLER_WARM_REBOOT, CC_VNIC_DELETION_FAILURE, OPENSTACK_LBPROV_AUDIT_FAILURE, APIC_VS_PLACEMENT, MESOS_ACCESS_FAILURE, VS_THROUGHPUT_LIMIT, SE_GATEWAY_HEARTBEAT_SUCCESS, UPGRADE_ALL_SE_DONE, LS_ACCESS_FAILURE, SYSTEM_UPGRADE_COMPLETE, PKT_DROP_NO_PKT_BUFF, VS_SCALEIN_DONE_AWAITING_MORE_SE, OPENSTACK_ACCESS_FAILURE, SYSTEM_ROLLBACK_STARTED, APIC_CREATE_CDEV, SE_GROUP_HOST_DEL, AWS_ACCESS_FAILURE, CC_HEALTH_FAILURE, CONFIG_UPDATE, CONFIG_CREATE, SE_EXTERNAL_HM_RESTART, ROLLBACK_ALL_SE_START, VS_SCALEOUT_DONE, ESX_HOST_UNREACHABLE, AWS_IMAGE_UPLOAD_SUCCESS, OPENSTACK_LBPLUGIN_OP_FAILURE, SE_VERSION_CHECK_FAILED, VS_FSM_PARTITIONED, RM_DEL_NETWORK_FAIL, OPENSTACK_SE_VM_CREATED, SE_MIGRATE, SE_CONN_MEM_HIGH, SYSTEM_UPGRADE_STARTED, SE_SERVER_APP_CHANGED, DELETED_SE, CLOUDSTACK_IMAGE_UPLOAD_FAILURE, VS_SE_HA_ACTIVE, CC_DECONFIG_FAILURE, CONFIG_ACTION, MIGRATE_SE_VS_MIGRATE_STARTED, MESOS_ACCESS_SUCCESS, VM_ADDED, SE_HM_EVENT_SHM_UP, NO_HOST_AVAIL, VS_SE_HA_COMPROMISED, VINFRA_DISC_VM, OPENSTACK_VNIC_ADDED, SE_PERSIST_TBL_HIGH, SERVER_AUTOSCALE_OUT_COMPLETE, LICENSE_LIMIT_SE_VCPUS, APIC_CREATE_LIF_CONTEXTS, CONN_DROP_MAX_PERSIST_TBL, UPGRADE_SE_DONE, OPENSTACK_IP_ATTACH_FAILURE, ADD_NW_FAIL, CC_VNIC_DELETED, AWS_ACCESS_SUCCESS, DOCKER_UCP_ACCESS_SUCCESS, SE_EV_POOL_UP, APIC_DELETE_TENANT, CC_VNIC_ADDITION_FAILURE, CONN_DROP_NO_PKT_BUFF, CC_DELETE_VIP_FAILURE, CC_SYNC_SERVICES_FAILURE, SE_MARKED_DOWN, MESOS_STOP_SE_FAIL, MESOS_START_SE_FAIL, MESOS_STOPPED_SE, APIC_DELETE_CDEV, SE_HEALTH_CHECK_FAIL, CLOUDSTACK_ACCESS_SUCCESS, CC_VIP_DNS_REGISTER_FAILURE, MESOS_DELETE_SE_FAIL, METRIC_THRESHOLD_UP_VIOLATION, VCA_IMAGE_UPLOAD_SUCCESS, VS_HEALTH_DEGRADED, SSL_CERT_EXPIRE, SERVER_HEALTH_CHANGE, DOCKER_UCP_IMAGE_UPLOAD_IN_PROGRESS, VCA_IMAGE_UPLOAD_FAILURE, VCENTER_VERSION_NOT_SUPPORTED, SE_VNIC_IP_ADDED, SE_SYN_TBL_HIGH, CREATED_SE, VINFRA_DISC_COMPLETE, VS_DOWN, MESOS_DELETED_SE, VS_FSM_INACTIVE, CC_MARATHON_SERVICE_PORT_OUTSIDE_VALID_RANGE, VS_ADD_SE_INT, MIGRATE_SE_RESTARTED, LICENSE_LIMIT_VS, SE_POWERED_DOWN, VINFRA_DISC_CLUSTER, VS_SCALEOUT_ERR, SERVER_UP, SE_DP_HB_FAILED, VS_SCALEOUT_FAILED, DOCKER_UCP_IMAGE_UPLOAD_FAILURE, CLOUDSTACK_IMAGE_UPLOAD_SUCCESS, CC_IP_ATTACH_FAILURE, MIGRATE_SE_STARTED, SE_HM_EVENT_SHM_DOWN, SUMMARIZED_SUBNETS, CREATING_SE, CLOUDSTACK_ACCESS_FAILURE, APIC_CREATE_TENANT, VS_MIGRATE_SCALEIN_ERROR, UPGRADE_SE_VS_SCALEOUT, APIC_DELETE_LIF_CONTEXTS, SE_PKT_BUFF_HIGH, CREATE_SE_FAIL, POOL_HEALTH_CHANGE, MIGRATE_SE_FAILED, VINFRA_DISC_FAILURE, VCA_ACCESS_SUCCESS, VS_MIGRATE_SCALEIN_DONE, SERVER_HEALTH_DEGRADED, OPENSTACK_IP_DETACH_FAILURE, SSL_KEY_EXPORTED, CONTROLLER_NODE_LEFT, UPGRADE_SE_START, SE_ENABLE, MODIFY_NW_FAIL, CC_CLUSTER_VIP_DECONFIG_FAILURE, OPENSTACK_VNIC_REMOVED, SE_SYN_CACHE_USAGE_HIGH, MESOS_CREATED_SE, OPENSTACK_SE_CREATION_FAILURE, OPENSTACK_VNIC_ADDITION_FAILURE, CONN_DROP_POOL_LB_FAILURE, SE_DOS_ATTACK, CC_SE_START_FAILURE, APIC_DELETE_NETWORK, CC_SE_DELETION_FAILURE, LICENSE_LIMIT_SE_SOCKETS, APIC_CREATE_NETWORK, CC_TENANT_INIT_FAILURE, VINFRA_DISC_HOST, CC_HEALTH_OK, PKT_BUFF_ALLOC_FAIL, CC_IP_DETACHED, UPGRADE_SE_VS_DISRUPTED, VS_FSM_ACTIVE, VS_FSM_AWAITING_SE_ASSIGNMENT, APIC_ATTACH_CIF_TO_LIF, LICENSE_LIMIT_SERVERS, DUPLICATE_SUBNETS, METRICS_DB_DISK_FULL, SERVER_AUTOSCALE_IN_FAILED, CONFIG_INTERNAL_UPDATE, VS_ADD_SE, CC_SE_CREATION_FAILURE, REBALANCE_VS_MIGRATE, SYSTEM_UPGRADE_ABORTED, APIC_BIND_VNIC_TO_NETWORK, SE_VNIC_DUPLICATE_IP, OPENSTACK_ACCESS_SUCCESS, VS_SE_IP_FAIL, CONFIG_DELETE, SE_GROUP_MGMT_NW_DEL, OPENSTACK_IMAGE_UPLOAD_FAILURE, SE_VNIC_DHCP_IP_ALLOC_FAILURE, SERVER_DOWN_HA_COMPROMISED, MESOS_IMAGE_UPLOAD_SUCCESS, VS_SE_BOOTUP_FAIL, MGMT_NW_DEL, LICENSE_EXPIRY, VS_MIGRATE_SCALEOUT_ERROR, UPGRADE_ALL_SE_START, OPENSTACK_IMAGE_UPLOAD_SUCCESS, UPGRADE_ALL_SE_NOT_NEEDED, SE_SERVER_DISABLED, CONTROLLER_SERVICE_FAILURE, APIC_NETWORK_VRF_CHANGED, VS_MIGRATE_SCALEOUT_DONE, VS_FSM_PERMANENT_ERROR, UPGRADE_SE_VS_SCALEIN, LICENSE_ADDITION_NOTIF, VS_FSM_DISABLED, CC_MARATHON_SERVICE_PORT_ALREADY_IN_USE, SERVER_AUTOSCALE_IN, SSL_CERT_RENEW, SSL_CERT_RENEW_FAILED, APIC_CREATE_LIFS, MESOS_UPDATED_HOSTS, DELETE_SE_FAIL, CONN_DROP_NO_CONN_MEM, CC_VNIC_ADDED, LS_IMAGE_UPLOAD_SUCCESS, SERVER_AUTOSCALE_OUT_FAILED, SE_HEALTH_CHANGE, MIGRATE_SE_VS_MIGRATE_FAILED, CONTROLLER_NODE_JOINED, VM_REMOVED, CC_SE_STARTED, LICENSE_LIMIT_THROUGHPUT, CC_SE_STOP_FAILURE, SE_GROUP_CLUSTER_DEL, SERVER_DOWN, CC_SE_DELETION_DETECTED, MIGRATE_SE_VS_MIGRATE_FINISHED, REBOOT_SE, LICENSE_REMOVAL_NOTIF, VS_RPC_TO_RESMGR_FAILED_EVENT, SERVER_AUTOSCALE_OUT, SERVER_DELETED, POOL_UP, DISCOVERY_DATACENTER_DEL, CONN_DROP_MAX_FLOW_TBL, LICENSE_EXPIRED, REBALANCE_VS_SCALEOUT, MESOS_IMAGE_UPLOAD_IN_PROGRESS, SE_EV_SERVER_UP, SE_UP, VS_FSM_ACTIVE_AWAITING_SE_TRANSITION, SE_REBOOTED, IP_POOL_ALMOST_EXHAUSTED, CC_SYNC_SERVICES_SUCCESS, VS_MIGRATE_DONE, CONFIG_INTERNAL_CREATE, SERVER_AUTOSCALE_FAILED, USER_LOGOUT, MGMT_NW_NAME_CHANGED, APIC_DETACH_CIF_FROM_LIF, MODIFY_NW, DOCKER_UCP_IMAGE_UPLOAD_SUCCESS, AWS_IMAGE_UPLOAD_FAILURE, OPENSTACK_SE_DELETION_FAILURE, DELETING_SE, SE_CPU_HIGH, VS_CONN_LIMIT, SE_GATEWAY_HEARTBEAT_FAILED, ESX_HOST_POWERED_DOWN, OPENSTACK_TENANTS_DELETED, SYSTEM_ROLLBACK_ABORTED, SE_MEM_HIGH, CC_IP_ATTACHED, SE_DOWN, CC_SE_CREATED, VS_FSM_UNEXPECTED_EVENT, VS_HEALTH_CHANGE, SERVER_AUTOSCALE_IN_COMPLETE, SE_DISK_HIGH, SE_EV_SERVER_DOWN, SE_HEARTBEAT_FAILURE, MESOS_IMAGE_UPLOAD_FAILURE, VS_SCALEOUT_COMPLETE, CC_CONFIG_FAILURE, VINFRA_DISC_DC, OPENSTACK_VNIC_DELETION_FAILURE, UPGRADE_SE_NOT_NEEDED, VCENTER_ADDRESS_ERROR, VS_MIGRATE_FAILED, LS_ACCESS_SUCCESS, SE_HEALTH_DEGRADED, VS_SWITCHOVER, ROLLBACK_ALL_SE_DONE, VS_UP, SE_EV_VS_UP, UPGRADE_SE_VS_MIGRATE, SE_EV_POOL_DOWN, POOL_SE_HA_COMPROMISED, OPENSTACK_IP_ATTACHED, IP_POOL_EXHAUSTED, SYSTEM_ROLLBACK_COMPLETE, CC_SE_STOPPED, CC_IP_DETACH_FAILURE, CONTROLLER_NODE_DB_REPLICATION_FAILED, VCENTER_BAD_CREDENTIALS, OPENSTACK_LBPLUGIN_OP_SUCCESS, VS_REMOVED_SE_INT, OPENSTACK_SE_VM_DELETION_DETECTED, VCA_ACCESS_FAILURE, VS_SCALEIN_ERR, SE_VM_DELETED, VS_FSM_ACTIVE_AWAITING_SCALEOUT_READY, ANOMALY, SE_EV_VS_DOWN, OPENSTACK_IP_DETACHED, VS_SCALEIN_DONE, POOL_HEALTH_DEGRADED, APIC_BAD_CREDENTIALS, CC_SE_DELETED, VS_MIGRATE_COMPLETE, SE_FLOW_TBL_HIGH, APIC_DELETE_LIFS, OPENSTACK_SYNC_SERVICES_SUCCESS, CREATE_SE_TIMEOUT, MESOS_STARTED_SE, VS_MIGRATE_STARTED, VS_FSM_TRANSIENT_ERROR, CC_GENERIC_FAILURE, VS_INITIAL_PLACEMENT_FAILED, LICENSE_LIMIT_HOSTS, OPENSTACK_LBPROV_AUDIT_SUCCESS, LS_IMAGE_UPLOAD_FAILURE, SE_FATAL_ERROR, ADD_NW_SE, CC_CLUSTER_VIP_DECONFIG_SUCCESS, CC_CLUSTER_VIP_CONFIG_FAILURE, SE_VNIC_IP_REMOVED, POOL_DOWN, MIGRATE_SE_FINISHED, OPENSTACK_SYNC_SERVICES_FAILURE, VS_RPC_TO_SE_FAILED_EVENT, VS_AWAITING_SE, CONN_DROP_MAX_SYN_TBL, CC_CLUSTER_VIP_CONFIG_SUCCESS, DOS_ATTACK, SE_VNIC_DOWN_EVENT, USER_PASSWORD_CHANGE_REQUEST, SE_POOL_DELETED, DOCKER_UCP_ACCESS_FAILURE, VS_SWITCHOVER_FAIL, SE_VM_PURGED

not_cond

Type
bool
Category
optional
Description
Default
False

event_details

Type
EventDetailsFilter
Category
repeated
Description

EventDetailsFilter

event_details_key

Type
string
Category
required
Description

event_details_value

Type
string
Category
required
Description

comparator

Type
enum
Category
required
Description
Default
ALERT_OP_EQ
Choices
ALERT_OP_LE, ALERT_OP_GE, ALERT_OP_LT, ALERT_OP_GT, ALERT_OP_NE, ALERT_OP_EQ

AlertFilter

filter_string

Type
string
Category
required
Description

filter_action

Type
string
Category
optional
Description

AlertRuleMetric

metric_id

Type
string
Category
optional
Description
Metric Id for the Alert. Eg. l4_client.avg_complete_conns

metric_threshold

Type
AlertMetricThreshold
Category
required
Description

duration

Type
uint32
Category
optional
Description
Evaluation window for the Metrics

AlertMetricThreshold

threshold

Type
uint32
Category
optional
Description
Metric threshold for comparison

comparator

Type
enum
Category
required
Description
Default
ALERT_OP_GT
Choices
ALERT_OP_LE, ALERT_OP_GE, ALERT_OP_LT, ALERT_OP_GT, ALERT_OP_NE, ALERT_OP_EQ

References

ActionGroupConfig Tenant

Sub Objects