====== ABAP shortdumps ======
===== Purpose =====
  A short dump is generated when a program ends unexpectedly. This is a serious indicator that something went wrong during its execution
  and that some business processes might be impacted.  This monitor will watch for all short dumps occurred on the system.
  You can create general monitoring rules to be notified when a bursts of short dumps is detected. You can also create 
  specific rules to cover special use cases on a given client, instance or for a given program.

===== Configuration hints =====
Start by creating a rule in the table, you can customize monitoring with the following filters: 
  * Instance: To customize for a given instance 
  * Client: To customize for a given client 
  * ErrorId: To select short dumps with a given error Id 
  * Report: To select short dumps for a given report 
 

**Time period** 
  * The period of time in the past to look for short dumps. Make sure the period overlaps with the monitor schedule so you won't miss any dump.

**Aggregate** 
  * This option allows to tune the volume of alarm that will be generated: 
    * If enabled, you will only get one alarm if the count of dumps matching the filter is above  threshold. 
    * If disabled, you will receive one alarm per short dump, with details.

**Multi severity threshold**
  * You can use the [[..:commonsettings#multi_thresholds_syntax|multi threshold syntax]] to define multiple threshold/severity settings per rule.

**Exclusions:**
  * You can define [[..:commonsettings#exclusion_rules|exclusion rules]] to quickly filter out results.

===== Report settings =====
  * To configure short dump information to display in the daily check report, you can use the report checkbox. 
  * When the checkbox is active, short dumps matching the filter will be displayed in the report.
  * In aggregate mode, the rule will generate a table showing the total number of dumps matching the filter. 
  * In non aggregate mode, the report will list the details of every dump matching the filter.

===== Configuration =====
  * **Send metadata:** 
    * If enabled, this parameter will send collected shortdumps as metadata to the configured plugins/integrations
    * It can usually be retrieved as logs or tabular data within the corresponding integrations

  * **Send metrics**
    * If enabled, the monitor will send metrics (See metrics table below)

==== Surveillance table ====
^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Instance|A filter to match only a subset of instances.|
^Client|A filter to match only a subset of clients.|
^Error Id|A filter to match only short dumps with the given error_id.|
^Report|A filter to match only short dumps with the given report.|
^Time period (min)|Defines how far in the past the monitor will look for short dumps at each check. If set to 15 min, it will look for shortdumps occurred in the last 15 min.|
^Max dumps|The threshold used to trigger an alarm. If the number of dumps matching the filter is greater or equal to this value, then an alarm with the appropriate severity will be sent.|
^Aggregates|If checked, the threshold will be compared to the total number of dumps matching the filter. If not checked, the probe will group dumps having the same Error_id and Report values and compare the cardinality of each group to the threshold. Several alarms can potentially be generated.|
^Severity|The level of severity of the alarm generated by this line of surveillance.|
^Auto clear|If checked, the alarm will be cleared as soon as the alarm condition is not met anymore.|
^Alarm tag|This field allows to add custom text within the alarm message. %MSG% variable will contain the actual generated message and can be used such as: "my_prefix %MSG% my_suffix". By default, tag will be used as prefix.|
^Alarm|If checked, this line of surveillance will be used for alarm generation.|
^Metric|If checked, this line of surveillance will be used for QOS generation.|
^Report|If checked, this line of surveillance will used for showing threshold and severity in the daily report|
===== Examples =====
 
^Active^Instance^Client^Error Id^Report^Time period (min)^Max dumps^Aggregates^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|*|*|*|*|15|1|true|MAJOR|true| |true|false|false|

**Effect** : This configuration will collect all the dumps occured in the last 15 min and generate an MAJOR alarm if any as been found.
===== Examples =====
 
^Active^Instance^Client^Error Id^Report^Time period (min)^Max dumps^Aggregates^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|*|800|*|*|15|10|true|WARNING|true| |true|false|true|

**Effect** : This will collect dumps from client 800 and generate a WARNING alarm if 10 or more are detected. A QOS will also be generated.
===== Generated metrics =====
 
^metricId^metricUnit^metricTarget^metricDescription^
|SHORTDUMPS_COUNT|Shortdumps|[INSTANCE][CLIENT][ERROR_ID][REPORT]|The number of short dumps occurred within the period and matching the filter|