Skip to content

Custom Collect#

Best-Practices for custom polling#

We recommend enrich your custom metrics with Unryo well-known metadata tags such as technology, resource, resource_type. By doing this, it will simplify grouping, searching and filtering when querying data.

Tag your metrics with well-know tags#

Go in Configuration Management.

image

Go in Tagging and edit the configuration Data Model UserDefined CSV.

In the configuration, add your new line(s) as the examples shown below:

## columns: <measurement>,<technology>,<resource_type>,<resource>,1,<resource_parent>,<resource_parent_type>,<resource_component>,<resource_component_type>,<metric>
## example: docker_container_cpu,Docker,Docker Container,container_name,1,engine_host,Docker Host,cpu,Processor,usage_percent

Where:

  • column 1 (measurement): the name of your (time-serie db) measurement
  • column 2 (technology): a string that identify the technology (i.e. Azure, Cisco IPSLA, ...). Can be an existing one or a new one.
  • column 3 (resource_type): a string that identify the resource type (i.e. VMware vSphere VM, Windows Server, ...).
  • column 4 (resource): the tag from the measurement that identifies the resource.
  • column 5 (resource_availability): set always 1.
  • column 6 (resource_parent): optional. the tag from the measurement that identifies the resource parent.
  • column 7 (resource_parent_type): optional. the resource type of parent.
  • column 8 (resource_component): optional. If the resource has components (i.e. multiple cpu, filesystems, interfaces, ...), the tag from the measurement that identifies the component.
  • column 9 (resource_component_type): optional. The resource component type (i.e. Processor, Interface, ...)
  • column 10 (metric): optional. A field from the measurement that is a key metric (will be displayed in portal views)
  • Other columns are optional and let you model the topology hierarchy. Read the configuration header for details.

Once done, click Apply. Your new data model will take effect for new collected data.

Unryo Metadata#

Monitored resources have a common set of tags - technology, resource_type, resource. Those common tags help you to filter, group and search across the entire monitored infrastructure. Below is a partial list of the Unryo metadata model.

Technology Resource_type Resource
Amazon Amazon EBS Volume volume Id
Amazon Amazon EC2 VM instance Id
Amazon Amazon S3 Bucket bucket name
Amazon Amazon RDS Database database Id
Amazon Amazon Redshift Cluster cluster name
Apache Apache Server server name
Azure Azure Storage Account storage account name
Azure Azure VM virtual machine name
Azure Azure Webapp Service WebApp service name
Cisco Router agent host name
Cisco Switch agent host name
Cisco Layer 3 Switch agent host name
Cisco Wireless LAN Controller agent host name
Cisco Access Point agent host name
Cisco LoadBalancer agent host name
Cisco Firewall agent host name
Cisco Management Module agent host name
Cisco SANSwitch agent host name
Cisco IP-SLA Echo Probe probe name
Cisco IP-SLA Http Probe probe name
Cisco IP-SLA Jitter Probe probe name
Couchbase Couchbase Server server name
Couchdb CouchDB Server server name
Dell EMC Unity Dell EMC Unity Array array name
Dell EMC Unity Dell EMC Unity Volume volume name
Docker Docker Container container name
Docker Docker Host engine hostname
ElasticSearch ElasticSearch Cluster cluster name
ElasticSearch ElasticSearch Node node name
Google Cloud Google GCE VM instance name
Google Cloud Google GCS Bucket instance name
Google Cloud Google BigQuery Project instance name
HTTP Check HTTP Endpoint server name
InfluxDB Unryo Metric Database influx name
Jenkins Jenkins Node node name
Juniper Router agent host name
Juniper Switch agent host name
Juniper Layer 3 Switch agent host name
Juniper Wireless LAN Controller agent host name
Juniper Access Point agent host name
Juniper LoadBalancer agent host name
Juniper Firewall agent host name
Juniper Management Module agent host name
Juniper SANSwitch agent host name
Kapacitor Unryo Analytic Engine engine url
Linux Linux Server server name
MemCached Memcached Server name of the resource
Mongodb MongoDB Database database name
Mongodb MongoDB Server server name
Openstack Openstack Hypervisor hypervisor name
Openstack Openstack Project project name
Openstack Openstack Router router name
Openstack Openstack VM virtual machine name
Openstack Openstack Volume volume name
Ping ICMP Device device name
RabbitMQ RabbitMQ Cluster cluster name
RabbitMQ RabbitMQ Node node name
Redis Redis Server server name
SNMP SNMP Device agent host name
TCP/UDP Check TCP/UDP Port address
Tomcat Tomcat Server server name
VMware vSphere VMware vSphere Cluster cluster name
VMware vSphere VMware vSphere Datastore datastore name
VMware vSphere VMware vSphere Hypervisor hypervisor name
VMware vSphere VMware vSphere VM virtual machine name

Add Maintenance Periods#

To set a resource in maintenance:

  • Go to Settings > Configuration Management > Tagging
  • Edit the configuration In Maintenance.

Maintenance Periods can be set manually (from the Configuration UI) or through the Unryo Vault API.