Inventory User Guide

Sort and filter your inventory of elements into lists.

Your inventory is the elements that make up your environment, from your java virtual machines to your Amazon EC2s. Metricly’s Inventory Explorer allows you to view and search the elements in your inventory.

About Elements

The physical or logical components that Metricly monitors are called elements. An element can be a physical entity, such as a server or network element, a virtual entity, such as a transaction, or a business entity, such as a company traded on the stock market. Elements are the base component that Metricly uses to analyze metrics and determine the status of your environment.

All elements share the following characteristics:

  • A unique name and identifier in Metricly.
  • Descriptive attributes, or characteristics, assigned by an integration.
  • Events that are triggered when the conditions in policies are met.
  • A tag or tags used to label and organize elements.
  • An element type, usually assigned by an integration.

Attributes

An attribute is a property or characteristic that describes an element. Having attributes gives you access to more statistical data that can be used to troubleshoot issues. Most elements receive attributes from their integration.

 For example, with attribute information, you can see the number and type of CPU running on a server element, while also viewing an event that was generated based on that element’s CPU value.
Element Types

Each element has a type that determines how it is processed and represented by Metricly. Element type is also used as a filter in list pages in the UI. The types of elements in your environment will vary based on the integration that you use.

Integration Element Type in Metricly
AWS  ASG (Auto Scaling Group)
 Custom Cloudwatch Metrics You can search for your Custom CloudWatch Metrics elements using the type Custom Metrics.
 DynamoDB
 EBS (Elastic Block Store)
 ECS (EC2 Container Service)
 EC2 (Elastic Compute Cloud)
 Elasticache Elasticache instances can come in a few “flavors”, which means

metrics are unique to each “flavor” of Elasticache. Host-level metrics are present on both Memcached as well as Redis clusters. Memcached metrics are available only on Memcached clusters, Memcached 1.4.14 metrics are only available on Memcached clusters using at least version 1.4.14, and Redis metrics are present only on Redis clusters.
 ELB (Elastic
Load Balancer)
 EMR (Elastic Map Reduce)
 Kinesis (Stream)
 Lambda
 RDS
(Relational Database Service)
 Redshift

For each Redshift cluster, two types of elements are collected:

  • RedshiftCluster: Contains cluster-specific metrics as well as metrics that are averages across all nodes.
  • RedshiftNode: Contains node-specific metrics. There will be one element per Redshift node.
 SQS (Simple
Queue Service)
AWS Cost N/A
Browser  BROWSER
Custom N/A*
Docker  Docker Container
Java  JVM
 CLUSTER
Linux (Metricly)  SERVER
Microsoft Azure  AZURE VIRTUAL MACHINE
 APPLICATION GATEWAY
Ruby RUBY
Windows  WINSRV
Collectd  SERVER

Diamond
 SERVER

StatsD
 StatsD

Available Actions

The inventory page allows you to quickly navigate through all of your elements, sort, and perform bulk actions. The Inventory Explorer displays all the elements in your environment that were processed in the last hour. Elements are removed from the elements table roughly seven hours after an associated datasource is disabled.


Use the Quick Bar

Select the elements you’d like to edit using the checkboxes on the far left of each row. After a checkbox is selected, the Quick Bar appears.

Then, select one of the following actions:

  • View Metrics
  • Add/Delete Tag
  • Start/Stop Maintenance
  • Delete Elements
Delete Elements

Once you delete an element the metadata will be permanently removed. This cannot be undone. Historic time series data for that element will still be kept. If an element with the exact same metadata appears in Metricly, the available data for the element will be associated with it.

  1. Open the Inventory Explorer.
  2. Select the check box next to as many elements as desired.
  3. Click Delete Element(s) at the top of the Inventory Explorer table. .
  4. Click Yes, Delete.
Add Tags
  1. Open the Inventory Explorer.
  2. Select the check box next to as many elements as desired.
  3. Click Add Tag at the top of the Inventory Explorer table.
  4. Type a Key and Value for the tag. An element can have multiple tags (up to 10), but keys cannot be used more than once.
    If you add a value to an existing tag, it will overwrite the previous value(s). The element(s) that already have a tag with the key name you’ve typed will be highlighted blue.
  5. Click Confirm Changes.
    A summary of your changes will display.
  6. Click Save.
Delete/Edit tags
  1. Open the Inventory Explorer.
  2. Select the check box next to as many elements as desired.
  3. Click Add Tag or Delete Tag at the top of the Inventory Explorer table.
  4. Type a key. Any elements that already have the tag will be highlighted blue in the Element(s) column.
  5. Type a value. If a tag already exists on an element, the value(s) will be replaced with the values you currently have typed.
  6. Click Confirm Changes
  7. Click Save.

Start/Stop Maintenance

You can place elements into maintenance mode from the Inventory Explorer or via the Metricly CLI (Command Line Interface). While an element is in maintenance mode, learning for that element is disabled (i.e. no contextual or baseline bands will be displayed) and events will not be generated for the element.

  1. Open the Inventory Explorer.
  2. Select the check box next to as many elements as desired.
  3. Click Start or Stop Maintenance at the top of the Inventory Explorer table. A summary page displays.
  4. Select a duration via the Expire After dropdown.
  5. Click Confirm.

If you do not want to set a duration for the maintenance mode, you can still return to the inventory page at a later time and manually end maintenance via selecting the elements and clicking the Stop Maintenance button.


Sort Elements

Select two or more elements and then click View Metrics to open multiple elements on the Metrics page. The Elements table initially has six columns:

  1. Type: Shows icon for an element’s type. You can see all the icons here.
  2. Name: Name of the element.
  3. Data Collection: The percentage of metrics that were collected in the last analytics cycle (5 minutes).
    If no metrics were collected, there could have been an issue with collection or too many metrics were collected, which forces Metricly to not collect any metrics.
  4. Collectors: The names of the collector(s) currently enabled on the element.
  5. Created: The date when the element was created in Metricly.
  6. Last Processed: The last time and/or date each element was processed by Metricly.

Select Filters

Contains several filters where you can search for element names, element types, tags, attributes, collectors, and more. Expand the More filter to see additional filters; select a filter to add it to the list of active filters.


Choose Time Frame

Setting a Time Frame controls the range of elements shown in the Inventory Explorer Elements table. The number of elements displayed on the Inventory Explorer is dependent upon the time frame setting (i.e., an element that was available a week ago but not available now would show on the list when 1w is selected).


Add/Remove Columns

You can add and remove columns to the Inventory Explorer Elements table for a custom view from this sub-menu.

Adding/removing table columns
  1. Click the Cog in the upper right hand corner of the page.
  2. Select or deselect options from the Tags and Attributes filters to show or hide columns in the Elements table.
    Some attributes may be available for AWS elements only. To return to the default columns in Inventory Explorer, select Reset Defaults in the Table Columns dialog.
  3. Click the Cog again to view your changes.

Element Detail Panel

The Element Detail panel displays tabs for the metric summary, policies, and relationships associated with the selected element.


Summary Tab
  • The Summary tab displays a dashboard full of select widgets to highlight the most important details of the selected element.

Policies Tab
  • The Policies tab offers the same functionality as the Policies Page except the Policies tab only displays policies that include the selected element in the policy’s scope. Below is a picture of an EC2’s policies tab.

Relationships Tab
  • The Relationships tab offers the same functionality as the Elements Relationships widget: it displays the other elements associated with the selected element. Click any of the elements on the tree to open the selected widget’s element detail panel.

Tagging elements

A tag is a key-value pair assigned to a single element. Tags can be used to group elements and as search filters in Inventory ExplorerEvent ExplorerReport Explorer, and Policy Editor. You can tag elements via the Inventory Explorer.

For AWS elements, Metricly allows you to use the existing tags in your AWS CloudWatch account. For more information about tagging your elements in AWS, see the AWS tagging user guide.
capterra

Join other DevOps who love Metricly!

Sign up for a free, fully featured, 21-day trial. No credit card required!