{"id":19561362,"url":"https://github.com/m-mizutani/vxcap","last_synced_at":"2025-09-11T14:07:14.442Z","repository":{"id":57630852,"uuid":"207432752","full_name":"m-mizutani/vxcap","owner":"m-mizutani","description":"Capture and dump VXLAN encapsulated traffic","archived":false,"fork":false,"pushed_at":"2024-04-19T09:46:39.000Z","size":67,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-26T07:08:33.694Z","etag":null,"topics":["aws","packet-capture","traffic-monitoring","vxlan"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m-mizutani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-10T00:51:03.000Z","updated_at":"2024-02-05T03:49:11.000Z","dependencies_parsed_at":"2024-06-20T09:25:52.042Z","dependency_job_id":"bea411f6-6de1-400a-8e15-83a18bc2dda1","html_url":"https://github.com/m-mizutani/vxcap","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-mizutani%2Fvxcap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-mizutani%2Fvxcap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-mizutani%2Fvxcap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m-mizutani%2Fvxcap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m-mizutani","download_url":"https://codeload.github.com/m-mizutani/vxcap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251072279,"owners_count":21532004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","packet-capture","traffic-monitoring","vxlan"],"created_at":"2024-11-11T05:11:12.352Z","updated_at":"2025-04-27T00:31:10.980Z","avatar_url":"https://github.com/m-mizutani.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vxcap\n\n[![Travis-CI](https://travis-ci.org/m-mizutani/vxcap.svg)](https://travis-ci.org/m-mizutani/vxcap) [![Report card](https://goreportcard.com/badge/github.com/m-mizutani/vxcap)](https://goreportcard.com/report/github.com/m-mizutani/vxcap)\n\nCapture and dump VXLAN encapsulated traffic. Main focus is AWS VPC traffic mirroring.\n\n![arch](https://user-images.githubusercontent.com/605953/64929961-06461c80-d867-11e9-8f83-841c94b84c85.png)\n\n## Setup\n\n### Prerequisite\n\n- Go \u003e= 1.11.1\n\n### Install\n\n```bash\ngo install github.com/m-mizutani/vxcap\n```\n\n## Getting started\n\n### Capture traffic and save packet to file as pcap format\n\n```bash\nvxcap -d pcap -e fs --fs-filename your_dump_file.pcap\n```\n\n### Capture traffic and save packet to AWS S3 Bucket as json record\n\n```bash\nvxcap -d json -e s3 --aws-region ap-northeast-1 --aws-s3-bucket your-bucket-name\n```\n\n### Capture traffic and send packet data to AWS Firehose\n\n```bash\nvxcap -d json -e firehose --aws-region ap-northeast-1 --aws-firehose-name your-hose-name\n```\n\n## Options\n\n- Base options\n  - `--emitter \u003cvalue\u003e, -e \u003cvalue\u003e`:  Destination to save data [fs,s3,firehose] (default: \"fs\")\n  - `--dumper \u003cvalue\u003e, -d \u003cvalue\u003e`:  Write format [pcap,json] (default: \"pcap\")\n  - `--log-level \u003cvalue\u003e`:  Log level [trace,debug,info,warn,error] (default: \"info\")\n- Options for UDP server to receive VXLAN packet\n  - `--port \u003cvalue\u003e, -p \u003cvalue\u003e`:  UDP port of VXLAN receiver (default: 4789)\n  - `--receiver-queue-size \u003cvalue\u003e`:  Queue size between UDP server and packet processor (default: 1024)\n- Options for file system emitter (`fs`)\n  - `--fs-filename \u003cvalue\u003e`:  Base file name for FS emitter (default: \"dump\")\n  - `--fs-dirpath \u003cvalue\u003e`:  Output directory for FS emitter (default: \".\")\n- Options for AWS service emitter (`s3` and `firehose`)\n  - `--aws-region \u003cvalue\u003e`:  AWS region for emitter to AWS\n  - `--aws-s3-bucket \u003cvalue\u003e`:  AWS S3 bucket name for S3 emitter\n  - `--aws-s3-prefix \u003cvalue\u003e`:  Prefix of AWS S3 object key for S3 emitter\n  - `--aws-s3-add-time-key`:  Enable to add time key to S3 object key for S3 emitter\n  - `--aws-s3-flush-count \u003cvalue\u003e`:  Threshold of record number to flush object to AWS S3 bucket\n  - `--aws-s3-flush-interval \u003cvalue\u003e`: Flush interval (seconds) to AWS S3 bucket\n  - `--aws-firehose-name \u003cvalue\u003e`:  Name of AWS Firehose for Firehose emitter\n  - `--aws-firehose-flush-size \u003cvalue\u003e`  Threshold of record size to flush object to AWS Firehose\n  - `--aws-firehose-flush-interval \u003cvalue\u003e`: Flush interval (seconds) to AWS Firehose\n- Options for JSON format\n  - `--enable-json-text`:  Enable human readable application layer payload in json format\n  - `--enable-json-raw`:  Enable raw application layer payload (base64 encoded) in json format\n\n## Test\n\n```bash\ngo test ./...\n```\n\n## Author and License\n\n- Author: Masayoshi Mizutani mizutani@sfc.wide.ad.jp / [@m_mizutani](https://twitter.com/m_mizutani)\n- [MIT License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm-mizutani%2Fvxcap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm-mizutani%2Fvxcap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm-mizutani%2Fvxcap/lists"}