IN THIS ARTICLE:
Introduction to LogicModule Exchange
LogicModule Exchange is a platform that provides for versioning, publication, and sharing of customized LogicModules (e.g. DataSources, EventSources, PropertySources, etc.).
We've designed the LogicModule Exchange to provide for two primary use cases:
- Maintaining LogicModule Versions. Keep multiple versions of any LogicModule.
- Sharing LogicModules Across Customers. Allow our customers to benefit from the knowledge and work of the entire LogicMonitor user community through the easy exchange of custom monitoring solutions, whether they are brand new LogicModules or modifications to LogicMonitor stock LogicModules.
LogicModule Exchange adds versioning information to LogicModule definitions.
You can view any LogicModule definition by navigating to Settings | [LogicModule type (e.g. DataSources, EventSources, etc.)] and clicking on the LogicModule name. At the top of the LogicModule definition you will see a "Version Information" table with fields defined as follows:
- Author. The author of this particular module, which is based on the account name of the form [accountname].logicmonitor.com. As such, the modules are exclusively linked to the individual publisher, not their company's account.
- Version. Indicates the specific version of this module
- Quality. The quality specification of this module, as determined by our Monitoring Engineers
- Status. The publication status of this module, along with its "locator" token
Publishing LogicModules to LogicModule Exchange
In LogicModule Exchange, publishing refers to the storage of a copy of your customized module in our LogicModule Registry along with its unique version information.
Prior to publishing your module, you will need to make sure it is saved. Once saved, the publish to exchange button will be enabled, as shown next.
Note: Stock modules provided by LogicMonitor (as noted by "LogicMonitor" in the Author field) cannot be republished without modification.
Upon successfully publishing a LogicModule, you'll be presented with a confirmation screen providing you with the version number and a LogicModule Locator for your module.
The LogicModule Locator is used to retrieve other versions as well as exchange modules with others. For the sake of convenience, we recommend you keep track of your LogicModule Locators. If you lose one or more, however, we do store all records of them.
Once a module has been published, you can make further changes, save, and republish. Upon doing so, the version number will increment and you'll be issued a new LM Locator corresponding to each new version you publish.
Note: To unpublish a LogicModule, contact LogicMonitor customer support.
Sharing LogicModules with Other Customers
If you would like to share your modules with other customers, you can do so by posting in the LM Exchange forum in LogicMonitor Communities. In your post, include the LogicModule Locator(s) of the modules you wish to share as well as descriptions of what they do. Other community members will be able to import the modules directly into their accounts and the version information will indicate the module's provenance.
Importing LogicModules from LogicModule Exchange
Once LogicModules have been published, they can be retrieved and imported into your account or into the accounts of other customers.
You may find this useful for reverting to a previous version of a module you've developed, or importing a new module that has been developed by another customer. To do so, navigate to Settings | [LogicModule type (e.g. DataSources, EventSources, etc.)] | Add | From LogicModule Exchange, as shown next.
The Audit Log will reflect the user ID of those who imported modules into the account.
Upon import, you'll be presented with a confirmation dialog to ensure the module you're importing is indeed what you want in your account.
Clicking Proceed will add the module to your account, along with the versioning information described above (author, version, quality, and locator).
Note: When importing a module from another customer, you'll likely want to review and edit the AppliesTo field, as well as alert thresholds to ensure applicability to your environment.
LogicModule Exchange Security
To ensure the security of our customers' environments, any modules containing script code are held for security review upon publication. Our Monitoring Engineers are notified upon publication of any scripted module and ensure that no malicious actions are taken in the script code before releasing the module for import. Prior to security review, scripted modules are assigned LogicModule Locators but are not available for import.