base on curl statistics made simple # httpstat ![screenshot](screenshot.png) httpstat visualizes `curl(1)` statistics in a way of beauty and clarity. It is a **single file🌟** Python script that has **no dependency👏** and is compatible with **Python 3🍻**. ## Installation There are three ways to get `httpstat`: - Download the script directly: `wget https://raw.githubusercontent.com/reorx/httpstat/master/httpstat.py` - Through pip: `pip install httpstat` - Through homebrew (macOS only): `brew install httpstat` > For Windows users, @davecheney's [Go version](https://github.com/davecheney/httpstat) is suggested. → [download link](https://github.com/davecheney/httpstat/releases) ## Usage Simply: ```bash python httpstat.py httpbin.org/get ``` If installed through pip or brew, you can use `httpstat` as a command: ```bash httpstat httpbin.org/get ``` ### cURL Options Because `httpstat` is a wrapper of cURL, you can pass any cURL supported option after the url (except for `-w`, `-D`, `-o`, `-s`, `-S` which are already used by `httpstat`): ```bash httpstat httpbin.org/post -X POST --data-urlencode "a=b" -v ``` ### Environment Variables `httpstat` has a bunch of environment variables to control its behavior. Here are some usage demos, you can also run `httpstat --help` to see full explanation. - <strong><code>HTTPSTAT_SHOW_BODY</code></strong> Set to `true` to show response body in the output, note that body length is limited to 1023 bytes, will be truncated if exceeds. Default is `false`. - <strong><code>HTTPSTAT_SHOW_IP</code></strong> By default httpstat shows remote and local IP/port address. Set to `false` to disable this feature. Default is `true`. - <strong><code>HTTPSTAT_SHOW_SPEED</code></strong> Set to `true` to show download and upload speed. Default is `false`. ```bash HTTPSTAT_SHOW_SPEED=true httpstat http://cachefly.cachefly.net/10mb.test ... speed_download: 3193.3 KiB/s, speed_upload: 0.0 KiB/s ``` - <strong><code>HTTPSTAT_SAVE_BODY</code></strong> By default httpstat stores body in a tmp file, set to `false` to disable this feature. Default is `true` - <strong><code>HTTPSTAT_CURL_BIN</code></strong> Indicate the cURL bin path to use. Default is `curl` from current shell $PATH. This exampe uses brew installed cURL to make HTTP2 request: ```bash HTTPSTAT_CURL_BIN=/usr/local/Cellar/curl/7.50.3/bin/curl httpstat https://http2.akamai.com/ --http2 HTTP/2 200 ... ``` > cURL must be compiled with nghttp2 to enable http2 feature > ([#12](https://github.com/reorx/httpstat/issues/12)). - <strong><code>HTTPSTAT_METRICS_ONLY</code></strong> If set to `true`, httpstat will only output metrics in json format, this is useful if you want to parse the data instead of reading it. - <strong><code>HTTPSTAT_DEBUG</code></strong> Set to `true` to see debugging logs. Default is `false` For convenience, you can export these environments in your `.zshrc` or `.bashrc`, example: ```bash export HTTPSTAT_SHOW_IP=false export HTTPSTAT_SHOW_SPEED=true export HTTPSTAT_SAVE_BODY=false ``` ## Related Projects Here are some implementations in various languages: - Go: [davecheney/httpstat](https://github.com/davecheney/httpstat) This is the Go alternative of httpstat, it's written in pure Go and relies no external programs. Choose it if you like solid binary executions (actually I do). - Go (library): [tcnksm/go-httpstat](https://github.com/tcnksm/go-httpstat) Other than being a cli tool, this project is used as library to help debugging latency of HTTP requests in Go code, very thoughtful and useful, see more in this [article](https://medium.com/@deeeet/trancing-http-request-latency-in-golang-65b2463f548c#.mm1u8kfnu) - Bash: [b4b4r07/httpstat](https://github.com/b4b4r07/httpstat) This is what exactly I want to do at the very beginning, but gave up due to not confident in my bash skill, good job! - Node: [yosuke-furukawa/httpstat](https://github.com/yosuke-furukawa/httpstat) [b4b4r07](https://twitter.com/b4b4r07) mentioned this in his [article](https://tellme.tokyo/post/2016/09/25/213810), could be used as a HTTP client also. - PHP: [talhasch/php-httpstat](https://github.com/talhasch/php-httpstat) The PHP implementation by @talhasch Some code blocks in `httpstat` are copied from other projects of mine, have a look: - [reorx/python-terminal-color](https://github.com/reorx/python-terminal-color) Drop-in single file library for printing terminal color. - [reorx/getenv](https://github.com/reorx/getenv) Environment variable definition with type. ", Assign "at most 3 tags" to the expected json: {"id":"10802","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"