:vhs:

VHS

The cloud-native swiss army knife for network traffic data.
Explore the docs »

Report Bug · Request Feature

About The Project

vhs is a versatile tool for network traffic capture. vhs can be run as a command line tool or be deployed into your Kubernetes cluster as a sidecar, where it can capture traffic to and from your services. Live traffic can be analyzed in real time to produce Prometheus metrics or saved for use in offline analysis, load testing, or whatever you can imagine!

Getting Started

The quickest way to see vhs in action is to visit our getting started page to run through a simple demo of vhs and see a few straightforward usage examples that demonstrate various aspects of vhs functionality.

More Information

A complete guide to the usage and flags of vhs is available on our documentation site. vhs operates on the concept of a data flow that originates with a source and terminates with one or more sinks. Sources may capture network data, read data from files, etc. Sinks may write data to cloud (GCS, S3, etc.) or local storage, standard output, or send data to other destinations. Along the way, data may pass through a series of input modifiers and formats and output modifiers and formats that transform the data. This architecture is described in more detail here.

Roadmap

We want your help in determining the future of vhs. See the issues page and please let us know what features are important to you!

License

Distributed under the Apache 2.0 license. See LICENSE for more information.

Built With

• cobra
• zerolog
• go-packet

Contact

There are several ways to contact the vhs team:

• You can file a GitHub issue with an idea, feature request, or bug.
• You can join the public vhs mailing list.
• You can join the public vhs Slack using this form. vhs-related discussions can be found in the #vhs-to-be-renamed channel

If you are interested in contributing, please join the mailing list and Slack above, and be sure to check out the contributor guidelines and the code of conduct.