REST Resource: projects.locations.instances.errorNotificationConfigs

Resource: ErrorNotificationConfig

ErrorNotificationConfig provides ability for customers to configure and receive self serve notifications. An ErrorNotificationConfig will contain a single notification type eg. IngestionCountZeroNotifications. An notification type can have multiple notification conditions to be set for the error notification. Each NotificationCondition will have its own params such as filters (Eg: CollectorID + logType combo). Please refer below link for more https://cloud.google.com/chronicle/docs/reference/ingestion-metrics-schema CollectorID can also come from forwarders configurations as well. Please refer link for more details: https://cloud.google.com/chronicle/docs/install/forwarder-linux#sample_configuration

JSON representation 
{
  "name": string,
  "display_name": string,
  "enabled": boolean,
  "notification_channels": [
    string
  ],

  // Union field notification_type can be only one of the following:
  "ingestion_count_zero_notifications": {
    object (IngestionCountZeroNotifications)
  },
  "ingestion_size_threshold_notifications": {
    object (IngestionSizeThresholdNotifications)
  },
  "normalization_delay_threshold_notifications": {
    object (NormalizationDelayThresholdNotifications)
  }
  // End of list of possible types for union field notification_type.
}
Fields
name

string

Required if the error notification config exists. The resource name for this error notification config. The format is: projects/{project}/locations/{location}/instances/{instance}/errorNotificationConfigs/{ERROR_NOTIFICATION_CONFIG_ID}
display_name

string

A short name used to identify the error notification config.
enabled

boolean

Used to enable/disable error notification config
notification_channels[]

string

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur. Format: projects/{PROJECT_ID}/notificationChannels/{CHANNEL_ID} More at: https://cloud.google.com/monitoring/support/notification-options
Union field notification_type. Notification type for the error notification config. notification_type can be only one of the following:
ingestion_count_zero_notifications

object (IngestionCountZeroNotifications)

Notifications set for ingestion outages caused by metrics absence.
ingestion_size_threshold_notifications

object (IngestionSizeThresholdNotifications)

Notifications set for ingestion outages caused by metrics not meeting threshold.
normalization_delay_threshold_notifications

object (NormalizationDelayThresholdNotifications)

Notifications set for normalization delays using threshold type trigger.

IngestionCountZeroNotifications

Notifications set for ingestion outages caused by metrics absence.

JSON representation 
{
  "notification_conditions": [
    {
      object (NotificationConditionIngestionCountZero)
    }
  ]
}
Fields
notification_conditions[]

object (NotificationConditionIngestionCountZero)

Notifications conditions present in the ErrorNotificationConfig.

NotificationConditionIngestionCountZero

Describes parameters for the notification condition.

JSON representation 
{
  "collector_id": string,
  "log_type": string,
  "missing_duration": string
}
Fields
collector_id

string

CollectorID for which the error notification is set.
log_type

string

Log type for which the error notification is set.
missing_duration

string (Duration format)

Number of seconds with no data ingested. Currently, only values that are a multiple of a minute e.g., 0, 60, 120, or 300 seconds are supported.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

IngestionSizeThresholdNotifications

Notifications set for ingestion outages caused by metrics not meeting threshold.

JSON representation 
{
  "notification_conditions": [
    {
      object (NotificationConditionIngestionSizeThreshold)
    }
  ]
}
Fields
notification_conditions[]

object (NotificationConditionIngestionSizeThreshold)

Notifications conditions present in the ErrorNotificationConfig.

NotificationConditionIngestionSizeThreshold

Describes parameters for the notification condition.

JSON representation 
{
  "collector_id": string,
  "log_type": string,
  "data_size": number,
  "monitored_duration": string,
  "comparison_type": enum (ComparisonType)
}
Fields
collector_id

string

CollectorID for which the error notification is set.
log_type

string

log type for which the error notification is set.
data_size

number

Amount of data_size bytes in the last monitored_duration seconds. The comparison is applied on the time series, with the time series on the left-hand side and the data_size on the right-hand side.
monitored_duration

string (Duration format)

Duration of the monitored window as explained above. Currently, only values that are a multiple of a minute e.g., 0, 60, 120, 300 seconds etc. are supported.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
comparison_type

enum (ComparisonType)

Comparison type as explained above. Only COMPARISON_LT and COMPARISON_GT are supported currently.

ComparisonType

Specifies an ordering relationship on two arguments, called left and right.

Enums
COMPARISON_UNSPECIFIED No ordering relationship is specified.
COMPARISON_GT True if the left argument is greater than the right argument.
COMPARISON_GE True if the left argument is greater than or equal to the right argument.
COMPARISON_LT True if the left argument is less than the right argument.
COMPARISON_LE True if the left argument is less than or equal to the right argument.
COMPARISON_EQ True if the left argument is equal to the right argument.
COMPARISON_NE True if the left argument is not equal to the right argument.

NormalizationDelayThresholdNotifications

Notifications set for normalization delays using threshold type trigger.

JSON representation 
{
  "notification_conditions": [
    {
      object (NotificationConditionNormalizationDelayThreshold)
    }
  ]
}
Fields
notification_conditions[]

object (NotificationConditionNormalizationDelayThreshold)

Notifications conditions present in the ErrorNotificationConfig.

NotificationConditionNormalizationDelayThreshold

Describes parameters for the notification condition.

JSON representation 
{
  "log_type": string,
  "threshold": number
}
Fields
log_type

string

log type for which the error notification is set.
threshold

number

When the % of normalized events for a log type falls below a certain threshold.

Methods

create

 Creates a new error notification config for the customer

delete

 Deletes an error notification config.

get

 Gets a single error notification config.

list

 Lists error notification configurations for the customer.

patch

 Updates an error notification config.