Managing Resources that Ingest Push Metrics
Last updated on 15 December, 2024The Push Metrics REST API is designed to push metrics to existing resources in your LogicMonitor portal. In addition, you can override the default settings for Push Metrics REST API by using the API request, which creates a new resource if no existing resource matches the query. For more information, see Ingesting Metrics with the Push Metrics REST API.
All resources, including those created by the Push Metrics REST API, are stored in the LogicMonitor platform. In addition, a single resource can both ingest push metrics using the Push Metrics API and receive metrics using DataSources that use pull-based collection methods.
Requirements for Managing Resources that Ingest Push Metrics
To manage resources that ingest Push Metrics, you need the following:
- “Manage” permission for resource groups
- The resource group is an existing resource group
Consideration and Limitations when using Resources that Ingest Push Metrics
There are certain limitations for resources, which are created by the Push Metrics REST API and receive data only from push model DataSources.
Due to the limitations, consider the following actions in the context of the push (when compared to pull) communications model:
- Manually run Active Discovery for the resource
- Access the resource using a remote session
- Manually poll an instance for current datapoint values (as initiated from the Raw Data tab)
- Debug data collection for an instance (as initiated from the Raw Data tab)
Viewing the Resource that Ingest Push Metrics
- In LogicMonitor, navigate to Resource Tree> Resources> select the required DataSource that contains Push Metrics data.
- Select the Instance and then the Raw Data tab.
Push Metrics Unique Property for Associated Resources
You can associate the resources with multiple DataSources grouped into resource groups. In addition, the resources can be referenced in alert rules.
These resources have a unique property system.pushmodules
that allows the resources to support push model data ingestion. Any resource referenced in a Push Metrics REST API call is assigned a property named system.pushmodules
. Similar to the system.categories
property, the system.pushmodules
property is automatically updated with values that associate it with its corresponding Push Metrics DataSources.
For example, if an API call instructs the Push Metrics REST API to ingest metrics for Resource A using DataSource B then the following events occur:
- A unique tag associated with DataSource B is added as a value to resource A
system.pushmodules
property. - The AppliesTo statement that is created for DataSource B associates with resources that carry the datadource tag as a value in their
system.pushmodules
properties.
Resource Matching
When a request for metrics ingestion is submitted using the Push Metrics REST API, LogicMonitor searches for resources with resource IDs as properties and pairs the request with an existing resource in the portal.
If multiple resources are found with specified resource IDs, an error occurs. Hence, you must ensure that the resourceIds field has unique key-value pairs in its array to get the desired result.
Following is a list of system properties, organized by resource type, that can be considered for use in the API query. You can use any resource property in the query. For more information on resource properties, see Resource and Instance Properties.
Standard Devices/Kubernetes Containers | AWS Resources | GCP Resources | Azure Resources |
system.display namesystem.deviceid system.hostname system.collectorid system.sysoid System.ips auto.network.mac_address | system.display namesystem.deviceid system.aws.resourceid system.aws.arn | system.displayname system.deviceid system.gcp.resourceid system.gcp.resourcename system.gcp.projectId system.cloud.category system.gcp.resourceid | system.displayname system.deviceid system.azure.resourceid system.azure.resourcename |
If no existing resources are returned, and the create query parameter is set to TRUE in your request (the default setting is FALSE), a new resource is created, which has the specified resource IDs set on it.
The Push Metrics REST API has an endpoint dedicated to updating a resource’s properties. For more information, see Updating Resource Properties with the Push Metrics REST API.
Push Metrics for Deleted Resources
You can detect the resources that receive push metrics via the LogicMonitor interface similar to other resources. However, you cannot delete these resources using Push Metrics REST API. Once the resource is deleted, any data pushed to that resource is ignored.
If the deleted resource was created using the Push Metrics REST API and only receives data from push model DataSources, it is immediately deleted (unlike other resources, which are moved to the Recently Deleted folder for seven days).