Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions blog/2025-10-31-release-notes-1.5.1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
authors: [release-team]
tags: [release]
title: Version 1.5.1 Released
---

This release focuses on usability improvements and important bug fixes. The **Content Hub** receives significant enhancements with improved content format display and expanded filtering options, while the **Pipeline search** functionality is now more flexible. Critical fixes address documentation links, device notifications, IP address display issues, and interface functionality across Quick Routes and language support features.

{/* truncate */}

<Include id="release-1.5.1" />
6 changes: 6 additions & 0 deletions docs/release-notes/v1.5.1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_label: v1.5.1
title: Version 1.5.1
---

<Include id="release-1.5.1" />
1 change: 1 addition & 0 deletions includes.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"release-1.3.0": "release-1.3.0.mdx",
"release-1.4.0": "release-1.4.0.mdx",
"release-1.5.0": "release-1.5.0.mdx",
"release-1.5.1": "release-1.5.1.mdx",

"templates-cannot-be-reinstalled": "templates-cannot-be-reinstalled.mdx",
"timezone-settings": "timezone-settings.mdx",
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "virtualmetric-docs",
"version": "1.5.0",
"version": "1.5.1",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,7 @@ const sidebars: SidebarsConfig = {
label: 'Release Notes',
collapsible: false,
items: [
"release-notes/v1.5.1",
"release-notes/v1.5.0",
"release-notes/v1.4.0",
"release-notes/v1.3.0",
Expand Down
31 changes: 31 additions & 0 deletions src/includes/release-1.5.1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## :wrench: Improvements

### Content Hub Enhancements

- **Content Format Conversion** - Content display converted from JSON to string format for significantly improved readability and usability. Comments within content are now visible, providing descriptive context and making information easier to understand. This enhancement offers better clarity when reviewing content, enabling more efficient data workflows and informed decision-making.

- **Enhanced Filtering Options** - Content Hub filtering capabilities expanded with additional device types and vendors. Enhanced filtering makes it easier to locate and filter relevant content, improving navigation efficiency and helping users quickly find specific configurations for their devices and vendor products.

### User Interface

- **Pipeline Search Character Limit Removal** - Removed character limit restrictions in Pipeline search functionality that were preventing searches from being performed. Search feature now operates properly regardless of query length, enabling comprehensive pipeline discovery without limitations.

## :bug: Bug Fixes

### Documentation and Navigation

- **Documentation Link Corrections** - Fixed incorrect documentation links throughout the platform. All documentation references now direct users to correct pages, improving accessibility and facilitating greater utilization of documentation resources for enhanced user support and guidance.

### Device Management

- **Windows and Linux Device Notifications** - Resolved issue with incorrect notifications on Windows and Linux devices. Notifications now display accurate information, providing reliable alerts and status updates for monitored systems and ensuring proper visibility into device health and events.

- **Windows Device IP Address Display** - Fixed issue where IP addresses were appearing empty for some Windows devices. All Windows devices now properly display their IP addresses, providing complete visibility and easier identification of monitored systems across the infrastructure.

### Interface Functionality

- **Quick Routes Table Enhancements** - Corrected missing columns and filtering issues in Quick Routes device and target selection tables. All relevant columns now display correctly, and filtering functionality operates as expected, streamlining route selection and configuration processes.

- **Language Support Corrections** - Resolved issues where language support was not functioning properly in certain platform areas. All language-related features now work as expected, ensuring consistent multilingual experience across the interface for international users.

---
58 changes: 58 additions & 0 deletions versioned_docs/version-1.5.0/about/applications.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
sidebar_label: Applications
---

# Applications

**VirtualMetric DataStream** is a telemetry pipeline solution that simplifies data collection, processing, and routing for multiple platforms including _Microsoft Sentinel_, _AWS Security Lake_, _Elasticsearch_, _Splunk_, and other security analytics platforms. At its core, **DataStream** uses pipelines to process, enrich, and direct data flows to their optimal destinations. It is composed of the following components:

## VirtualMetric Director&trade;

**VirtualMetric Director** is a comprehensive platform designed for listening on various data sources, extracting and transforming them, and routing the data to multiple destinations across different security platforms. This powerful component acts as the central nervous system of your pipeline, orchestrating the flow across your entire infrastructure with multi-schema support.

**Director** provides a unified interface for managing multiple sources and destinations, enabling seamless data collection, transformation, and distribution across ASIM, OCSF, ECS, CIM, and UDM formats. Its architecture is built to handle enterprise-scale data volumes at high levels of performance and reliability.

Key capabilities include:

* **Source Management** - support for multiple protocols (TCP, UDP, HTTP), file system monitoring, database change tracking, API integration, custom source implementations
* **Multi-Schema Data Transformation** - real-time processing with ASIM, OCSF, ECS, and CIM schema support, format conversion, field extraction, data enrichment, custom transformation rules
* **Intelligent Routing** - dynamic destination selection across Microsoft Sentinel, AWS Security Lake, Elasticsearch, and Splunk, load balancing, failover handling, priority-based routing, conditional routing
* **Monitoring and Control** - real-time pipeline visibility, performance metrics, health monitoring, alert management, configuration validation

**Director**'s flexible architecture allows it to adapt to changing requirements. Whether you're collecting logs from applications, monitoring system metrics, or gathering security events, **Director** provides the necessary tools to ensure efficient data handling and delivery across multiple security platforms.

## VirtualMetric Agent&trade;

**VirtualMetric Agent** is a lightweight, high-performance data collection component designed to gather telemetry data from various sources while maintaining minimal system impact. This versatile agent serves as the first point of contact in the telemetry pipeline, ensuring reliable data collection and initial processing.

**Agent** is engineered with efficiency and reliability in mind, offering robust data collection without compromising system performance or stability.

Key features include:

* **Efficient Collection** - low resource utilization, minimal CPU and memory footprint, optimized disk I/O, configurable collection intervals, adaptive rate limiting
* **Reliable Processing** - local buffering, crash recovery, data persistence, automatic reconnection, error handling
* **Flexible Integration** - multiple source types support, custom collector plugins, format adaptation, protocol conversion, destination selection
* **Advanced Monitoring** - self-diagnostics, performance metrics and health status reporting, resource usage tracking, alert generation

**Agent**'s architecture ensures seamless data collection and transmission while providing robust monitoring and management capabilities. Its modular design allows for easy extension and customization to meet specific organizational needs. It can operate both independently and as part of a larger telemetry infrastructure, making it suitable for various deployment scenarios, from single-server installations to large-scale distributed environments.

## VirtualMetric Director Proxy&trade;

**VirtualMetric Director Proxy** is a secure, lightweight forwarding component designed to operate within customer environments, whether on-premises or in their own cloud infrastructure. This strategic component enables secure data delivery to customer-owned destinations while maintaining complete isolation of customer credentials and infrastructure access.

**Director Proxy** serves as the secure bridge between **VirtualMetric Director** and customer destinations, providing a perfect solution for Managed Security Service Providers (MSSPs) managing multiple customer environments without requiring access to customer credentials or infrastructure.

Key capabilities include:

* **Secure Data Reception** - receives highly compressed data streams from **VirtualMetric Director**, token-based authentication (JWT-compatible), encrypted communication channels, automatic decompression and processing
* **Azure Managed Identity Integration** - native Azure Managed Identity support for secure destination access, eliminates credential management overhead, seamless integration with Azure services, automatic token refresh and management
* **Multi-Destination Support** - intelligent routing to Microsoft Sentinel, Microsoft Sentinel data lake, Azure Data Explorer and Azure Blob Storage based on Director instructions
* **MSSP-Optimized Architecture** - tenant isolation and security, token-based tenant authentication, centralized management for MSSPs, no credential sharing required

### MSSP Deployment Model

**Director Proxy** enables a streamlined MSSP workflow where each customer tenant installs the proxy within their environment and shares only the proxy endpoint address and authentication token with the MSSP. The MSSP operates **VirtualMetric Director** centrally, processing and routing data for multiple customers without ever accessing customer credentials or infrastructure.

**Director** sends destination routing instructions and processed data to **Director Proxy** via secure HTTP requests. **Director Proxy** handles all final delivery using customer-owned Azure Managed Identity credentials, ensuring complete security isolation and compliance with customer data sovereignty requirements.

This architecture provides enterprise-grade security, simplified credential management, scalable multi-tenant support, and complete customer control over data destinations while enabling efficient MSSP operations.
163 changes: 163 additions & 0 deletions versioned_docs/version-1.5.0/about/architecture.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
---
sidebar_label: Architecture
---

# Architecture

**VirtualMetric DataStream** is architected with enterprise security and data sovereignty as core principles. Unlike traditional solutions that require sending sensitive data to third-party cloud platforms for processing, **DataStream** keeps all your critical data within your environment while providing centralized management and visibility through a secure cloud control plane.

<img src="/img/virtualmetric-datastream-architecture.png" alt="VirtualMetric DataStream - Enterprise Architecture Overview"/>

## Security-First Architecture

### Data Plane vs Control Plane Separation

**DataStream** employs a strict separation between data plane and control plane operations, ensuring your sensitive security data never leaves your environment:

**Control Plane (VirtualMetric Cloud)**
- Multi-tenant SaaS platform for centralized management
- Pipeline configuration and deployment
- Fleet management across all Directors and Agents
- Real-time statistics, monitoring, and alerting
- Role-Based Access Control (RBAC) for team collaboration
- Zero data processing or storage of customer logs

**Data Plane (Customer Environment)**
- All data processing occurs within customer-controlled infrastructure
- Director processes, transforms, and routes data locally
- Agents collect data and communicate directly with local Director
- No customer data transmission to VirtualMetric Cloud
- Complete data sovereignty and compliance control

### Enterprise Security Benefits

This architecture addresses critical enterprise security concerns:

**Data Sovereignty** - All sensitive log data remains within your infrastructure, ensuring compliance with data residency requirements, industry regulations (GDPR, HIPAA, SOX), and corporate data governance policies.

**Minimal Attack Surface** - Only a single HTTPS outbound connection required from Director to VirtualMetric Cloud for management, no inbound connections needed, and agents communicate exclusively with local Director infrastructure.

**Zero Third-Party Data Exposure** - Raw log data never transmitted to external vendors, eliminates risks of data breaches during transit, and maintains complete control over sensitive security information.

**Network Security** - Reduced firewall complexity with minimal external connections, no need to open firewall access from cloud to local systems, and simplified network security management.

**Bandwidth Optimization** - Processes data locally before routing to destinations, eliminates unnecessary raw data transmission, and provides intelligent compression and filtering capabilities.

## Deployment Architecture

### VirtualMetric Cloud (Multi-Tenant)

The centralized management platform provides:
- **Management Interface** - Intuitive web-based console for pipeline configuration and monitoring
- **Statistics & Analytics** - Real-time performance metrics, data flow visualization, and operational insights
- **RBAC & Security** - Granular access controls, audit logging, and secure authentication
- **Fleet Management** - Centralized deployment and configuration management across distributed environments

### Customer Environment Options

**VirtualMetric Director** can be deployed in multiple configurations to meet diverse enterprise requirements:

#### Clustered Director (High Availability)

- **Load Balancing** - Distributes processing load across multiple Director instances
- **Automatic Failover** - Ensures continuous operation during maintenance or failures
- **Scalable Processing** - Handles enterprise-scale data volumes with horizontal scaling
- **Shared Configuration** - Synchronized pipeline configurations across cluster nodes

#### Flexible Deployment Models

**On-Premises Deployment**
- Physical servers or virtual machines within customer data centers
- Complete isolation from external networks if required
- Integration with existing infrastructure and security controls

**Cloud Deployment**
- Customer-owned Azure, AWS, or other cloud environments
- Maintains data sovereignty within customer cloud tenants
- Leverages cloud-native services while preserving security isolation

**Hybrid Deployment**
- Directors in both on-premises and cloud environments
- Unified management through single control plane
- Flexible data routing based on location and requirements

### Container and Serverless Support

**Docker Containerization**
- Lightweight, portable deployment across environments
- Simplified installation and maintenance
- Container orchestration support (Kubernetes, Docker Swarm)
- Consistent runtime environment across platforms

**Azure Serverless Integration**
- **Director Proxy** - Azure Function-based secure data forwarding
- Automatic scaling based on data volume
- Pay-per-use cost optimization

## Network Communication

### Simplified Network Requirements

**Outbound HTTPS (Director to VirtualMetric Cloud)**
- Single port 443 connection for management communications
- Control plane synchronization and configuration updates
- Statistics reporting and health monitoring
- Secure token-based authentication

**Internal HTTPS (Agents to Director)**
- Direct communication between Agents and local Director
- No external connectivity required for Agents
- Secure data transmission within customer environment
- Simplified firewall configuration

### Zero Inbound Connectivity

**DataStream** requires no inbound connections from external networks, eliminating common security vulnerabilities:
- No firewall rules for external access to internal systems
- Reduced exposure to external threats
- Simplified compliance and security auditing
- Enhanced network security posture

## Management Models

### Managed (Default)

- **Centralized Configuration** - Manage all pipelines through VirtualMetric portal
- **Automatic Updates** - Seamless deployment of configuration changes and updates
- **Real-Time Monitoring** - Comprehensive visibility across distributed infrastructure
- **Collaborative Management** - Team-based access with RBAC controls

### Self-Managed (Air-Gapped)

For environments requiring complete network isolation:

- **Offline Configuration** - Manual pipeline configuration and deployment
- **Local Management** - Direct access to Director management interfaces
- **Manual Updates** - Administrator-controlled updates and maintenance
- **Complete Isolation** - Zero external connectivity requirements

### Benefits for Enterprise Environments

**Operational Efficiency**
- Centralized management of distributed telemetry infrastructure
- Reduced operational overhead with automated configuration deployment
- Comprehensive monitoring and alerting capabilities
- Streamlined troubleshooting and performance optimization

**Security & Compliance**
- Data never leaves customer-controlled environment
- Simplified compliance with industry regulations
- Reduced risk of data breaches and unauthorized access
- Enhanced audit trail and governance capabilities

**Scalability & Performance**
- High availability and clustering support for mission-critical environments
- Horizontal scaling to handle growing data volumes
- Intelligent load balancing and resource optimization
- Container and serverless deployment flexibility

**Cost Optimization**
- Eliminates costs associated with third-party data processing
- Reduces bandwidth requirements through local processing
- Flexible deployment models to optimize infrastructure costs
- Pay-per-use serverless options for variable workloads
Loading