Skip to content

Commit df112ee

Browse files
authored
Merge pull request #272 from VirtualMetric:DT-447-1-5-1-release-notes
DT-447-1-5-1-release-notes
2 parents b54721f + 6ef6547 commit df112ee

File tree

299 files changed

+68511
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

299 files changed

+68511
-3
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
authors: [release-team]
3+
tags: [release]
4+
title: Version 1.5.1 Released
5+
---
6+
7+
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.
8+
9+
{/* truncate */}
10+
11+
<Include id="release-1.5.1" />

docs/release-notes/v1.5.1.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
sidebar_label: v1.5.1
3+
title: Version 1.5.1
4+
---
5+
6+
<Include id="release-1.5.1" />

includes.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"release-1.3.0": "release-1.3.0.mdx",
2424
"release-1.4.0": "release-1.4.0.mdx",
2525
"release-1.5.0": "release-1.5.0.mdx",
26+
"release-1.5.1": "release-1.5.1.mdx",
2627

2728
"templates-cannot-be-reinstalled": "templates-cannot-be-reinstalled.mdx",
2829
"timezone-settings": "timezone-settings.mdx",

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "virtualmetric-docs",
3-
"version": "1.5.0",
3+
"version": "1.5.1",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -479,6 +479,7 @@ const sidebars: SidebarsConfig = {
479479
label: 'Release Notes',
480480
collapsible: false,
481481
items: [
482+
"release-notes/v1.5.1",
482483
"release-notes/v1.5.0",
483484
"release-notes/v1.4.0",
484485
"release-notes/v1.3.0",

src/includes/release-1.5.1.mdx

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## :wrench: Improvements
2+
3+
### Content Hub Enhancements
4+
5+
- **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.
6+
7+
- **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.
8+
9+
### User Interface
10+
11+
- **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.
12+
13+
## :bug: Bug Fixes
14+
15+
### Documentation and Navigation
16+
17+
- **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.
18+
19+
### Device Management
20+
21+
- **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.
22+
23+
- **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.
24+
25+
### Interface Functionality
26+
27+
- **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.
28+
29+
- **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.
30+
31+
---
32+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
sidebar_label: Applications
3+
---
4+
5+
# Applications
6+
7+
**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:
8+
9+
## VirtualMetric Director&trade;
10+
11+
**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.
12+
13+
**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.
14+
15+
Key capabilities include:
16+
17+
* **Source Management** - support for multiple protocols (TCP, UDP, HTTP), file system monitoring, database change tracking, API integration, custom source implementations
18+
* **Multi-Schema Data Transformation** - real-time processing with ASIM, OCSF, ECS, and CIM schema support, format conversion, field extraction, data enrichment, custom transformation rules
19+
* **Intelligent Routing** - dynamic destination selection across Microsoft Sentinel, AWS Security Lake, Elasticsearch, and Splunk, load balancing, failover handling, priority-based routing, conditional routing
20+
* **Monitoring and Control** - real-time pipeline visibility, performance metrics, health monitoring, alert management, configuration validation
21+
22+
**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.
23+
24+
## VirtualMetric Agent&trade;
25+
26+
**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.
27+
28+
**Agent** is engineered with efficiency and reliability in mind, offering robust data collection without compromising system performance or stability.
29+
30+
Key features include:
31+
32+
* **Efficient Collection** - low resource utilization, minimal CPU and memory footprint, optimized disk I/O, configurable collection intervals, adaptive rate limiting
33+
* **Reliable Processing** - local buffering, crash recovery, data persistence, automatic reconnection, error handling
34+
* **Flexible Integration** - multiple source types support, custom collector plugins, format adaptation, protocol conversion, destination selection
35+
* **Advanced Monitoring** - self-diagnostics, performance metrics and health status reporting, resource usage tracking, alert generation
36+
37+
**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.
38+
39+
## VirtualMetric Director Proxy&trade;
40+
41+
**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.
42+
43+
**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.
44+
45+
Key capabilities include:
46+
47+
* **Secure Data Reception** - receives highly compressed data streams from **VirtualMetric Director**, token-based authentication (JWT-compatible), encrypted communication channels, automatic decompression and processing
48+
* **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
49+
* **Multi-Destination Support** - intelligent routing to Microsoft Sentinel, Microsoft Sentinel data lake, Azure Data Explorer and Azure Blob Storage based on Director instructions
50+
* **MSSP-Optimized Architecture** - tenant isolation and security, token-based tenant authentication, centralized management for MSSPs, no credential sharing required
51+
52+
### MSSP Deployment Model
53+
54+
**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.
55+
56+
**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.
57+
58+
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.
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
sidebar_label: Architecture
3+
---
4+
5+
# Architecture
6+
7+
**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.
8+
9+
<img src="/img/virtualmetric-datastream-architecture.png" alt="VirtualMetric DataStream - Enterprise Architecture Overview"/>
10+
11+
## Security-First Architecture
12+
13+
### Data Plane vs Control Plane Separation
14+
15+
**DataStream** employs a strict separation between data plane and control plane operations, ensuring your sensitive security data never leaves your environment:
16+
17+
**Control Plane (VirtualMetric Cloud)**
18+
- Multi-tenant SaaS platform for centralized management
19+
- Pipeline configuration and deployment
20+
- Fleet management across all Directors and Agents
21+
- Real-time statistics, monitoring, and alerting
22+
- Role-Based Access Control (RBAC) for team collaboration
23+
- Zero data processing or storage of customer logs
24+
25+
**Data Plane (Customer Environment)**
26+
- All data processing occurs within customer-controlled infrastructure
27+
- Director processes, transforms, and routes data locally
28+
- Agents collect data and communicate directly with local Director
29+
- No customer data transmission to VirtualMetric Cloud
30+
- Complete data sovereignty and compliance control
31+
32+
### Enterprise Security Benefits
33+
34+
This architecture addresses critical enterprise security concerns:
35+
36+
**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.
37+
38+
**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.
39+
40+
**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.
41+
42+
**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.
43+
44+
**Bandwidth Optimization** - Processes data locally before routing to destinations, eliminates unnecessary raw data transmission, and provides intelligent compression and filtering capabilities.
45+
46+
## Deployment Architecture
47+
48+
### VirtualMetric Cloud (Multi-Tenant)
49+
50+
The centralized management platform provides:
51+
- **Management Interface** - Intuitive web-based console for pipeline configuration and monitoring
52+
- **Statistics & Analytics** - Real-time performance metrics, data flow visualization, and operational insights
53+
- **RBAC & Security** - Granular access controls, audit logging, and secure authentication
54+
- **Fleet Management** - Centralized deployment and configuration management across distributed environments
55+
56+
### Customer Environment Options
57+
58+
**VirtualMetric Director** can be deployed in multiple configurations to meet diverse enterprise requirements:
59+
60+
#### Clustered Director (High Availability)
61+
62+
- **Load Balancing** - Distributes processing load across multiple Director instances
63+
- **Automatic Failover** - Ensures continuous operation during maintenance or failures
64+
- **Scalable Processing** - Handles enterprise-scale data volumes with horizontal scaling
65+
- **Shared Configuration** - Synchronized pipeline configurations across cluster nodes
66+
67+
#### Flexible Deployment Models
68+
69+
**On-Premises Deployment**
70+
- Physical servers or virtual machines within customer data centers
71+
- Complete isolation from external networks if required
72+
- Integration with existing infrastructure and security controls
73+
74+
**Cloud Deployment**
75+
- Customer-owned Azure, AWS, or other cloud environments
76+
- Maintains data sovereignty within customer cloud tenants
77+
- Leverages cloud-native services while preserving security isolation
78+
79+
**Hybrid Deployment**
80+
- Directors in both on-premises and cloud environments
81+
- Unified management through single control plane
82+
- Flexible data routing based on location and requirements
83+
84+
### Container and Serverless Support
85+
86+
**Docker Containerization**
87+
- Lightweight, portable deployment across environments
88+
- Simplified installation and maintenance
89+
- Container orchestration support (Kubernetes, Docker Swarm)
90+
- Consistent runtime environment across platforms
91+
92+
**Azure Serverless Integration**
93+
- **Director Proxy** - Azure Function-based secure data forwarding
94+
- Automatic scaling based on data volume
95+
- Pay-per-use cost optimization
96+
97+
## Network Communication
98+
99+
### Simplified Network Requirements
100+
101+
**Outbound HTTPS (Director to VirtualMetric Cloud)**
102+
- Single port 443 connection for management communications
103+
- Control plane synchronization and configuration updates
104+
- Statistics reporting and health monitoring
105+
- Secure token-based authentication
106+
107+
**Internal HTTPS (Agents to Director)**
108+
- Direct communication between Agents and local Director
109+
- No external connectivity required for Agents
110+
- Secure data transmission within customer environment
111+
- Simplified firewall configuration
112+
113+
### Zero Inbound Connectivity
114+
115+
**DataStream** requires no inbound connections from external networks, eliminating common security vulnerabilities:
116+
- No firewall rules for external access to internal systems
117+
- Reduced exposure to external threats
118+
- Simplified compliance and security auditing
119+
- Enhanced network security posture
120+
121+
## Management Models
122+
123+
### Managed (Default)
124+
125+
- **Centralized Configuration** - Manage all pipelines through VirtualMetric portal
126+
- **Automatic Updates** - Seamless deployment of configuration changes and updates
127+
- **Real-Time Monitoring** - Comprehensive visibility across distributed infrastructure
128+
- **Collaborative Management** - Team-based access with RBAC controls
129+
130+
### Self-Managed (Air-Gapped)
131+
132+
For environments requiring complete network isolation:
133+
134+
- **Offline Configuration** - Manual pipeline configuration and deployment
135+
- **Local Management** - Direct access to Director management interfaces
136+
- **Manual Updates** - Administrator-controlled updates and maintenance
137+
- **Complete Isolation** - Zero external connectivity requirements
138+
139+
### Benefits for Enterprise Environments
140+
141+
**Operational Efficiency**
142+
- Centralized management of distributed telemetry infrastructure
143+
- Reduced operational overhead with automated configuration deployment
144+
- Comprehensive monitoring and alerting capabilities
145+
- Streamlined troubleshooting and performance optimization
146+
147+
**Security & Compliance**
148+
- Data never leaves customer-controlled environment
149+
- Simplified compliance with industry regulations
150+
- Reduced risk of data breaches and unauthorized access
151+
- Enhanced audit trail and governance capabilities
152+
153+
**Scalability & Performance**
154+
- High availability and clustering support for mission-critical environments
155+
- Horizontal scaling to handle growing data volumes
156+
- Intelligent load balancing and resource optimization
157+
- Container and serverless deployment flexibility
158+
159+
**Cost Optimization**
160+
- Eliminates costs associated with third-party data processing
161+
- Reduces bandwidth requirements through local processing
162+
- Flexible deployment models to optimize infrastructure costs
163+
- Pay-per-use serverless options for variable workloads

0 commit comments

Comments
 (0)