@mithung/vunet-mcp-server 2.0.8 → 2.1.0

package/DATA_MODELS.md

@@ -1,467 +0,0 @@
-# Vunet Data Models Reference
-
-This document lists common data models available in Vunet vuSmartMaps tenants. Use these names with the `vunet_query_metric` tool.
-
-> **Note:** Actual available models depend on your tenant configuration. Use the `vunet_list_data_models` tool to get the curated list programmatically.
-
-## Application Performance Monitoring (APM)
-
-### Traces & Transactions
-- `Trace Map Data` - Individual trace spans with detailed timing, status codes, and attributes
-- `Traces Transaction Volume` - Aggregated transaction counts and statistics
-- `Application Response Time` - Response time metrics across services
-- `Error Rate` - Error tracking and failure analysis
-- `Service Dependencies` - Service-to-service relationships
-- `Endpoint Performance` - API endpoint metrics
-
-### Application Metrics
-- `JVM Metrics` - Java Virtual Machine statistics
-- `Thread Pool Metrics` - Thread utilization
-- `GC Metrics` - Garbage collection performance
-- `Hibernate Query Performance` - ORM query performance
-- `Cache Hit Ratio` - Cache effectiveness metrics
-
-## Infrastructure Monitoring
-
-### Kubernetes
-- `Kubernetes Pod Metrics` - Pod-level resource usage and health
-- `Kubernetes Node Metrics` - Node-level system metrics
-- `Kubernetes Deployment Metrics` - Deployment status and scaling
-- `Kubernetes Service Metrics` - Service mesh metrics
-- `Kubernetes Namespace Metrics` - Namespace-level aggregations
-- `Container Metrics` - Container resource consumption
-- `Kubernetes Events` - Cluster events and alerts
-
-### System Resources
-- `CPU Usage` - CPU utilization by host/process
-- `Memory Usage` - Memory consumption and availability
-- `Disk I/O` - Disk read/write operations
-- `Network I/O` - Network traffic metrics
-- `File System Usage` - Disk space utilization
-- `System Load` - System load averages
-
-### Servers
-- `Apache Metrics` - Apache web server statistics
-- `Nginx Metrics` - Nginx performance metrics
-- `Tomcat Metrics` - Tomcat application server metrics
-- `IIS Metrics` - Internet Information Services metrics
-
-## Database Monitoring
-
-### Relational Databases
-- `MySQL Performance` - MySQL query performance and connections
-- `MySQL Slow Queries` - Slow query analysis
-- `PostgreSQL Metrics` - PostgreSQL database metrics
-- `Oracle Metrics` - Oracle database performance
-- `SQL Server Metrics` - Microsoft SQL Server statistics
-- `Database Connection Pool` - Connection pool utilization
-
-### NoSQL Databases
-- `MongoDB Metrics` - MongoDB performance
-- `Redis Metrics` - Redis cache metrics
-- `Cassandra Metrics` - Cassandra cluster health
-- `Elasticsearch Metrics` - Elasticsearch search performance
-
-## Network Monitoring
-
-- `Network Latency` - Network response times
-- `Packet Loss` - Network packet loss statistics
-- `Bandwidth Usage` - Network bandwidth consumption
-- `TCP Connections` - TCP connection tracking
-- `DNS Query Performance` - DNS resolution metrics
-- `SSL Certificate Expiry` - Certificate monitoring
-
-## Business Metrics
-
-- `VuBank Metrics` - Custom business metrics (example tenant)
-- `Transaction Success Rate` - Business transaction success/failure
-- `User Sessions` - User session analytics
-- `Revenue Metrics` - Business revenue tracking
-- `Conversion Rate` - Conversion funnel metrics
-- `Customer Activity` - User engagement metrics
-
-## Log Analytics
-
-- `Application Logs` - Application log aggregations
-- `Error Logs` - Error and exception logs
-- `Security Logs` - Security event logs
-- `Audit Logs` - Audit trail logs
-- `Access Logs` - HTTP access logs
-
-## Security & Compliance
-
-- `Security Events` - Security incident tracking
-- `Failed Login Attempts` - Authentication failures
-- `Privileged Access` - Privileged user activity
-- `Vulnerability Scan Results` - Security scan findings
-- `Compliance Metrics` - Compliance status metrics
-
-## Custom & Integration
-
-- Custom data models defined in your tenant
-- Third-party integration metrics
-- Business-specific KPIs
-
----
-
-## Query Examples
-
-### Get Slow Traces (Last 24 Hours)
-```json
-{
-  "metric_name": "Trace Map Data",
-  "relative_time": "24h",
-  "filters": {
-    "span.duration": ">5000000"
-  }
-}
-```
-
-### Kubernetes Pod CPU Usage
-```json
-{
-  "metric_name": "Kubernetes Pod Metrics",
-  "relative_time": "1h",
-  "include": "pod_name,cpu_usage,namespace"
-}
-```
-
-### Database Query Performance
-```json
-{
-  "metric_name": "MySQL Performance",
-  "relative_time": "30m",
-  "filters": {
-    "query_time": ">1000"
-  }
-}
-```
-
-### Error Rate by Service
-```json
-{
-  "metric_name": "Error Rate",
-  "relative_time": "2h",
-  "filters": {
-    "service_name": "api-gateway"
-  }
-}
-```
-
----
-
-## Discovery Methods
-
-### 1. Use MCP Tool (Recommended)
-```
-vunet_list_data_models
-```
-
-### 2. Ask via Natural Language
-```
-"What data models are available?"
-"Show me all Kubernetes metrics"
-"List APM data models"
-```
-
-### 3. Query Specific Categories
-```
-"Show infrastructure metrics"
-"List database performance models"
-"What application metrics can I query?"
-```
-
----
-
-## Data Model Naming Conventions
-
-- **Spaces in Names**: Use exact names with spaces (e.g., `"Trace Map Data"`)
-- **Case Sensitive**: Names are case-sensitive
-- **Special Characters**: Some models may contain hyphens or underscores
-- **Tenant-Specific**: Custom models follow your organization's naming
-
-## Need Help?
-
-- Check your Vunet UI for available data models
-- Use `vunet_get_status` to verify connection
-- Contact Vunet support for custom model documentation
-
----
-
-## Real-World Use Cases
-
-### Use Case 1: Root Cause Analysis for Application Failures
-
-**Scenario:** VuBank fund transfer service failing with HTTP 401/500 errors
-
-**Data Models Used:**
-1. **Trace Map Data** - Identify service call chains and failure points
-2. **Kubernetes Pod Metrics** - Verify infrastructure health
-3. **Kubernetes Deployment Metrics** - Check deployment status
-
-**Query Workflow:**
-
-```json
-// Step 1: Get recent traces for failing service
-{
-  "metric_name": "Trace Map Data",
-  "relative_time": "1h",
-  "filters": {
-    "service.name": "ibmb-ib"
-  }
-}
-
-// Step 2: Verify backend service health
-{
-  "metric_name": "Kubernetes Pod Metrics",
-  "relative_time": "1h",
-  "filters": {
-    "namespace": "ibmb",
-    "pod_name": "ibmb-cbs*"
-  }
-}
-
-// Step 3: Check deployment status
-{
-  "metric_name": "Kubernetes Deployment Metrics",
-  "relative_time": "1h",
-  "filters": {
-    "deployment_name": "ibmb-cbs"
-  }
-}
-```
-
-**Outcome:** Identified CBS service returning HTTP 404 (missing REST endpoints) while infrastructure was healthy. See [USE_CASE_RCA.md](USE_CASE_RCA.md) for complete analysis.
-
----
-
-### Use Case 2: Performance Degradation Analysis
-
-**Data Models for Performance Investigation:**
-
-```json
-// Query slow traces
-{
-  "metric_name": "Trace Map Data",
-  "relative_time": "4h",
-  "filters": {
-    "span.duration": ">5000000"  // >5 seconds
-  }
-}
-
-// Check database performance
-{
-  "metric_name": "MySQL Performance",
-  "relative_time": "4h",
-  "filters": {
-    "query_time": ">1000"  // >1 second
-  }
-}
-
-// Verify resource utilization
-{
-  "metric_name": "Kubernetes Pod Metrics",
-  "relative_time": "4h",
-  "include": "pod_name,cpu_usage,memory_usage,namespace"
-}
-```
-
----
-
-### Use Case 3: Service Dependency Mapping
-
-**Trace Analysis for Microservices:**
-
-```json
-{
-  "metric_name": "Trace Map Data",
-  "relative_time": "24h",
-  "filters": {
-    "service.name": "api-gateway"
-  }
-}
-```
-
-**Insights Gained:**
-- Identify all downstream services called
-- Measure response times per service
-- Detect cascading failures
-- Map service-to-service relationships
-- Find bottleneck services
-
----
-
-### Use Case 4: Error Pattern Detection
-
-**Query Failed Requests:**
-
-```json
-// Get HTTP 500 errors
-{
-  "metric_name": "Trace Map Data",
-  "relative_time": "6h",
-  "filters": {
-    "http.status_code": "500"
-  }
-}
-
-// Get exceptions
-{
-  "metric_name": "Exception Data",
-  "relative_time": "6h",
-  "filters": {
-    "exception.type": "NullPointerException"
-  }
-}
-
-// Check error rate by service
-{
-  "metric_name": "Error Rate",
-  "relative_time": "6h",
-  "filters": {
-    "service_name": "payment-service"
-  }
-}
-```
-
----
-
-## Pro Tips for Effective Queries
-
-### 1. Time Range Selection
-
-**For Real-Time Issues:**
-- Use `15m` or `30m` for immediate problems
-- Quick feedback loop for troubleshooting
-
-**For Trend Analysis:**
-- Use `24h`, `7d`, or `30d` for patterns
-- Identify recurring issues
-
-**For Historical Investigation:**
-- Use absolute timestamps with `start_time` and `end_time`
-- Analyze specific incident windows
-
-### 2. Filter Best Practices
-
-**Be Specific:**
-```json
-// Good - specific service
-{"service.name": "payment-service"}
-
-// Too broad - all services
-{}
-```
-
-**Combine Filters:**
-```json
-{
-  "filters": {
-    "service.name": "api-gateway",
-    "http.status_code": ">=400",
-    "span.duration": ">3000000"
-  }
-}
-```
-
-### 3. Field Selection
-
-**Include only needed fields:**
-```json
-{
-  "include": "trace_id,service.name,http.status_code,span.duration"
-}
-```
-
-**Benefits:**
-- Faster query execution
-- Reduced data transfer
-- Easier analysis
-
-### 4. Pagination for Large Results
-
-```json
-{
-  "metric_name": "Trace Map Data",
-  "relative_time": "24h",
-  "limit": 100,
-  "offset": 0
-}
-```
-
----
-
-## Common Troubleshooting Scenarios
-
-### Scenario: "Why is my application slow?"
-
-**Investigation Steps:**
-1. Query `Trace Map Data` with `span.duration` filter
-2. Check `MySQL Performance` or `PostgreSQL Metrics`
-3. Verify `Kubernetes Pod Metrics` for resource constraints
-4. Review `JVM Metrics` for garbage collection issues
-
-### Scenario: "Service is down"
-
-**Investigation Steps:**
-1. Query `Kubernetes Pod Metrics` - Check pod status
-2. Query `Kubernetes Container Metrics` - Check for crashes
-3. Query `Trace Map Data` - Verify no successful requests
-4. Check `Error Logs` - Review exception details
-
-### Scenario: "Intermittent failures"
-
-**Investigation Steps:**
-1. Query `Trace Map Data` over longer period (6h-24h)
-2. Look for patterns in `http.status_code` distribution
-3. Check `Kubernetes Events` for pod restarts
-4. Review `Network Latency` metrics
-
-### Scenario: "Database queries are slow"
-
-**Investigation Steps:**
-1. Query `MySQL Slow Queries` or equivalent
-2. Check `Database Connection Pool` utilization
-3. Review `Trace Map Data` for database span durations
-4. Verify `Disk I/O` metrics on database host
-
----
-
-## Data Model Categories Quick Reference
-
-### 🔍 Debugging & Troubleshooting
-- Trace Map Data
-- Exception Data
-- Error Logs
-- Application Logs
-
-### 📊 Performance Monitoring
-- Application Response Time
-- MySQL Performance
-- JVM Metrics
-- CPU Usage
-- Memory Usage
-
-### 🏗️ Infrastructure Health
-- Kubernetes Pod Metrics
-- Kubernetes Deployment Metrics
-- Kubernetes Node Metrics
-- Container Metrics
-
-### 🔒 Security & Compliance
-- Security Events
-- Failed Login Attempts
-- Audit Logs
-- SSL Certificate Expiry
-
-### 💼 Business Metrics
-- Transaction Success Rate
-- User Sessions
-- Conversion Rate
-- Custom KPIs
-
----
-
-**Last Updated:** February 16, 2026  
-**Package Version:** 2.0.7  
-**See Also:** [USE_CASE_RCA.md](USE_CASE_RCA.md) - Complete RCA walkthrough

package/QUICKSTART.md

@@ -1,213 +0,0 @@
-# 🚀 Vunet MCP Server - Quick Start Card
-
-## Package Name
-**`@mithung/vunet-mcp-server`** - v2.0.0
-
----
-
-## Install
-
-### Global (Recommended - After Publishing)
-```bash
-npm install -g @mithung/vunet-mcp-server
-```
-
-### From Tarball (Internal Distribution)
-```bash
-npm pack
-npm install -g vunet-mcp-server-1.0.0.tgz
-```
-
-### From Source (Development)
-```bash
-npm install
-npm link
-```
-
----
-
-## Configure
-
-### Single Tenant
-
-Create `.vscode/mcp.json`:
-
-**Username/Password:**
-```json
-{
-  "mcpServers": {
-    "vunet": {
-      "command": "npx",
-      "args": ["@mithung/vunet-mcp-server"],
-      "env": {
-        "VUNET_TENANT_URL": "https://your-tenant.com",
-        "VUNET_USERNAME": "username",
-        "VUNET_PASSWORD": "password",
-        "VUNET_BU_ID": "1",
-        "VUNET_VERIFY_SSL": "true"
-      }
-    }
-  }
-}
-```
-
-**Bearer Token:**
-```json
-{
-  "mcpServers": {
-    "vunet": {
-      "command": "npx",
-      "args": ["@mithung/vunet-mcp-server"],
-      "env": {
-        "VUNET_TENANT_URL": "https://your-tenant.com",
-        "VUNET_BEARER_TOKEN": "your-token-here",
-        "VUNET_BU_ID": "1",
-        "VUNET_VERIFY_SSL": "true"
-      }
-    }
-  }
-}
-```
-
-### Multiple Tenants
-
-```json
-{
-  "mcpServers": {
-    "vunet-prod": {
-      "command": "npx",
-      "args": ["@mithung/vunet-mcp-server"],
-      "env": { "VUNET_TENANT_URL": "...", ... }
-    },
-    "vunet-staging": {
-      "command": "npx",
-      "args": ["@mithung/vunet-mcp-server"],
-      "env": { "VUNET_TENANT_URL": "...", ... }
-    }
-  }
-}
-```
-
----
-
-## Use
-
-### In VS Code (GitHub Copilot Chat)
-
-```
-Show me traces from the last 2 days
-```
-
-```
-Get Kubernetes metrics for the last 15 minutes
-```
-
-```
-Create a performance report for slow traces
-```
-
-### Multi-Tenant
-
-```
-@vunet-prod show error rate for last hour
-@vunet-staging compare with yesterday
-```
-
----
-
-## Publish
-
-```bash
-# 1. Login
-npm login
-
-# 2. Publish
-npm publish --access public
-
-# 3. Done!
-# Team can now: npm install -g @mithung/vunet-mcp-server
-```
-
----
-
-## Files Created
-
-✅ `package.json` - npm package config
-✅ `index.js` - MCP server
-✅ `README.md` - Full documentation (14KB)
-✅ `SETUP.md` - Quick setup guide
-✅ `CHANGELOG.md` - Version history
-✅ `PUBLISHING.md` - Publishing guide
-✅ `LICENSE` - MIT License
-✅ `config.example.json` - Config template
-✅ `mcp-config.example.json` - Multi-tenant template
-✅ `.npmignore` - Package exclusions
-
----
-
-## Environment Variables
-
-| Variable | Required | Default | Description |
-|----------|----------|---------|-------------|
-| `VUNET_TENANT_URL` | ✅ | - | Tenant URL |
-| `VUNET_USERNAME` | ✅* | - | Username (*or use bearer token) |
-| `VUNET_PASSWORD` | ✅* | - | Password (*or use bearer token) |
-| `VUNET_BEARER_TOKEN` | ✅* | - | Bearer token (*or use username/password) |
-| `VUNET_BU_ID` | ❌ | `1` | Business Unit |
-| `VUNET_VERIFY_SSL` | ❌ | `true` | SSL verify |
-
----
-
-## MCP Tools
-
-1. **`vunet_query_metric`**
-   - Query any data model
-   - Flexible time ranges
-   - Dynamic filters
-   
-2. **`vunet_get_status`**
-   - Connection status
-   - Authentication status
-   - Session info
-
----
-
-## Data Models (80+)
-
-- Trace Map Data
-- Traces Transaction Volume
-- Kubernetes Pod Metrics
-- Kubernetes Node Metrics
-- VuBank Metrics
-- ... and 75+ more
-
----
-
-## Next Steps
-
-1. ✅ **Test Locally** - Already working!
-2. 📦 **Publish npm** - `npm publish`
-3. 👥 **Share Team** - Config template
-4. 📈 **Monitor** - GitHub Issues
-
----
-
-## Documentation
-
-📖 Full Guide → [README.md](README.md)
-⚙️ Setup → [SETUP.md](SETUP.md)
-📦 Publishing → [PUBLISHING.md](PUBLISHING.md)
-📋 Summary → [PACKAGE_SUMMARY.md](PACKAGE_SUMMARY.md)
-
----
-
-## Support
-
-🐛 Issues: GitHub Issues
-💬 Docs: README.md
-📧 Email: support@vunetsystems.com
-
----
-
-**Made with ❤️ by Vunet Systems**
-**Powered by Model Context Protocol**