Overview
LogicModules, or Modules, are fundamental building blocks used in LM Envision that enable comprehensive monitoring, data collection, and system configuration management across your devices in your IT stack. This guide consolidates best practices for configuring the different types of Modules, including DataSources, PropertySources, ConfigSources, EventSources, LogSources, TopologySources, and JobMonitors. Following these guidelines ensures optimal performance, maintainability, and effectiveness of your monitoring setup.
Key Principles
- Maintain consistent device naming conventions across all Modules to ensure clarity and ease of management
- Implement precise AppliesTo scripting logic to target the correct resources and avoid unnecessary monitoring
- Provide comprehensive documentation in descriptions and technical notes to support future maintenance
- Configure appropriate collection intervals based on the criticality and nature of monitored data
- Implement proper access control through Resource Group level access control to maintain security and compliance
- Test thoroughly before deployment using built-in IDE testing capabilities
Configuration Best Practices
Naming and Organization
- Use descriptive, standardized naming patterns (e.g., Vendor_Product_Monitor for DataSources)
- Avoid spaces in unique identifier names to prevent potential system issues
- Create meaningful resource labels that clearly indicate the module's purpose
- Group related modules logically while maintaining the visibility of primary instrumentation
- Use proper capitalization and consistent formatting in all naming elements
Documentation and Metadata
- Include clear, concise descriptions that explain what the module monitors
- Document all technical requirements and dependencies in technical notes
- Specify required credentials, permissions, or system configurations
- Maintain version notes when committing changes
- Include relevant links to vendor documentation or additional resources
Configuration Management
- Set appropriate collection intervals based on data criticality and system impact
- Configure meaningful alert thresholds and transition intervals
- Implement precise AppliesTo scripting to target specific resources
- Use property substitution instead of hardcoded values where possible
- Maintain clear alert messages with actionable information or customize alert messaging with pertinent information
Data Collection
- Validate data types and ranges to prevent spurious alerts
- Implement appropriate error handling and timeout settings
- Use standardized data collection methods based on the target system
- Configure proper encoding and parsing options for log collection
- Implement efficient filtering to reduce unnecessary data collection
Access Control
- Assign appropriate Access Groups to control module visibility and management
- Maintain at least one Access Group per module
- Review and update access permissions regularly
- Consider role-based access requirements when configuring new modules
- Document access control decisions and requirements
Testing and Validation
- Use built-in testing capabilities before deployment
- Verify resource targeting through AppliesTo testing
- Validate data collection scripts and filters
- Verify access control settings work as intended
- Use script testing tools to validate complex logic before deployment
- Test alert thresholds and notification configurations
- Verify access control settings work as intended
Best Practices Checklist
Initial Setup
✅ Choose the appropriate module type based on monitoring requirements
✅ Follow standardized naming conventions
✅ Configure meaningful resource labels
✅ Set appropriate Module group membership (or leave ungrouped if no grouping exists)
✅ Document purpose and requirements
Configuration
✅ Set appropriate collection intervals
✅ Test and configure accurate AppliesTo criteria
✅ Set up proper access controls
✅ Configure data collection parameters
✅ Set up appropriate filters and thresholds
Documentation
✅ Complete all required description fields
✅ Add detailed technical notes
✅ Document dependencies and requirements
✅ Include relevant examples and use cases
✅ Add version notes for changes
Testing
✅ Test AppliesTo scripting to verify correct resource targeting
✅ Validate data collection
✅ Verify alert configurations
✅ Test access controls
✅ Validate filters and thresholds
Maintenance
✅ Review and update regularly
✅ Monitor for performance impacts
✅ Update documentation as needed
✅ Verify access controls remain appropriate
✅ Maintain version history
Conclusion
Effective Module configuration is crucial for maintaining a robust monitoring environment. By following these best practices, organizations can ensure their LM Envision implementation remains scalable, maintainable, and effective. Regular review and updates of these configurations, combined with proper documentation and testing, will help maintain the health and efficiency of your monitoring system. Remember to adapt these practices to your specific needs while maintaining the core principles of clarity, efficiency, and security.
Additional Resources
AppliesTo Function Configuration
Community Manager