User Documentation
  • Product Information
    • Overview
    • Architecture
    • Security
    • Key Features
    • Supported Systems
    • Comparison
  • Installation
    • Download VirtualMetric
    • Install a VirtualMetric Server
    • Activate Product
    • Update From Previous Versions
    • Uninstall VirtualMetric
  • Releases
    • Version 8.0.3
  • Server Pre-Configuration
    • Windows
    • VMware
    • Linux
    • Bare Metal Hardware
  • Settings
    • Users
      • User Operations
        • Add New User
        • Edit User
        • Device Permissions
        • Login as Other User
        • Remove User
      • User Group Operations
        • Add New User Group
        • Assign Member
        • Device Permission
        • Edit User Group
        • Remove User Group
      • API Users Operations
        • Add New API User
        • Edit API User
        • Device Permission
        • Remove API User
      • Organization Operations
        • Add New Organization
        • Edit Organization
        • Device Permission
        • Login as Other Organization
        • Remove Organization
      • Credential Store
        • Add New Credential Store
        • Edit Credential Store
        • Remove Credential Store
      • Group Based AD Authentication
    • Devices
      • Server Operations
        • Add New Server
        • Assign Module
        • Edit Server
        • Remove Server
        • Restore Server
        • Connectivity Issues
        • Bulk Update
      • Cluster Operations
        • Add New Cluster
        • Assign Module
        • Sync a Cluster
        • Edit Cluster
        • Remove Cluster
        • Connectivity Issues
        • Bulk Update
      • Workstation Operations
        • Add New Workstation
        • Edit Workstation
        • Remove Workstation
      • Manager Operations
        • Add New Manager
        • Assign Module
        • Sync Manager
        • Edit Manager
        • Remove Manager
        • Connectivity Issues
        • Bulk Update
      • Network Devices Operations
        • Add Network Device
        • Edit Network Device
        • Remove Network Device
        • Connectivity Issues
        • Bulk Update
      • Trigger Operations
        • Add New Trigger
        • Assign Server
        • Edit Trigger
        • Change API User
        • Change Service User
        • Remove Trigger
        • Enable Debug
      • Device Group Operations
        • Add New Device Group
        • Assign Member
        • Edit Device Group
        • Remove Device Group
      • Datacenter Operations
        • Add New Datacenter
        • Assign Member
        • Edit Datacenter
        • Remove Datacenter
      • Permission Operations
        • Add/Remove Permission
    • Listeners
      • Listener Operations
        • Add a New Listener
          • Add a Syslog Listener
          • Add a Flow Endpoints
          • Add a eStreamer
          • Add a TFTP Listener
          • Add a TCP Listener
          • Add a UDP Listener
          • Add a HTTP Listener
          • Add a SMTP Listener
          • Add a SNMP Trap Listener
          • Add a Redis Consumer
          • Add a Kafka Consumer
          • Add a RabbitMQ Consumer
          • Add a NATS Consumer
        • Edit Listener
        • Remove Listener
    • Services
      • Location Operations
        • Add new Location
        • Edit Location
        • Remove Location
      • Web Sites Operations
        • Add new Website
        • Assign Location
        • Edit Web Sites
        • Remove Web Sites
      • DNS Operations
        • Add new DNS
        • Edit DNS
        • Remove DNS
      • ICMP Operations
        • Add new ICMP
        • Edit ICMP
        • Remove ICMP
      • IPAM Operations
        • Add new IPAM
        • Edit IPAM
        • Remove IPAM
      • TCP Operations
        • Add new TCP
        • Edit TCP
        • Remove TCP
      • Database Operations
        • Add new Database
        • Edit Database
        • Remove Database
    • Notifications
      • Rules Operations
        • Add new Rules
        • Edit Rule
        • Adding Dependency
        • Filtering Rules
        • Assign Action
        • Remove Rule
      • Knowledge Base Operations
        • Add new Knowledge Base
        • Edit Knowledge Base
        • Remove Knowledge Base
      • Action Operations
        • Add new Action
        • Testing Action
        • Edit Action
        • Remove Action
      • Scheduled Report Operation
        • Edit Scheduled Report
        • Remove Scheduled Report
      • STMP Settings
      • SMS Settings
    • Collectors
      • Definitions Operations
      • Module Defaults Operations
      • Device Bindings Operations
    • Logs
      • Definitions Operations
        • Understand Definition Fields
        • Edit Definition
        • Bulk Update
        • Reset Definition
      • Custom Definition Operations
        • Add Custom Definition
        • Edit Custom Definition
        • Remove Custom Definition
      • Module Defaults
        • Assign Definition
        • Reset Module Defaults
      • Device Bindings
        • Assign Definition
        • Reset Device Bindings
    • Statistics
      • Logging Types
        • Understanding Logging Types
        • Edit Logging Type
        • Reset Logging Type
      • System Counters
        • Understanding System Counter
        • Edit System Counter
        • Reset System Counter
      • Custom Counters
        • Understanding Custom Counter
        • Edit Custom Counter
        • Reset Custom Counter
    • Systems
      • System Logs
      • System Health
      • Advanced Settings
    • Azure Active Directory Integration
  • Dashboard
    • Main Page
    • Login
    • Layout and Common Functions
    • Calculation of Recommendations
    • Add New Widget
    • Edit Widget
    • Charts
    • White Labeling
  • Devices
    • Layout and Common Functions
  • Analytics
    • Layout and Common Functions
  • Modules and Audit
    • VirtualMetric Modules
      • Bare Metal
      • Microsoft Hyper-V
      • VMware
      • Microsoft IIS
      • Microsoft SQL
      • Microsoft Storage Spaces
      • Active Directory User Permissions
    • Audit Configuration
Powered by GitBook
On this page
  • VirtualMetric API
  • VirtualMetric Dashboard
  • VirtualMetric Database
  • VirtualMetric Triggers
  • VirtualMetric Observer
  1. Product Information

Architecture

PreviousOverviewNextSecurity

Last updated 6 months ago

All VirtualMetric components work on the Windows platform and use Microsoft technologies that you are already familiar with.


VirtualMetric API

You can access the API from your web browser. The default port for the API is 8080.

http://localhost:8080

VirtualMetric Dashboard

VirtualMetric Dashboard serves as the HTML-based web interface for accessing VirtualMetric. It enables server configuration, notification setup, monitoring result review, and report creation. This interface offers high interactivity, leveraging Javascript to deliver a powerful and user-friendly experience. When logged in, the VirtualMetric Dashboard continuously refreshes data on the screen (via Ajax calls) to display real-time monitoring results (with a customizable refresh interval). For its web server role, the dashboard utilizes Microsoft IIS Server. The default port is 80.

http://localhost

VirtualMetric Database

VirtualMetric Database is the main datastore holding all inventory and monitoring data. VirtualMetric Database is the most critical component of the system. If it becomes unresponsive, you will not be able to send queries via the API. The database uses Clickhouse as its data store.


VirtualMetric Triggers

VirtualMetric Triggers are the main components connecting servers, clusters, and managers for monitoring and inventory collection. These components open the required TCP connections to initialize the collector processes, and therefore are also referred to as Collectors. You can install multiple VirtualMetric Triggers to monitor the servers in isolated networks like NAT, NVGRE, Virtual Networks, etc.


VirtualMetric Observer

VirtualMetric Observer is the notification component of the system. This component connects to the API to process active notification queues and execute notification actions.

All VirtualMetric components utilize the VirtualMetric API to communicate with the VirtualMetric database. The API also has an additional authentication layer called . All performance and inventory queries, authentication, dashboard, and monitoring operations are processed through this API which uses Microsoft IIS Server for the web server role.

If the API stops, all operations, including Dashboard logins and monitoring, will fail. However, the notification system will continue to function directly from the VirtualMetric Database through VirtualMetric SQL Jobs. Even when the API is offline, you will continue to receive notifications. To address issues with the API, you can refer to the section for troubleshooting.

You can change the default API port during set up. Please check the section for details. You can also read the section for information on changing the port later.

OWIN
Maintenance
Installation
Maintenance