v2.1.0 enhancements

[stevevillardi]

SUMMARY

proposed v2.1.0

New Modules

• lm_ops_note: Manage LogicMonitor Ops Notes (i.e. add, update, remove)

Feature Enhancement

• lm_info: Add new target ops_note to allow users to gather information about ops notes.
• lm_info: Add new target device_group_devices to allow users to gather information about devices in a specific device group.

Improvements

• Added pagination support to lm_info module GET requests to allow users to gather information about more than 1000 resources.

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

lm_ops_note module

[stevevillardi]

User Story: Enhancing LogicMonitor Integration Capabilities for Comprehensive IT Management

As a DevOps engineer using Ansible for infrastructure management,

I want to have expanded capabilities for interacting with LogicMonitor through Ansible modules,
So that I can more effectively manage and monitor our infrastructure using automation, maintain an accurate inventory, correlate changes with issues, and target specific device groups.

Key Use Cases:

1. Large-Scale Inventory Management:
   As a DevOps engineer, I need to maintain an accurate inventory of our IT estate in LogicMonitor, which contains more than 1000 resources. The enhanced lm_info module with pagination support allows me to extract information about all devices, ensuring a complete and up-to-date inventory for our automation processes.

2. Change Management and Troubleshooting:
   When implementing configuration changes through Ansible, I need to create detailed Ops Notes in LogicMonitor. These notes help our team correlate changes made in the environment with issues arising in LogicMonitor, significantly reducing our Mean Time to Resolution (MTTR) when troubleshooting problems related to recent configuration changes.

3. Targeted Device Group Automation:
   For precise automation, I require the ability to pull resources from specific resource groups in LogicMonitor. The new filtering capability in the lm_info module, based on resource group names, enables me to target the correct devices in our playbooks, enhancing the accuracy and efficiency of our automation workflows.

Acceptance Criteria:

1. Improved Inventory Management

   • I can extract information about all devices in our LogicMonitor portal, even when we have more than 1000 resources.
   • The lm_info module supports pagination for GET requests, allowing me to retrieve a complete and accurate inventory of our IT estate.

2. Ops Notes Management with lm_ops_note Module

   • I can create, update, and delete Ops Notes in LogicMonitor using Ansible playbooks.
   • The module allows me to associate Ops Notes with specific configuration changes made through Ansible.
   • I can include relevant information in Ops Notes to help correlate changes with potential issues, aiding in reducing Mean Time to Resolution (MTTR).

3. Resource Group Filtering with lm_info Module

   • I can use the new "device_group_devices" target in the lm_info module to retrieve devices from a specific resource group.
   • I can filter devices based on resource group names, ensuring my automations target the correct devices.
   • The module provides clear documentation on how to use this new filtering capability.

4. Documentation and Examples

   • Comprehensive documentation is provided for all new features and improvements.
   • Example playbooks are included to demonstrate:
     • Retrieving a complete inventory of devices
     • Creating and managing Ops Notes
     • Filtering devices by resource group

5. Backwards Compatibility

   • Existing playbooks using the lm_info module continue to work without modifications.

Definition of Done:

• All new features and improvements pass unit and integration tests.
• Code adheres to Ansible module development best practices and style guidelines.
• Pull request includes updated documentation for all changes, with a focus on the three main use cases.
• The changes have been tested in a staging environment that mimics production, including scenarios with:
  • More than 1000 resources
  • Creation and association of Ops Notes with configuration changes
  • Filtering devices by resource group
• Performance impacts of pagination and filtering have been assessed and documented.
• At least one example playbook for each main use case is provided in the documentation.