[LogicMonitor.AlertTable:]
Creates a table of alerts that were active in the reporting period.
Purpose
Creates a table of alerts that were active in the reporting period. Note: The number of days for which alert data is retained in LogicMonitor varies according to whether you have a STANDARD, PRO, ENTERPRISE, MSP STANDARD or MSP PARTNER LogicMonitor set up. For some packages, alerts are only kept for 30 days, so please ensure that you are on one of the packages that keeps alerts for 60 days or more. For more information, check with your LogicMonitor account manager. More details about alert macros can be found at https://reportmagic.blogspot.com/p/reportmagic-alert-macros.html For the take parameter, there is a limit of 300. If your results will be 300 or more, set the take parameter in your macro to 299. You can then do a second macro where you use the skip parameter to skip 299 and take the next 299.
Macro Compatibility
The macro can be used in all input document types and in Report Studio.
Usage
The following columns are supported by the columns parameter (note that some are identical):
- AckComment : The acknowledgement comment, if acknowledged, otherwise "None". Empty if not acknowledged
- Acked: Whether the alert is acknowledged (True or False)
- AckedBy: The username of the user that acknowledged the alert, otherwise "None". Empty if not acknowledged
- AckedOn: When the alert was acknowledged (UTC), otherwise "None"
- AckedOnLocal: When the alert was acknowledged (local time), otherwise "None"
- AckedOnUtc: When the alert was acknowledged (UTC), otherwise "None"
- Active: Whether the alert is active (True or False)
- AlertEscalationChainName: The name of the escalation chain name if applicable (otherwise an empty string)
- AlertRule: The alert rule if applicable (otherwise an empty string)
- AlertRuleName: The alert rule name if applicable (otherwise an empty string)
- AlertType: The type of the alert (usually Alert)
- Body: The alert body from the "detail message"
- DataPoint: The datapoint whose threshold has been breached
- DataSource: The dataSource whose threshold has been breached
- DataSourceId: The ID of the dataSource whose threshold has been breached
- DataSourceInstance: The dataSource instance whose threshold has been breached
- DataSourceInstanceId: The ID of the dataSource instance whose threshold has been breached
- Duration: The duration of the alert in human-readable form (the duration at the time the report was generated if the alert is still active)
- DurationSeconds: The duration of the alert in seconds (the duration at the time the report was generated if the alert is still active)
- DurationMinutes: The duration of the alert in minutes (the duration at the time the report was generated if the alert is still active)
- DurationHours: The duration of the alert in hours (the duration at the time the report was generated if the alert is still active)
- DurationDays: The duration of the alert in days (the duration at the time the report was generated if the alert is still active)
- Device: The device name
- DeviceId The device ID
- DeviceName: The device name
- DisplayName: The device name
- EndOn: The time the alert was cleared (UTC), otherwise "None"
- EndOnLocal: The time the alert was cleared (local time), otherwise "None"
- EndOnUtc: The time the alert was cleared (UTC), otherwise "None"
- Host: The device name
- HostId: The device ID
- Id: The alert ID
- Level: The Alert level (Warning, Error or Critical)
- StartOn: The time the alert was created (UTC)
- StartOnLocal: The time the alert was created (local time)
- StartOnUtc: The time the alert was created (UTC)
- Subject: The alert subject from the "detail message"
- Thresholds: The alert thresholds that have been breached
- Value: The value that triggered the alert
See also Table Macros help.
Parameter | Type | Deprecation Message | Preferred Parameter | Presence | Purpose | Options | Default |
---|---|---|---|---|---|---|---|
AlertLevel | Conditional | Only include alerts at this level or above. |
|
Error | |||
Int32 | Conditional | Only include alerts relating to a LogicModule with this Id. WARNING! Multiple LogicModules could have the same Id. Only use with useCache=true. | N/A | N/A | |||
Regex | Optional | If present, only alerts with acknowledgement comments matching the regular expression are included. | N/A | N/A | |||
AckFilter | Optional | All: Both non-acknowledged alerts and acknowledged alerts will be returned. Acked: Alerts that have been acknowledged will be returned. Nonacked: Alerts that have not been acknowledged will be returned. |
|
All | |||
List<String> | Deprecated | alertTypes | The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'. | N/A | N/A | ||
List<String> | Use instead of:
| Optional | The semicolon-separated list of alertTypes to fetch. Options are: 'AlertThrottled', 'BatchJob', 'CollectorDown', 'CollectorFailBack', 'CollectorFailover', 'DataSource', 'EventSource', 'Log', 'ResourceCluster', 'Unknown' or 'Website'. | N/A | N/A | ||
List<String> | Deprecated | columnAlignments | The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. | N/A | N/A | ||
List<String> | Deprecated | columnAlignments | The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. | N/A | N/A | ||
Boolean | Optional | If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used. |
|
false | |||
AutoFitBehavior | Deprecated | autoFit | The Word autofit behaviour. If omitted, no change is made. |
|
Content | ||
AutoFitBehavior | Use instead of:
| Optional | The Word autofit behaviour. If omitted, no change is made. |
|
Content | ||
Int32 | Deprecated | monitorObjectId | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | ||
List<String> | Use instead of:
| Optional | The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. | N/A | N/A | ||
List<String> | Optional | The column names to show. If the columns parameter is not specified, the Macro's default will be used. | N/A | N/A | |||
String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |||
String | Optional | The name of the Connection. | N/A | N/A | |||
Color | Optional | The critical cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
Color [A=255, R=192, G=0, B=0] | |||
Color | Optional | The critical cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
String | Optional | The name of the dataPoint that you want to retrieve alert data for. | N/A | N/A | |||
String | Use instead of:
| Optional | The DataSource unique name. | N/A | N/A | ||
String | Use instead of:
| Optional | The Datasource Instance e.g. WinVolumeUsage-F: | N/A | N/A | ||
String | Deprecated | dataSourceInstance | The Datasource Instance e.g. WinVolumeUsage-F: | N/A | N/A | ||
String | Deprecated | dataSource | The DataSource unique name. | N/A | N/A | ||
String | Optional | The format of data/time columns. For example: MM/dd/yyyy. | N/A | yyyy-MM-dd HH:mm:ss | |||
Boolean | Optional | Whether to de-camel-case the header row (i.e. convert 'MyHeaderText' to 'My Header Text'. |
|
false | |||
String | Deprecated | monitorObjectDisplayName | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | ||
String | Deprecated | resourceGroupName | Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder. | N/A | N/A | ||
Int32 | Deprecated | monitorObjectId | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | ||
String | Deprecated | monitorObjectDisplayName | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | ||
String | Optional | The C#-format of duration columns where the value is a number. For example: F2 or N0. | N/A | F2 | |||
String | Optional | If present, and the table has no rows, the specified text will be inserted in place of the table. | N/A | N/A | |||
DateTimeOffset | Optional | The end date in the format YYYY-MM-DD. | N/A | Midnight on the first day of this month | |||
Color | Optional | The error cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
Color [A=255, R=240, G=128, B=0] | |||
Color | Optional | The error cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |||
String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |||
Color | Optional | The fatal cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
Color [A=255, R=150, G=0, B=0] | |||
Color | Optional | The fatal cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
SdtFilter | Deprecated | sdted | Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts. |
|
All | ||
Double | Optional | Override the table style's font size. This is achieved by setting the font size for each table cell. |
|
N/A | |||
CellFormat | Optional | The cell format to use. Options are: 'AllStrings', 'Auto' or 'NumbersAsStrings'. Auto automatically sets the format for the whole column, or it can be forced to a string with AllStrings. To preserve date / time formatting (with dateTimeFormat) but treat only number columns as strings, use NumbersAsStrings. |
|
Auto | |||
String | Deprecated | resourceGroupName | Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder. | N/A | N/A | ||
Boolean | Optional | If true, the table will not be written to the report. |
|
false | |||
TableHorizontalAlignment | Optional | The horizontal alignment of the table on the page (does not affect Excel output). |
|
Left | |||
String | Deprecated | monitorObjectDisplayName | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | ||
String | Optional | The specific unique alert ID to fetch. | N/A | N/A | |||
String | Optional | The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z'). | N/A | true | |||
String | Optional | The condition on which each row is included. Fields should be referred to based on the column name in curly braces, for example: includeCondition ='{CreatedOn}'>'{StartOfLastMonth}'. | N/A | N/A | |||
Boolean | Optional | true: Historical alert records will be returned (i.e. both active and inactive alert details). false: Only active alert details will be returned. |
|
true | |||
Color | Optional | The info cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
Color [A=255, R=0, G=213, B=213] | |||
Color | Optional | The info cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
String | Deprecated | problemSignature | Only include alerts matching this problem signature (InternalId). | N/A | N/A | ||
Int32 | Optional | The maximum number of attempts when requesting data via the LogicMonitor API. |
|
N/A | |||
Int32 | Optional | Filter alerts where the alert has been active for more than the specified number of minutes. | N/A | N/A | |||
MacroMode | Optional | The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List |
|
Legacy | |||
String | Use instead of:
| Optional | The display name of the device that you want to retrieve alert data for. If used, do not specify monitorObjectId. | N/A | N/A | ||
Int32 | Use instead of:
| Optional | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | ||
MonitorObjectType | Optional | Determines whether the monitored object in question is a Device or a Website, when specifying the Monitor Object ID and 'useCache=false'. This is necessary because there are specific LogicMonitor API calls to fetch alerts that are used in each case, in order to ensure that, for example, a Device that has had its name changed can still be queried for all alerts by its ID. Just specifying the Monitor Object ID alone is insufficient to determine the type. |
|
Device | |||
Int32 | Optional | If set, sets 'endDate' to the 'start' plus the specified number of months. | N/A | N/A | |||
Color | Optional | The cell color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
Color | Optional | The cell text color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |||
String | Optional | The order the alerts should be retrieved in. | N/A | StartOnSeconds | |||
String | Optional | If present, sorts reverse alphanumerically by this column. | N/A | N/A | |||
Filters.OrderDirection | Optional | The direction of the order the alerts should be retrieved in. |
|
Desc | |||
Double | Optional | The percentage of the available page that the table should occupy. |
|
N/A | |||
String | Use instead of:
| Optional | Only include alerts matching this problem signature (InternalId). | N/A | N/A | ||
Boolean | Optional | Whether to recurse device groups. Specify true to include alerts from child device groups. |
|
true | |||
Boolean | Optional | Whether to repeat the header row at the beginning of each page. |
|
true | |||
String | Use instead of:
| Optional | Only include alerts relating to this device group (end with an asterisk (*) to include child device groups). Use "/" or not value to reference the root folder. | N/A | N/A | ||
String | Optional | Only include alerts relating to a LogicModule with this **Display Name** (NOT unique name). WARNING! Multiple LogicModules (even of the same type) could have the same display name. | N/A | N/A | |||
Regex | Optional | If present, only alerts with a resource template name matching the regular expression are included. | N/A | N/A | |||
Int32 | Deprecated | take | The maximum number to take. | N/A | N/A | ||
SdtFilter | Use instead of:
| Optional | Filter alerts by SDT status where SDT means only include alerts created during SDT in the results, NonSdt means only include alerts created outside SDT in the results and All shows all alerts. |
|
All | ||
Int32 | Due to an issue with the LogicMonitor API, you should no longer filter alerts using any of the parameters: dataSourceName, dataSourceId, websiteName, websiteId. You have some choices, but the 'too long, didn't read' version is 'use a combination of resourceTemplateId and alertType parameters to filter by a specific LogicModule.' Here's the full spiel: 1) If you want to filter by a string, please filter using the resourceTemplateName and the *DisplayName* (not the unique name), but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this display name, you will have the desired outcome. 2) If you want to filter by an id, please filter using resourceTemplateId, but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this Id, you will have the desired outcome. You can use this in combination with the alertType parameter and a single alertType (e.g. DataSource) to guarantee the desired outcome. | monitorObjectId | Optional | DEPRECATED | N/A | N/A | |
String | Due to an issue with the LogicMonitor API, you should no longer filter alerts using any of the parameters: dataSourceName, dataSourceId, websiteName, websiteId. You have some choices, but the 'too long, didn't read' version is 'use a combination of resourceTemplateId and alertType parameters to filter by a specific LogicModule.' Here's the full spiel: 1) If you want to filter by a string, please filter using the resourceTemplateName and the *DisplayName* (not the unique name), but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this display name, you will have the desired outcome. 2) If you want to filter by an id, please filter using resourceTemplateId, but be aware that alerts from any other LogicModule with the same name will also be included - if there is only one LogicModule with this Id, you will have the desired outcome. You can use this in combination with the alertType parameter and a single alertType (e.g. DataSource) to guarantee the desired outcome. | resourceTemplateDisplayName | Optional | DEPRECATED | N/A | N/A | |
Int32 | Optional | The number of items to skip. | N/A | N/A | |||
DateTimeOffset | Optional | The start date in the format YYYY-MM-DD. | N/A | Midnight on the first day of last month | |||
String | Optional | Use Word's built in Table Styles (such as Grid Table 2 - Accent 1), or make your own in the Report Template. Built-in styles can be used in any document. Note that any custom styles you create, or customisations to the standard styles required that the styles exist in the input template XML (because they are not saved in Word documents by default). This can be achieved by assigning the style to a table, then delete the table and save the document. | N/A | Table Grid | |||
String | Optional | The table name (e.g. for XLSX output) | N/A | Table | |||
Int32 | Use instead of:
| Optional | The maximum number to take. | N/A | N/A | ||
ThresholdAffects | Optional | What the threshold affects. |
|
Cell | |||
String | Optional | The threshold column. | N/A | N/A | |||
Boolean | Optional | Whether to use the cache (where supported). |
|
false | |||
String | Optional | The C#-format of the value column. For example: F2 or N0. | N/A | F2 | |||
Boolean | Optional | Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses). |
|
N/A | |||
String | Optional | If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression. | N/A | N/A | |||
Color | Optional | The warning cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
Color [A=255, R=240, G=192, B=0] | |||
Color | Optional | The warning cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. |
|
N/A | |||
Int32 | Deprecated | monitorObjectId | Simply the ID of the device/website/collector that you want to retrieve alert data for. If used, do not specify monitorObjectDisplayName. When used with 'useCache=false', you should also specify whether the entity (in LogicMonitor) in question is a Device, a Website or something else using 'monitorObjectType'. When using the cache, this is not necessary. | N/A | N/A | ||
String | Optional | The worksheet to save the result in the output Excel document (if so configured). Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ] | N/A | Table | |||
Boolean | Optional | Whether to output the result in the output Excel document (if so configured). |
|
true | |||
XlsxTableStyle | Optional | The XLSX table style to use in any XLSX output document. |
|
TableStyleMedium13 |
Examples (2)
Example 1:
[LogicMonitor.AlertTable: dataPoint=PercentUsed, style=Grid Table 5 Dark - Accent 4, autoFit=Content, columns=Level;DeviceName;DataSourceInstance;StartOnLocal;AckComment, level=Warning]
Example 2: Normal mode
This Normal Mode example includes only alerts with acknowledgement comments starting with ABC:
[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, mode=Normal, orderBy=Status, =>DeviceDisplayNames][Json.List: jArray=`{=DeviceDisplayNames}`, jsonPath="$.[0].DisplayName", =>FirstDeviceDisplayName] [LogicMonitor.AlertTable: monitorObjectDisplayName={FirstDeviceDisplayName}, columns=DataSourceInstance;StartOnLocal;AckComment, level=Warning, ackCommentMatchesRegex=ABC.*]