inkle

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2020 License: MIT Imports: 10 Imported by: 0

README

Inkle

master coverage

Log Based gRPC Tracing System 𝌘

Log format

grpc_service_name,grpc_method_name,src_ip,src_tcp,dst_ip,dst_tcp,grpc_status_code,duration, info

e.g:
helloworld.Greeter,SayHello,::1,53412,::1,8000,0,161626,Request - Response
datetime.Datetime,GetDatetime,::1,53413,::1,9000,0,10120,Request - Response

TODO: Installation

$ go get -u github.com/abrampers/inkle
$ cd $GOPATH/src/github.com/abrampers/inkle
$ go build -o .

Usage

$ ./inkle -stdout

Available flags:

Flag Type Default Description
-device=cni0 string eth0 Network Device to be intercepted.
-stdout bool false Write logs to stdout.
-output=/var/log string . Write log file to specified directory (ignored if -stdout is set).
-timeout=200ms time.Duration 800ms Set request timeout.
-filter-by-host-cidr bool false If this flag is set, Inkle will get the valid IP range of the network device specified in -device and will only print logs with source IP addres within that range.
-h n/a n/a Print out help message.

Roadmap

  • Repo description.
  • Repo architecture.
  • HTTP/2 frame classification.
  • State management to support gRPC connection reuse.
  • Supports source IP address filtering by host CIDR.
  • HTTPS support
  • Ensure correctness while ignoring unsupported streams.
  • Support for gRPC streams.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL