Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

vmware-archive/loginsight-export

Repository files navigation

VMware has ended active development of this project, this repository will no longer be updated.

A command-line exporter of log events in VMware vRealize Log Insight. Exceed the 20k UI limit. Write local files.

loginsight-export

Installation

  1. Open a command prompt.
  2. pip install loginsight-export
  3. loginsight-export -h

Usage

  1. In Log Insight Interactive Analytics, perform a query of arbitrary complexity and size.
  2. Use the Share button to generate a short url for the current query.
  3. loginsight-export https://loginsight.example.com/s/123456

Overview

VMware vRealize Log Insight supports exporting query results to a file in the UI. However, a single export is limited to 20k results. To export more results, an operator can execute a sequence of queries with non-overlapping time-ranges, each of which contained less than 20k. As scale increases, this becomes cumbersome. This utility starts with a single UI-driven time-range, recursively breaks the full range down into sequential <=20k-sized chunks, and executes an export for each chunk.

Prerequisites

  • Built on Requests.
  • Python 3.4 or higher.
  • Uses tox, pytest, requests-mock for testing.

Secure Connections

The exporter verifies a remote server's certificate against your CA trust chain by default. If Log Insight is using a valid certificate that's not trusted by your local machine (e.g., self-signed), use the --save command-line argument to write a local PEM file and --verify to trust it. The certificate's integrity is still verified.

If Log Insight is using the auto-generated certificate with a common name that doens't match Log Insight's hostname, the request will fail:

loginsightexport: error: The remote SSL certificate isn't trusted: hostname '192.168.3.30' doesn't match 'VMware vCenter Log Insight'

It's always recommended to use real certificates. To bypass this check in a test environment, use the --insecure command-line argument.

Contributing

The loginsight-export project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ. For more detailed information, refer to CONTRIBUTING.md.

License

Distributed under the Apache Version 2.0 license