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.

Upgrading to 2.0

2.0 renames all 7 MCP tools so every name starts with a verb (e.g. alert_get → get_log_alert, alert_history → get_log_alert_history, alert_list → list_log_alerts). The full old → new table is in RELEASE_NOTES.md. Nothing else changes: same tools, parameters, safety gates and CLI commands. If an agent prompt, script or ~/.vmware/rules.yaml names a tool, update it — though deny rules written with the old names keep working with vmware-policy ≥ 1.18 (vmware-audit policy lists any rule the renames widened), and vmware-pilot ≥ 1.13 translates old names in saved workflows. If an install older than 2.0 shares that rules.yaml, give it vmware-policy ≥ 1.18.2 too: it matches each rule against both the old and the new name, so one file serves both.

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 search_logs 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

Offline / Air-Gapped Install (from source)

This project uses the modern PEP 517 build system (hatchling), so there is no setup.py by design — that is expected, not a missing file. If you cloned the source and hit ERROR: File "setup.py" or "setup.cfg" not found ... editable mode currently requires a setuptools-based build, your pip is older than 21.3 and cannot do an editable (-e) install with a non-setuptools backend. Editable mode is a developer convenience, not needed to run the tool — do one of:

# From the source tree — a normal (non-editable) install builds a wheel:
pip install .              # NOT  pip install -e .

# ...or upgrade pip first, and editable works too:
pip install --upgrade pip && pip install -e .

For a truly air-gapped host, build the wheels on a connected machine and copy them over — the target then needs no network:

# On a connected machine, collect this package + its dependencies as wheels:
pip wheel . -w dist        # → dist/*.whl   (or: uv build, for just this package)

# Copy dist/ to the air-gapped host, then install offline:
pip install --no-index --find-links dist vmware-log-insight

MCP Tools (7 — all read-only)

Tool What
search_logs Search events by time window + text + filters
aggregate_logs Count/aggregate over time bins, with z-score spike detection
list_log_fields List extracted fields usable in filters
get_log_insight_version Appliance version/build
list_log_alerts / get_log_alert / get_log_alert_history Query defined alerts and their trigger history

Workflows

  • Find errors fast — vmware-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 search_logs results (plus vCenter events from vmware-monitor and metrics from vmware-aria) to vmware-debug build_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.

Metadata

Release files for vmware-log-insight 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vmware-log-insight 2.2.0
File Size Uploaded Provenance
vmware_log_insight-2.2.0.tar.gz 217.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for vmware-log-insight 2.2.0
File Interpreter ABI Platform
vmware_log_insight-2.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 259.5 kB

Release files / vmware_log_insight-2.2.0.tar.gz

Download URL vmware_log_insight-2.2.0.tar.gz
Size 217.8 kB
Tags Source
SHA-256 checksum
How to use checksums
91f67894f1ea227f44848c347e4474ee675dd8b35024fdaa63eb71fe628fdbc4
BLAKE2b-256 checksum
How to use checksums
fc59bee6d405433fbf90ed36ef87e0f9f85fd1ee3121d9faf9a36e814a59265e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.12

Release files / vmware_log_insight-2.2.0-py3-none-any.whl

Download URL vmware_log_insight-2.2.0-py3-none-any.whl
Size 41.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c0ff8bdd7fc6b8912e635c42888f87f2f924271bd1653ed7462a448867da9e38
BLAKE2b-256 checksum
How to use checksums
f4d268d0912cdc5c149da4443ba77df4f53118043ad3f8ed196ed4ee5a273433
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.12

Security for vmware-log-insight 2.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page