{"id":13646539,"url":"https://github.com/yanc0/beeping","last_synced_at":"2025-04-21T21:30:55.416Z","repository":{"id":57501154,"uuid":"53857178","full_name":"yanc0/beeping","owner":"yanc0","description":"HTTP Monitoring via API - Measure the performance of your servers","archived":true,"fork":false,"pushed_at":"2021-04-11T06:13:02.000Z","size":58,"stargazers_count":262,"open_issues_count":6,"forks_count":14,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-11-09T20:37:39.481Z","etag":null,"topics":["api","distributed","geoip","golang","http","httpstat","monitoring"],"latest_commit_sha":null,"homepage":"","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/yanc0.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}},"created_at":"2016-03-14T13:11:30.000Z","updated_at":"2024-09-27T11:33:43.000Z","dependencies_parsed_at":"2022-09-26T19:52:43.794Z","dependency_job_id":null,"html_url":"https://github.com/yanc0/beeping","commit_stats":null,"previous_names":["yanc0/pingmeback"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanc0%2Fbeeping","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanc0%2Fbeeping/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanc0%2Fbeeping/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanc0%2Fbeeping/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yanc0","download_url":"https://codeload.github.com/yanc0/beeping/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250136641,"owners_count":21380870,"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":["api","distributed","geoip","golang","http","httpstat","monitoring"],"created_at":"2024-08-02T01:02:58.531Z","updated_at":"2025-04-21T21:30:55.200Z","avatar_url":"https://github.com/yanc0.png","language":"Go","readme":"# DEPRECATED\n\nThis code is unmaintained anymore. [Blackbox exporter](https://github.com/prometheus/blackbox_exporter) is the right way\nto monitor your http services.\n\n# BeePing v0.5.0\n[![Build Status](https://travis-ci.org/yanc0/beeping.svg?branch=master)](https://travis-ci.org/yanc0/beeping)\n\n_previously named pingmeback_\n\n  \u003e It forages the servers and brings the metrics back to the hive\n\nBeePing is a distant http check as a Service. Call the very simple API, BeePing\nwill measure website for you.\n\n:us::green_heart: 200 OK - **119 ms** - (http_status_code, http_request_time)\n\n:book: DNS - **9 ms** - (dns_lookup)\n\n:arrows_counterclockwise: TCP - **6 ms** - (tcp_connection)\n\n:lock: TLS - **52 ms** - (tls_handshake)\n\n:desktop_computer: Server Processing - **43 ms** - (server_processing)\n\n:arrow_down_small: Transfer - **6 ms** - (content_transfer)\n\nOther attributes :\n* cert_expiry_days_left\n* http_body_pattern\n\nFeatures:\n\n* Very simple JSON API\n* Lot of metrics\n* Timeline of HTTP request\n* SSL Expiration check\n* Server SSL/TLS version and Ciphers\n* Pattern check (search for text in response)\n* GeoIP resolution\n* Single binary\n\nBig hugs to :\n\n* Dave Cheney for his inspirational work on [httpstat](https://github.com/davecheney/httpstat)\n* Taichi Nakashima for his work on httpstat lib [go-httpstat](https://github.com/tcnksm/go-httpstat)\n\n## Install\n\nDownload latest version on [releases page](https://github.com/yanc0/beeping/releases)\n\n- `chmod +x beeping`\n- `sudo mv beeping /usr/bin`\n- `beeping`\n\n```\n$ ./beeping -h\nUsage of ./beeping:\n  -geodatfile string\n        geoIP database path (default \"/opt/GeoIP/GeoLite2-City.mmdb\")\n  -instance string\n        beeping instance name (default hostname)\n  -listen string\n        The host to bind the server to (default \"127.0.0.1\")\n  -port string\n        The port to bind the server to (default \"8080\")\n  -tlsmode\n        Activate SSL/TLS versions and Cipher support checks (slow)\n  -validatetarget\n          Perform some security checks on the target provided (default true)\n```\n\n**Notes**\n\n* If no GeoIP database is found, BeePing omit geo response silently\n* TLSMode returns more infos on SSL object. It tries the more ciphers and TLS version\n  Golang can test but the checks can be way slower.\n\n### Optional\n\nYou can plug MaxMind GeoIP file to know on which country the pings goes.\n\nSee: http://dev.maxmind.com/geoip/geoip2/geolite2/\n\n## Build\n\nBeeping is known to only compile with Golang 1.8.x + (see [#14](../../issues/14) )\n\n```shell\ngo get -u github.com/golang/dep\ngo get -u github.com/yanc0/beeping\ncd $GOPATH/src/github.com/yanc0/beeping\ndep ensure\ngo build\n```\n\n## API Usage\n\n```\n$ curl -XPOST http://localhost:8080/check -d '{\"url\": \"https://google.fr\", \"pattern\": \"find me\", \"header\": \"Server:GitHub.com\", \"insecure\": false, \"timeout\": 20}'\n{\n  \"http_status\": \"200 OK\",\n  \"http_status_code\": 200,\n  \"http_body_pattern\": true,\n  \"http_header\": true,\n  \"http_request_time\": 716,\n  \"instance_name\": \"X250\",\n  \"dns_lookup\": 14,\n  \"tcp_connection\": 101,\n  \"tls_handshake\": 228,\n  \"server_processing\": 168,\n  \"content_transfer\": 203,\n  \"timeline\": {\n    \"name_lookup\": 14,\n    \"connect\": 115,\n    \"pretransfer\": 344,\n    \"starttransfer\": 512\n  },\n  \"geo\": {\n    \"country\": \"US\",\n    \"ip\": \"192.30.253.112\"\n  },\n  \"ssl\": {\n    \"ciphers\": [\n      \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\",\n      \"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\",\n      \"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305\",\n      \"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305\",\n      \"TLS_ECDHE_ECDSA_WITH_RC4_128_SHA\",\n      \"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\",\n      \"TLS_RSA_WITH_RC4_128_SHA\",\n      \"TLS_RSA_WITH_3DES_EDE_CBC_SHA\",\n      \"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256\",\n      \"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\",\n      \"TLS_ECDHE_RSA_WITH_RC4_128_SHA\",\n      \"TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA\"\n    ],\n    \"protocol_versions\": [\n      \"TLS12\",\n      \"TLS10\",\n      \"TLS11\"\n    ],\n    \"cert_expiry_date\": \"2018-05-17T12:00:00Z\",\n    \"cert_expiry_days_left\": 374,\n    \"cert_signature\": \"SHA256-RSA\"\n  }\n}\n```\n\n* If pattern is not filled `http_body_pattern` is always `true`\n* If header is not filled `http_header` is always `true`\n* `ssl` is omitted when `http://`. The same for the `tls_handshake` field\n* `geo` is omitted if geoip is not set\n\n## Beeping Clients\n\n* beeping-client (python) : you can use the [beeping-client](https://github.com/QuentinDeSoete/beeping-client) made by [Quentin De Soete](https://github.com/QuentinDeSoete), in Python.\n\n## Error Handling\n\nbeeping returns HTTP 500 when check fail. The body contains the reason of the failure.\n\n```\n{\n  \"message\": \"Get https://mysite.com/health: net/http: request canceled (Client Timeout exceeded while awaiting headers)\"\n}\n```\n\n## HTTP Basic Auth\n\nJust add the 'auth' option in your JSON.\n\n```\n$ curl -XPOST http://localhost:8080/check -d '{\"url\":\"http://127.0.0.1:3000\",\"auth\":\"john:secret\"}'\n```\n\n## Changelog\n\n### 0.6.0 - UNRELEASED\n\n  * Validate target - CWE-918 [#16](../../pulls/16) [Aaron Hnatiw](https://github.com/insp3ctre)\n  * Include remote address in request header [#19](../../pulls/19) [Aaron Hnatiw](https://github.com/insp3ctre)\n  * Basic HTTP auth [#23](../../pulls/23) [Brice Colucci](https://github.com/bcolucci)\n  * Go native HTTP server instead of Gin [#24](../../pulls/24) [Brice Colucci](https://github.com/bcolucci)\n\n### 0.5.0 - 2017-05-07\n\n  * Add TLS Mode, now show server supported ciphers and SSL/TLS versions\n  * Add listen / Port options (**breaking change**)\n  * Modify JSON response structure (**breaking change**)\n  * Add proper logging\n  * Set proper User-Agent\n  * Add header check\n\n### 0.4.0 - 2017-04-24\n\n  * Pingmeback is now BeePing\n  * Add BeePing logo\n  * Adapt documentation\n  * Change Travis build info\n\n### 0.3.0 - 2017-04-21\n\n  * pingmeback now returns geoip informations\n  * Add Instance name in results\n  * Add vendoring system\n\n\n## To Do\n\n- [x] Add HTTP Auth\n- [ ] Add tests\n- [ ] More metrics\n- [ ] Packaging\n\n## Contributing\n\nFeel free to make a pull request.\n\n## Contributors\n\n * Aaron Hnatiw\n * Aimof\n * Brice Colucci\n * Yann Coleu\n\n## Licence\n\n```\nThe MIT License (MIT)\n\nCopyright (c) 2016 Yann Coleu\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyanc0%2Fbeeping","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyanc0%2Fbeeping","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyanc0%2Fbeeping/lists"}