Best Practices for Practitioners: Modules Installation and Collection
Community ManagerOverview
LogicMonitor LogicModules are powerful templates that define how resources in your IT stack are monitored. By providing a centralized library of monitoring capabilities, these modules enable organizations to efficiently collect, alert on, and configure data from various resources regardless of location, continuously expanding monitoring capabilities through regular updates and community contributions.
Key Principles
- Modules offer extensive customization options, allowing organizations to tailor monitoring to their specific infrastructure and requirements.
- The Module Toolbox provides a single, organized interface for managing and tracking module installations, updates, and configurations.
- Available or Optional Community-contributed modules undergo rigorous security reviews to ensure they do not compromise system integrity.
- Regular module updates and the ability to modify or create custom modules support evolving monitoring needs.
Installation of Modules
Pre-Installation Planning
Environment Assessment:
- Review your monitoring requirements and infrastructure needs
- Identify dependencies between modules and packages
- Verify system requirements and compatibility
Permission Verification:
- Ensure users have the required permissions:
- "View" and "Manage" rights for Exchange
- "View" and "Manage" rights for My Module Toolbox
- Validate Access Group assignments if applicable
Installation Process
Single Module Installation:
- Navigate to Modules > Exchange
- Use search and filtering to locate desired modules
- Review module details and documentation
- Select "Install" directly from the Modules table or details panel
- Verify successful installation in My Module Toolbox
Package Installation:
- Evaluate all modules within the package
- Choose between full package or selective module installation
- For selective installation:
- Open package details panel
- Select specific modules needed
- Install modules individually
Conflict Resolution:
- Address naming conflicts when detected
- Carefully consider before forcing installation over existing modules
- Document any forced installations for future reference
Post-Installation Steps
Validation:
- Verify modules appear in My Module Toolbox
- Check module status indicators
- Test module functionality in your environment
Documentation:
- Record installed modules and versions
- Document any custom configurations
- Note any skipped updates or modifications
Core Best Practices and Recommended Strategies
Module Management
Regular Updates:
- Consistently check for and apply module updates to ensure you have the latest monitoring capabilities and security patches.
- Verify changes prior to updating modules to ensure no potential loss of historic data when making changes to AppliesTo, datapoints, or active discovery
- Review skipped updates periodically to ensure you're not missing critical improvements.
Selective Installation:
- Install only the modules relevant to your infrastructure to minimize complexity.
- When installing packages, choose specific modules that align with your monitoring requirements.
Version Control:
- Maintain a clear record of module versions and changes.
- Use version notes and commit messages to document modifications.
Customization and Development
Custom Module Creation:
- Develop custom modules for unique monitoring needs, focusing initially on PropertySource, AppliesTo Function, or SNMP SysOID Maps.
- Ensure custom modules are well-documented and follow security best practices.
Careful Customization:
- When modifying existing modules, understand that changes will mark the module as "Customized".
- Keep track of customizations to facilitate future updates and troubleshooting.
Security and Access Management
Access Control:
- Utilize Access Groups to manage module visibility and permissions.
- Assign roles with appropriate permissions for module management.
Community Module Evaluation:
- Thoroughly review community-contributed modules before installation.
- Rely on modules with "Official" support when possible.
Performance and Optimization
Filtering and Organization:
- Utilize module filtering capabilities to efficiently manage large module collections.
- Create and save custom views for quick access to relevant modules.
Module Usage Monitoring:
- Regularly review module use status to identify and remove unused or redundant modules.
- Optimize your module toolbox for performance and clarity.
Best Practices Checklist
✅ Review module updates monthly
✅ Install only necessary modules
✅ Document all module customizations
✅ Perform security reviews of community modules
✅ Utilize Access Groups for permission management
✅ Create saved views for efficient module management
✅ Periodically clean up unused modules
✅ Maintain a consistent naming convention for custom modules
✅ Keep track of module version histories
✅ Validate module compatibility with your infrastructure
Conclusion
Effectively managing LogicMonitor Modules requires a strategic approach that balances flexibility, security, and performance. By following these best practices, organizations can create a robust, efficient monitoring environment that adapts to changing infrastructure needs while maintaining system integrity and performance.
Additional Resources
Community Manager