Skip to main content

VMware Log Insight

Disclaimer: Community-maintained open-source project, not affiliated with, endorsed by, or sponsored by VMware, Inc. or Broadcom Inc. "VMware", "vSphere", and "Aria" are trademarks of Broadcom. Source is publicly auditable under the MIT license.

Read-only log search and aggregation for VMware Aria Operations for Logs (formerly vRealize Log Insight) — the appliance that collects syslog from ESXi hosts, vCenter, and VMs. The centralized-log data source for the VMware skill family. Strictly non-destructive: it queries, it never writes.

  • Read-only by design — and provable (v1.8.0): all 7 MCP tools are read, none write; set VMWARE_READ_ONLY=true (or the per-skill VMWARE_LOG_INSIGHT_READ_ONLY, or read_only: true in config) and the family read-only gate verifies that at startup instead of taking the docs' word for it. See Read-Only Mode.

Companion Skills

Need Skill Tools
Raw centralized logs + spikes vmware-log-insight (this) 7
vCenter events & alarms vmware-monitor 27
Metrics, anomalies, capacity vmware-aria 28
Incident correlation / root cause vmware-debug — feed it log_search output 2
VM lifecycle / operations vmware-aiops 49

Install

uv tool install vmware-log-insight
mkdir -p ~/.vmware-log-insight
cp config.example.yaml ~/.vmware-log-insight/config.yaml   # edit host/username/provider
echo 'VMWARE_LOG_INSIGHT_PROD_PASSWORD=...' > ~/.vmware-log-insight/.env
chmod 600 ~/.vmware-log-insight/.env
vmware-log-insight doctor

MCP Tools (7 — all read-only)

Tool What
log_search Search events by time window + text + filters
log_aggregate Count/aggregate over time bins, with z-score spike detection
log_fields List extracted fields usable in filters
log_version Appliance version/build
alert_list / alert_get / alert_history Query defined alerts and their trigger history

Read-Only Mode

vmware-log-insight is read-only by design — all 7 MCP tools carry the [READ] marker and there are no write tools to withhold. Since v1.8.0 that is provable rather than merely documented: set VMWARE_READ_ONLY=true and the family read-only gate enumerates the registry at startup and verifies that zero write tools are exposed — structural, not a prompt instruction a model can ignore. Off by default. Fail-closed: if the mode is requested but cannot be guaranteed, the server refuses to start rather than running open.

The same variable is family-wide: one env var also strips every write tool from the write-capable siblings (aiops, storage, vks, nsx, ...), so a whole-estate audit posture is a single setting.

{
  "mcpServers": {
    "vmware-log-insight": {
      "command": "vmware-log-insight",
      "args": ["mcp"],
      "env": { "VMWARE_READ_ONLY": "true" }
    }
  }
}
  • Per-skill override: VMWARE_LOG_INSIGHT_READ_ONLY=true (takes precedence over the family-wide VMWARE_READ_ONLY)
  • Config alternative: read_only: true in ~/.vmware-log-insight/config.yaml

Precedence: per-skill env → family env → config → off. Nothing is logged as withheld because nothing is — the gate's empty result is the assertion (write-capable siblings log Read-only mode active ... withheld N write tool(s) instead).

Workflows

  • Find errors fastvmware-log-insight search -q error -l 1h.
  • Where did logs burst?vmware-log-insight aggregate -q error -l 6h --bin-ms 300000, read spikes[], then search the spike window.
  • Root cause — pass log_search results (plus vCenter events from vmware-monitor and metrics from vmware-aria) to vmware-debug incident_timeline.

Troubleshooting

  • 401 on /sessions → check username/password/provider and the VMWARE_LOG_INSIGHT_<TARGET>_PASSWORD env var.
  • 503 everywhere → appliance starting up; doctor reports it as a status, not a crash.
  • Empty results → widen --last; default API port is 9543 (set port if different).

Security

Read-only by construction. Credentials in ~/.vmware-log-insight/.env (chmod 600); plaintext passwords auto-obfuscated to grep-safe b64: (obfuscation, not encryption — inject from a secret manager for real secrecy). TLS on by default. See SECURITY.md.

License

MIT.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vmware_log_insight-1.8.4.tar.gz (180.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vmware_log_insight-1.8.4-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

Details for the file vmware_log_insight-1.8.4.tar.gz.

File metadata

  • Download URL: vmware_log_insight-1.8.4.tar.gz
  • Upload date:
  • Size: 180.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vmware_log_insight-1.8.4.tar.gz
Algorithm Hash digest
SHA256 c9e594de72cd25f39bc77a8fca0e3add4a115435f5df0cbde0a314899d92ab8c
MD5 e3100f3aa7f50e5f9e9b402781cf542d
BLAKE2b-256 5a59b1083e12f08beb4a7fc10ff85446511f64b1033c137c9933e2aa1e7bf825

See more details on using hashes here.

File details

Details for the file vmware_log_insight-1.8.4-py3-none-any.whl.

File metadata

  • Download URL: vmware_log_insight-1.8.4-py3-none-any.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vmware_log_insight-1.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e8c8baa5d8396bef85f904cf62a2527877f687d4c1bc5a00d77a3d35da584b44
MD5 0ccdd2e6106127d3046d7c3810f3cf6a
BLAKE2b-256 555971a3e0c74b30dc10b98f734d633231f4a6316d2bedc7e57750e49cde5ba4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page