Add custom properties to LA rules

Custom properties are fields that you define to store extra information about monitored objects. You can add custom properties to Log Analyzer rules to record details such as the environment, the owner, or the region that a rule applies to. Then, you can use the property values to find, filter, and group rules in the rules list.

Rule custom properties work like custom properties for other entities in the SolarWinds Platform. You can:

• Create a custom property for the Log Analyzer Rules entity type on the Manage custom properties page.

• Assign a value to a single rule while you create or edit it.

• Assign values to many rules at once.

• Filter and group the rules list by custom property values.

• Keep the custom property values when you duplicate, export, or import rules.

Rule custom properties are available only on the new Manage custom properties page. They are not available on the legacy custom properties page.

Use custom properties for stable details that help people find and understand rules, such as Environment, Application owner, Region, or Criticality. Use short property names that are meaningful in filters and groups.

Supported property formats

Rule custom properties support the following formats:

• Text
• Integer number
• Floating point number
• Date/Time
• Yes/No

You can restrict the values for Text, Integer number, and Floating point number properties to a drop-down list.

Create a custom property for rules

1. In the SolarWinds Platform Web Console, click Settings > All settings, and then click Custom properties management.

   To see only the properties that apply to rules, filter the list by the Log Analyzer Rules entity type.

2. Click Add.

3. In the left pane, set Entity type to Log Analyzer Rules, and then select the Custom template.

4. In the Custom property details pane, enter the following information:

   • Property name (required): A name for the property. The name cannot contain spaces.

   • Description (optional): A short description of what the property represents.

   • Format: The type of data that the property stores. To change the length limit for a Text property, click Edit. The default length is 400 characters. You can increase it to a maximum of 4,000 characters.

   • Value must be specified: Select this box to require a value for every rule. Rule Builder does not let you continue until you enter a value for each required property.

   • Create a drop-down list of values for this property: Select this box to limit the property to a predefined list of values. Only administrators can add values to the list.

   • Select how this property will be used (optional): Select where the property can be used.

5. Click Save. To save the property and go directly to assigning values, click Save and assign values.

Assign values to a rule

You can assign values to the custom properties of a single rule while you create or edit the rule.

1. On the Log Viewer toolbar, click Settings.
   

2. In the Processing tab, expand a policy group, and then click My custom rules.

3. Click Create to create a rule, or select a rule and click Edit.

4. On the Rule name step, scroll to the Custom properties area and enter or update the values.

   The fields in this area depend on the custom properties that you defined for the Log Analyzer Rules entity type.

   • Date/Time: Use the date and time pickers.

   • Integer number and Floating point number: Enter a number, or select a value from the drop-down list if one is defined.

   • Text: Enter text, or select a value from the drop-down list if one is defined.

   • Yes/No: Use the switch to turn the value on or off.

5. Click Next. If a required property has no value, an error message displays below the field and you cannot continue until you enter a value.

6. Complete the remaining steps, and then click Save.

When you edit an existing rule, the saved values are already filled in.

Assign values to multiple rules

1. Click Settings > All settings, and then click Custom properties management.

2. Click Assign values.

3. From the Show list, select Log Analyzer Rules.

4. Select one or more rules.

5. Click Edit value(s), or edit the values directly in the list.

6. Save your changes.

Filter and group rules by custom property

After you assign values, you can use them to find and organize rules on the Processing tab. This is helpful when many rules exist across teams or environments.

• Filter: Show only the rules that have a selected custom property value, for example, only rules where Environment is Production.

• Group: Organize the rules list by a custom property, for example, by Team.

What happens to custom property values when you manage rules

Action	Result
Create or edit	You can assign or change values at any time.
Duplicate	The new rule (named Copy of <original rule name>) starts with the same values as the original at the time you duplicate it. Later changes to the copy do not affect the original rule.
Delete	The rule's custom property values are deleted with the rule. Other rules are not affected. Deleted rules no longer appear on the Assign Values page.
Export	The exported JSON file includes the rule's custom property values.
Import	Custom property values are restored for properties that still exist. If you added a property after you exported the rule, its value is blank until you assign one.

For more information, see Duplicate rules and Import and export rules.

Rules that existed before you upgraded have blank values for any new custom properties.