Come join our live training webinar every other Wednesday at 11am PST and hear LogicMonitor experts explain best practices and answer common questions. We understand these are uncertain times, and we are here to help!
Note: LM APM is available to a limited number of customers. Contact your CSM if you’re interested in learning more.
LogicMonitor has simplified creating and setting up OpenMetrics (Prometheus Exposition Format) DataSources for polling an endpoint where these metrics are exposed. The scripted DataSource templates are still available, but the Collector now supports the OpenMetrics data format, so you no longer need to use a script to parse the data. The recommended way to create new DataSources is to use the wizard.
The wizard is found in your LogicMonitor portal in the Exchange page. Navigate to the Exchange page and select OpenMetrics from the menu tabs. The OpenMetrics tab shows all the DataSources that have been created in the account.
The OpenMetrics format is 100% compatible with the Prometheus Exposition Format on which it is based and has been adopted as the official standard by the Cloud Native Computing foundation.
The setup wizard allows you to load metrics from an OpenMetrics endpoint and select the metrics to process into datapoints for collection. At this time, the host resources need to be in monitoring and a new property for the endpoint URL must be added to the resource.
Set the following custom properties on the OpenMetrics host(s) within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.
If you’ve ever created or edited a DataSource, these fields are the same as the General Information section for any other DataSource to include identifying information.
The unique name of the DataSource. This field is required and represents the name of the DataSource for how it will be displayed in the OpenMetrics DataSource list as well as in the Settings | LogicModules | DataSources list for viewing and editing.
As a best practice, this name should be descriptive. For example, you can specify the platform or application name first, and then specify a specific component of the platform.
The name of the DataSource as it will appear on the Devices page. This name does not need to be unique, for example there can be several DataSources that display as “CPU” and apply to different kinds of devices.
As a best practice, the display name should be shorter than the full DataSource name. For example, use “Services” instead of “Windows Services”, or “VIPs” instead of “Citrix Netscaler VIPs”.
Note: Names and display names for DataSources cannot include the operators and comparison functions because they are reserved for LogicMonitor’s datapoint expression syntax. See Complex Datapoints.
Descriptive information that will be associated with this DataSource. If the DataSource name is not enough to describe what the DataSource is collecting, then the Description field should provide enough information that someone seeing the name and description will understand what the DataSource does.
This field can contain any technical notes associated with the DataSource.
The DataSource Group to which the DataSource will be added. If this field is empty the DataSource will not be added to a DataSource Group. If you enter text that does not match an existing DataSource Group, one will be created.
For example, all Dell hardware monitoring DataSources are assigned the group Dell. This collapses those DataSources into a single DataSource group entry that can be expanded.
Use an AppliestTo script to define which resources to associate with this DataSource. See AppliesTo Scripting Overview.
After you define the General Information for the DataSource, the next step is to Load Metrics. To reduce the amount of setup required in this wizard, some fields default to common values which can be updated when editing the DataSource.
Select a Resource from the list. The Resource should have an endpoint defined for the metrics your your DataSource will collect. In order for a resource to show up in this list, it has to have one of the following properties defined (see Setup Requirements):
Once the metrics from the selected Resource have been loaded in the table, select a set of metrics for which you want to define datapoints for your OpenMetrics DataSource.
Note: If you are defining a multi-instance DataSource (such as a Resource that contains multiple CPUs, Disks, Interfaces, Processes, and so on) the labels which define those instances must exist across all selected metrics. Error checking is provided in the Add DataPoints step to ensure that instance definition is consistent.
After you have selected the metrics for you DataSource, click Next to “Add Instances”.
If the metrics you selected in the previous step do not have any labels defined, you can skip this step and continue to “Add DataPoints”.
Select a label that exists across all the selected metrics which defines the various instance names for the metric. This could be a label for CPU, Disk, Interface, Process, or Job. Each value of this label represents a new and separate instance from which to collect metrics.
If you have defined an Instance label, you can use the “Test Instance Settings” button to display the instance values determined by the selected label. This is similar to the Test Auto-Discover option when viewing DataSources.
(Recommended) Because of the dynamic nature of the OpenMetrics data, new instances may be added at any time. Enabling this feature means new instances will be discovered and added to LogicMonitory automatically.
Select any remaining label as an instance group. If you are gathering metrics from Test, QA, and Prod processes, you can group the instances by an “environment” label so that when you view them in the Resource tree, they will be organized by the environment.
Based on the instance labels you selected and if there are no other labels, those metrics with matching metric name and instance label will be collapsed into a single metric. If these DataPoint definitions are correct, you can click “Finish”.
To edit any of the DataPoint definitions, click the edit pencil. You can:
To filter out metrics, select a label, operator, and value to match. Then select an aggregation type: sum or avg.
When you are done editing your DataPoints, save your changes and then click the “Finish” button.
Note: If the “Finish” button available, you may have improperly defined datapoints. Check the DataPoint list to make sure the status for all is green. You can hover over the red status to see more information about the error. A common error may be that the metric does not contain the instance label you selected. In this case, either go back and select the correct instance label or delete the datapoint to proceed.
From the Finish screen you can select to create another DataSource or return to the OpenMetrics page. Creating a new DataSource will start the process again.
In This Article