Skip to main content

Composite Metric Event Configuration

Home > Select Project > Alert icon Alert > Event Configuration > Composite metrics tab

You can create events and send alert notifications using complex rules.

Default Options

  • Search: Search for specific events by selecting an event name or an event recipient tag
  • JSON Download/Upload: Edit event rules directly in the JSON editor, or download them as a file, modify them, and upload them again
  • Alert Message Settings: Select detailed fields for alert messages and edit the content for each field
  • + Add Event: Add a new composite metrics event
Note

Permissions

To configure Composite metrics events, you must have Alert Settings permission. You can grant this permission by clicking the Edit icon icon for the member in Home > Select Project > Management > Integrated Member Management.

Table | Composite Metrics Event List Layout
ItemDescription
Event TitleUser-defined event name
- Up to 255 bytes
ConditionEvent trigger conditions
Notify on Event RecoveryWhether to receive RECOVERED (normal) notifications when Critical or Warning events are resolved
– Enabled: Sends a RECOVERED notification when the state changes from in-progress to normal, and allows you to distinguish in-progress and resolved states in event history
– Disabled: Triggers a one-time event each time the threshold is exceeded
Event Recipient TagUsers or groups that receive notifications for the event
Edit iconEdit or delete the event
Toggle off iconEvent enablement status
– Enabled: Event is triggered when conditions are met
– Disabled: Event does not run and conditions are not evaluated

Event Configuration

Composite metrics events define event conditions based on MXQL, the metric data query language. The Create from Chart feature provides a combo box to support MXQL auto-completion.

Add Event

  1. Click the Composite metrics tab from Alert icon Alert > Event Configuration.

  2. Click the [ + Add Event ] button on the right side of the screen.

  3. In the Composite metrics window, click Create from Chart.

    a. You can use the provided templates.

  4. In the Event Configuration screen, first query the event data, then configure the event conditions.

Query Event Data

Query event data to build charts. In the Event Configuration screen, select either the Widget or Text option under Query event data on the right to configure events.

Using the options for configuring a time series chart, you can automatically complete the MXQL used for event configuration.

  1. Select the date range for querying data.

  2. Select the Category (target) for querying data.

  3. Click + Add Filter under Filter to create event conditions.

    a. In the filter window, select an expression, tag, and filter value.
    b. Click + Add to add additional conditions.
    c. To delete a condition, click the icon next to it.

  4. Under Grouping, select the grouped metric data. Multiple selections are supported.

  5. Under Time Unit, set the time interval for grouped data by selecting seconds, minutes, or hours.

  6. Under Field, select the fields to be used for event trigger conditions. Multiple selections are supported.

Notification

Enter the basic information for alert notification settings.

  • Enable Event: When the toggle is enabled, the event becomes active.

  • Level: Select the event level (Critical, Warning, Info).

    • Notify on Event Recovery: When the toggle is enabled, a notification is sent when the event is resolved and enters the normal (RECOVERED) state.
  • Title: Enter a title for the event rule.

  • Message: Enter the content of the alert message delivered when the event is triggered. You can use variables in the message to include actual values at the time the event occurs.

    Message example

Tip

Variable Usage Rules

  • Variable format: ${metricName}
  • Only metrics within the same category as the configured category can be used as variables.
  • You can combine multiple variables to compose a detailed message.
  • The list of available variables can be checked in Metric Query.

Event Trigger Conditions

  • Data Query Range: Select the real-time data query window.

    • Available ranges: 30 seconds, 1 minute, 2 minutes, 5 minutes, 10 minutes, 30 minutes, 1 hour, 2 hours, 3 hours
  • Condition: Enter the event trigger condition. Only fields included in the event data query can be used.

Additional Information
  • Interval: The alert condition is evaluated at the selected interval (1 minute, 5 minutes, 10 minutes, 30 minutes, 1 hour, 12 hours).

  • Silence: After an event is triggered, the same event is suppressed for the selected duration (unset, 1 minute, 5 minutes, 10 minutes, 30 minutes, 1 hour, 12 hours).

  • Event Active Time: Configure tags to control when the event runs, such as working hours, non-working hours, or maintenance windows. If no tag is set, the event runs continuously for 24 hours while it is enabled.

    1. Click + Add.

    2. Under Event Active Time, click + Create New Tag.

    3. In Create Event Active Time Tag, select a Tag Name, Days, Time, and Color, then click the [ Apply ] button.

    4. Created tags appear in the tag list and can be applied by selecting the checkbox.

    5. To edit or delete a tag, click the Edit icon icon and modify or remove it in Edit Event Active Time Tag.

    Caution

    When a tag is deleted, it is removed from all users to whom it is applied. However, tags that are currently in use by event rules cannot be deleted.

  • Event Recipient Tags: When recipient tags are configured, notifications are sent to project members who have those tags. If no recipient tag is set, notifications are sent to all users in the project.

    1. Click + Add Tag or the + icon.

    2. Click + Create New Tag at the bottom of the Event Recipient Tags window.

    3. In the Create Tag window, enter a tag name, select a color, and click the [ Create Tag ] button.

    4. To edit or delete a created tag, click the Edit icon icon in the tag list.

    5. Select the desired tag from the Tag List in the Event Recipient Tags window to apply it.

    Tip

    When configuring events, selecting event recipient tags allows notifications to be sent to project members and third-party plugins associated with those tags. You can assign tags to project members and third-party plugins separately via Alert > Notifications.

Test Event Rules

You can test the configured conditions against historical data to estimate how many events would have been triggered.

  1. Select the date for testing the event rules and click the [ Confirm ] button.

  2. Click the [ Run ] button to check the number of triggered events.

Edit/Delete Event

  1. Go to the Alert > Notifications > Composite metrics tab.

  2. In the composite metrics list, click the Edit icon icon of the event you want to edit or delete.

  3. In the Notifications screen, update the options and click the [ Save ] button.

    a. To delete the selected event, click the [ Delete ] button in the upper right corner of the Notifications screen.

Event Sharing

You can save metric event settings as a JSON file to share configurations with other users or import settings created by others.

  • JSON file name: event-rules-YYYYMMDD.json

Export

  1. Click the [ JSON Export icon ] button at the top right of the screen.
  2. When the JSON editor opens, click the [ Export icon Export ] button.
    • If you use the export function after searching for events, only the searched list will be downloaded as a JSON file.
  3. After the JSON file is downloaded, share it with other users.

Import

  1. Click the [ Import icon ] button at the top right of the screen.
  2. Select the JSON file downloaded using the Export function.
  3. When the JSON editor opens, choose either [ Add to List ] or [ Overwrite ].
Caution

It is recommended to use this feature between projects of the same product type. You can import event settings from projects of different products, but they may not function correctly.

Edit in JSON Format

  1. Click the [ JSON Export icon ] button at the top right of the screen.

  2. When the editor opens, modify the content according to the JSON format.

  3. After completing the edits, click the [ Save ] button at the bottom of the screen.

Note

If the modified content does not conform to the JSON format, an error message will be displayed at the bottom of the screen and the content cannot be saved. The error message may vary depending on the type of formatting issue.

JSON error

Alert Message Settings

You can select detailed fields for the messages to be received and edit the content for each field.

Appendix

MXQL Syntax Guide

Composite metrics operates based on MXQL queries. For detailed syntax, refer to the MXQL Syntax Guide.