Module Details Editor

The Module Details Editor allows you to view and modify metadata for module-bound tabs. Edit properties like name, description, AppliesTo expressions, and alert configurations.

Opening Module Details

Method	Action
Toolbar Button	Click the Module Details button in the main toolbar
Command Palette	Press Cmd+Shift+P and type “Module Details”

Module-Bound Tabs Only

The Module Details button only appears for tabs loaded from a LogicModule. Local files don’t have module metadata.

---

Editor Layout

Sidebar Navigation

The left sidebar contains section links. Sections vary by module type:

Module Type	Available Sections
DataSource	Basic Info, Organization, Access, Applies To, Active Discovery, Datapoints
ConfigSource	Basic Info, Organization, Access, Applies To, Active Discovery, Config Checks
TopologySource	Basic Info, Organization, Access, Applies To
PropertySource	Basic Info, Organization, Access, Applies To
LogSource	Basic Info, Organization, Access, Applies To, Include Filters, Log Fields, Resource Mappings
EventSource	Basic Info, Organization, Access, Applies To, Alert Settings
DiagnosticSource	Basic Info, Organization, Access, Applies To

Click a section to navigate. Dirty sections show an indicator dot. Invalid sections show a red error icon.

---

Common Sections

Basic Info Section

Module Name

The internal identifier for the module:

• Must be unique within the portal
• Alphanumeric with underscores only
• Used in API references
• Maximum 255 characters

Display Name

The human-readable name (DataSource/ConfigSource/EventSource only):

• Shown in the LogicMonitor UI
• Can include spaces and special characters
• Maximum 100 characters

Description

Documentation for the module:

• Supports multi-line text
• Explain what the module monitors
• Include setup requirements
• Maximum 1000 characters

Version

Read-only field showing:

• Current version number
• Last modified date
• Modified by user

---

Organization Section

Field	Description
Module Group	Organize modules into groups by selecting from existing groups
Tags	Add searchable tags as comma-separated values (e.g., custom, production, network)
Technology Type	Categorize by technology: Windows, Linux, Network, Cloud, or Custom
Collector Attribute	For modules requiring specific collector capabilities

---

Access Section

Field	Description
AppliesTo Expression	Define which resources use this module. Click Test to open the AppliesTo Toolbox
Group Restrictions	Select groups from dropdown. Multiple groups allowed. Leave empty for no restrictions
Collector Groups	Assign to specific collector groups for geo-specific monitoring

Example AppliesTo Expression:

system.sysinfo =~ "Linux" && hasCategory("server")

---

DataSource Sections

Active Discovery Section

DataSource / ConfigSource Only

For modules with instance discovery:

Setting	Description
Discovery Method	Script-based, SNMP, WMI, or None (single instance)
Discovery Interval	Range: 5 minutes to 24 hours. Balance freshness vs. performance
Instance Properties	Define auto-properties discovered for each instance
Filters	Post-discovery filtering with include/exclude patterns

---

Datapoints Section

DataSource Only

Edit datapoints directly within LMDA Composer. The datapoints editor provides full CRUD operations for managing metric collection.

Datapoint Types

Normal Datapoints

Standard datapoints that collect metrics from script output:

• Source: Output key from collection script, exit code, or response time
• Metric Type: Gauge (current value), Counter (cumulative), or Derive (rate of change)
• Interpretation Method: How to transform the raw value (none, percent, bits to bytes, etc.)

Complex Datapoints

Expression-based datapoints that derive values from other datapoints:

• Source: Expression using other datapoint names
• Metric Type: Always Gauge (calculated values)
• Syntax: Use datapoint names directly, e.g., UsedMemory / TotalMemory * 100

Datapoints Table

The main datapoints table displays:

Column	Description
Name	Unique datapoint identifier
Type	Metric type with icon (Gauge, Counter, Derive)
Method	Post-processor method (Expression, Name=Value, JSON Path, etc.)
Key / Expression	The extraction key or expression
Threshold	Color-coded severity badges with operator and values

Click a row to expand and see additional details:

• Description (with line break support)
• Alert settings (No Data, Trigger, Clear intervals)
• Alert message subject and body
• Status display name translations

Adding Datapoints

1. Click the Add Datapoint dropdown button

2. Select Normal or Complex datapoint type

3. The editor sheet opens with type-appropriate options:

   • For Normal: Configure source (output key, exit code, response time), metric type, and interpretation
   • For Complex: Enter expression using other datapoint names

4. Configure alert thresholds if needed (Warning, Error, Critical)

5. Add optional description and alert message customizations

6. Click Save to add to the datapoints list

Editing Datapoints

Click the Edit (pencil) button on any datapoint row to open the editor sheet. All fields are editable:

Section	Fields
Basic Settings	Name, description, source configuration, and metric type
Alert Thresholds	Warning, Error, and Critical thresholds with custom operators
Alert Messages	Custom subject and body templates with token support
No Data Handling	Alert level and intervals for missing data scenarios
Status Translations	Map numeric values to human-readable labels

Removing Datapoints

1. Click the Delete (trash) button on the datapoint row

2. Confirm the deletion in the dialog

3. The datapoint is marked for removal (committed on next push)

Data Loss

Removing a datapoint also removes historical data for that metric in LogicMonitor. This cannot be undone.

Common Options Only

The datapoint editor shows the most commonly used options. For advanced settings like dynamic thresholds or complex alert tuning, use the LMX module page in your portal.

Status Display Names

Translate numeric datapoint values to human-readable status strings in the LogicMonitor UI. Instead of displaying raw numbers like 0 or 1, show meaningful labels like “Offline” or “Online”.

Adding Status Translations:

1. Open the datapoint editor sheet

2. Scroll to the Status Display Names section

3. Click Add Translation

4. Configure:

   • Operator: How to match the value (equals, greater than, less than, etc.)
   • Value: The numeric threshold to match
   • Display Name: The human-readable label to show (max 128 characters)

5. Add additional translations for other value ranges

6. Click Save to apply changes

Example Configuration:

Operator	Value	Display Name
Equals	0	Offline
Equals	1	Online
Greater Than	90	Critical Load

Alert Message Templates

Customize alert notifications with dynamic content using LogicMonitor tokens:

Token	Description
##DEVICE##	Device display name
##INSTANCE##	Instance name
##DATAPOINT##	Datapoint name
##VALUE##	Current metric value
##THRESHOLD##	Threshold that was crossed
##LEVEL##	Alert severity level

---

ConfigSource Sections

Config Checks Section

ConfigSource Only

Config Checks define validation rules for configuration data collected by ConfigSources. Each check can trigger alerts based on configuration changes, missing values, or custom Groovy logic.

Config Check Types

Any Change

Alerts on any configuration change with optional exclusions:

• Ignore regex patterns: Lines matching regex are excluded from diff
• Ignore lines starting with: Exclude lines with specific prefixes (e.g., #, //)
• Ignore lines containing: Exclude lines with specific text
• Ignore blank lines: Skip blank line differences
• Ignore whitespace: Skip spacing changes

Multiple patterns can be added for regex, prefix, and contains exclusions.

Groovy Script

Custom validation logic using Groovy:

• Access configuration via the config variable
• Return 1 to trigger alert, 0 for no alert
• Full Groovy scripting capabilities

Config Retrieval

Alerts when the configuration cannot be collected:

• No additional options required
• Triggers on fetch failure

Missing Field

Alerts when a specific field is missing:

• Specify the variable/field name to check
• Triggers when the field is absent from config

Value Check

Alerts on value changes or range violations:

• Value Changed: Alerts when the field value changes
• Value Range: Alerts when value is outside bounds (gt, lt, gte, lte, eq, ne operators)

Config Checks Table

The main table displays:

Column	Description
Name	Unique check identifier
Type	Check type with icon indicator
Alert	Color-coded severity badge (Warning/Error/Critical)
ACK Clear	Whether acknowledging clears the alert
Summary	Brief description of check configuration

Click a row to expand and see:

• Description
• Auto-clear interval (if configured)
• Script content (for Groovy checks)

Adding Config Checks

1. Click the Add Check dropdown button

2. Select the check type:

   • Any Change — Diff-based detection with exclusions
   • Groovy Script — Custom validation logic
   • Config Retrieval — Fetch failure detection
   • Missing Field — Required field validation
   • Value Check — Value change or range monitoring

3. The editor sheet opens with type-specific options

4. Configure:

   • Name: Unique identifier for the check
   • Description: Documentation text
   • Alert Level: Warning, Error, or Critical
   • Clear on Acknowledgement: Auto-clear when ACK’d
   • Clear After: Minutes until auto-clear (0 = never)

5. Configure type-specific settings (patterns, script, variable, etc.)

6. Click Save to add to the config checks list

Editing Config Checks

Click the Edit (pencil) button on any row to open the editor sheet. All fields are editable:

Section	Fields
Basic Settings	Name, description, and check type
Alert Configuration	Severity level, clear behavior, and intervals
Check Logic	Type-specific configuration (exclusions, scripts, variables)

Removing Config Checks

1. Click the Delete (trash) button on the row

2. Confirm the deletion in the dialog

3. The check is marked for removal (committed on next push)

Alert History

Removing a config check may affect alert history and escalation chains associated with that check.

---

LogSource Sections

LogSource Only

LogSource modules have specialized sections instead of traditional scripts:

Include Filters Section

Define filters to include or exclude log entries:

Field	Description
Filter Name	Unique identifier for the filter
Filter Type	Include or Exclude
Match Pattern	Regex pattern to match log lines
Field	Which log field to apply the filter to

Log Fields Section

Define custom fields to extract from log entries:

Field	Description
Field Name	The name of the extracted field
Extraction Method	Static value, Regex, or LM Property (Token)
Value/Pattern	The static value or extraction pattern

Methods available:

• Static: Fixed value for all logs
• Dynamic (Regex): Extract using regular expression
• LM Property (Token): Use LogicMonitor device property

Resource Mappings Section

Map log entries to LogicMonitor resources:

Field	Description
Mapping Name	Unique identifier
Source Field	Log field to use for mapping
Target Property	LogicMonitor property to match against

---

EventSource Sections

Alert Settings Section

EventSource Only

Configure alerting behavior for EventSource modules:

Setting	Description
Alert Level	Default severity (Warning, Error, Critical)
Alert Subject	Template for alert notification subject
Alert Body	Template for alert notification body
Clear on ACK	Whether acknowledging clears the alert
Effective Interval	Time before alert re-triggers (in minutes)

---

Making Changes

Change Tracking

The editor tracks all modifications:

• Modified fields highlighted
• Section indicators show dirty state (dot icon)
• Invalid sections show error icon
• Undo available per field

Staging Changes

Changes are automatically staged when you modify fields. All changes are committed together when you push to the portal.

Resetting Changes

Click Reset Changes to discard all modifications and revert to original values.

---

Validation

Required Fields

Field	Required
Module Name	Yes
Display Name	DataSource/ConfigSource/EventSource
AppliesTo	Most types

Character Limits

Field	Limit
Name	255 characters
Display Name	100 characters
Description	1000 characters
AppliesTo	2000 characters

---

Portal Binding

Mismatched Portal

If the active portal differs from the module’s portal, an overlay warning appears. Switch portals in the Context dropdown before editing.

---

Next Steps

Module Lineage View Exchange release history for LogicMonitor core modules.