Device Availability
Introduction
Device Availability is a go-to solution for monitoring devices, providing real-time insights into the availability of devices.
Getting Started
Compatibility
Device Availability O11ySource is compatible with any device which allows incoming ICMP echo requests and outgoing echo replies.
Data Collection Method
vuSmartMaps collects the availability data for this O11ySource using an internal data collector. This data collector collects data based on the source configuration done in the Sources tab of the O11ySource.
Prerequisites
Inputs for Configuring Data Source
Host
- Period [in Seconds]: How frequently data is gathered. The period should be between 60 seconds – 3000 seconds.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| All vuSmartMaps IPs | IP address of the device | - | ICMP | Bidirectional |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
ICMP must be enabled in the target devices. Allow ICMP echo request and response packets between vuSmartMaps server and the target devices in network firewalls between them.
Configuration Steps
Enablethe O11ySource.- Select the Sources tab and press the
+button to add a new instance of the device to be monitored. - Add 'Host' and 'Period' as per requirement.
- Click on
Save and Continueto create the instance.
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| @timestamp | The original timestamp as a string, typically the raw timestamp when the event was logged. | String |
| timestamp | The timestamp with precise date and time (up to fractional seconds) indicating when the event occurred. | DateTime64 |
| name | Name of the event, process, or entity being logged. | String |
| url | URL associated with the event, often referring to the resource or endpoint involved. | String |
| type | Type of event or entity, indicating its category or classification. | String |
| target_state | The desired or expected state of the target (e.g., up, down, active). | LowCardinality(String) |
| target | The specific target involved in the event (e.g., IP address, service name). | String |
| host | Hostname or IP address where the event was generated or logged. | String |
| tenant_id | Identifier for the tenant, useful in multi-tenant environments to distinguish between different clients. | LowCardinality(String) |
| bu_id | Business Unit identifier, indicating the division or unit responsible for the event or asset. | LowCardinality(String) |
| o11ysource_name | Name of the virtual block or segment, typically used in storage or networking contexts. | LowCardinality(String) |
| vublock_name | Name of the virtual block or segment, typically used in storage or networking contexts. | LowCardinality(String) |
| topic_name | Name of the topic, often related to messaging systems like Kafka or similar. | LowCardinality(String) |
| application_name | Name of the application that is being logged or monitored. | String |
| business_hour | Indicates whether the event occurred during business hours (e.g., yes, no). | LowCardinality(String) |
| opi_value | A performance indicator value (OPI could stand for Operational Performance Indicator). | Float32 |
| percent_packet_loss | The percentage of packet loss during transmission. | Float32 |
| percent_transmitted | The percentage of packets successfully transmitted. | Float32 |
| result_code | Numeric code representing the result or outcome of the event (e.g., HTTP status code). | Float32 |
| packets_received | The number of packets successfully received. | Float32 |
| session_id | Unique identifier for the session during which the event occurred. | String |
| UpTimePct | Percentage of uptime for the monitored service or resource. | Float32 |
| average_rtt | The average round-trip time (RTT) for packets during the session. | Float32 |
| maximum_rtt | The maximum round-trip time recorded during the session. | Float32 |
| minimum_rtt | The minimum round-trip time recorded during the session. | Float32 |
| pkt_loss_pct | Percentage of packet loss calculated during the event. | Float32 |
| DownTimePct | Percentage of downtime for the monitored service or resource. | Float32 |
| DownTime | Total duration of downtime in seconds or milliseconds. | Float64 |
| jitter | Variation in packet arrival time, which can affect network performance. | Float64 |
| port | Network port associated with the event, indicating the communication channel used. | UInt32 |
