{"id":20541077,"url":"https://github.com/netways/check_logstash","last_synced_at":"2025-09-04T05:35:44.762Z","repository":{"id":45455012,"uuid":"62395621","full_name":"NETWAYS/check_logstash","owner":"NETWAYS","description":"Icinga check plugin to check the status of Logstash","archived":false,"fork":false,"pushed_at":"2025-09-03T11:08:23.000Z","size":232,"stargazers_count":22,"open_issues_count":2,"forks_count":11,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-09-03T13:09:33.762Z","etag":null,"topics":["icinga","logstash","monitoring"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NETWAYS.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,"zenodo":null}},"created_at":"2016-07-01T13:41:04.000Z","updated_at":"2025-09-03T11:08:21.000Z","dependencies_parsed_at":"2023-09-28T02:05:58.280Z","dependency_job_id":"cebff033-6ca8-49a7-a5a4-2ac6bef22763","html_url":"https://github.com/NETWAYS/check_logstash","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/NETWAYS/check_logstash","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fcheck_logstash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fcheck_logstash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fcheck_logstash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fcheck_logstash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NETWAYS","download_url":"https://codeload.github.com/NETWAYS/check_logstash/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fcheck_logstash/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273523321,"owners_count":25120861,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["icinga","logstash","monitoring"],"created_at":"2024-11-16T01:19:14.122Z","updated_at":"2025-09-04T05:35:44.718Z","avatar_url":"https://github.com/NETWAYS.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# check_logstash\n\nAn Icinga check plugin to check Logstash.\n\n## Usage\n\n```bash\nUsage:\n  check_logstash [flags]\n  check_logstash [command]\n\nAvailable Commands:\n  health      Checks the health of the Logstash server\n  pipeline    Checks the status of the Logstash Pipelines\n\nFlags:\n  -H, --hostname string    Hostname of the Logstash server (CHECK_LOGSTASH_HOSTNAME) (default \"localhost\")\n  -p, --port int           Port of the Logstash server (default 9600)\n  -s, --secure             Use a HTTPS connection\n  -i, --insecure           Skip the verification of the server's TLS certificate\n  -b, --bearer string      Specify the Bearer Token for server authentication (CHECK_LOGSTASH_BEARER)\n  -u, --user string        Specify the user name and password for server authentication \u003cuser:password\u003e (CHECK_LOGSTASH_BASICAUTH)\n      --ca-file string     Specify the CA File for TLS authentication (CHECK_LOGSTASH_CA_FILE)\n      --cert-file string   Specify the Certificate File for TLS authentication (CHECK_LOGSTASH_CERT_FILE)\n      --key-file string    Specify the Key File for TLS authentication (CHECK_LOGSTASH_KEY_FILE)\n  -t, --timeout int        Timeout in seconds for the CheckPlugin (default 30)\n  -h, --help               help for check_logstash\n  -v, --version            version for check_logstash\n```\n\nThe check plugin respects the environment variables `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY`.\n\nVarious flags can be set with environment variables, refer to the help to see which flags.\n\n### Health\n\nChecks the health status of the Logstash server.\n\n```bash\nUsage:\n  check_logstash health [flags]\n\nExamples:\n\n\t$ check_logstash health --hostname 'localhost' --port 8888 --insecure\n\t[OK] - Logstash is healthy | process.cpu.percent=0;0.5;3;0;100\n\t \\_[OK] Heap usage at 12.00%\n\t \\_[OK] Open file descriptors at 12.00%\n\t \\_[OK] CPU usage at 5.00%\n\n\t$ check_logstash -p 9600 health --cpu-usage-threshold-warn 50 --cpu-usage-threshold-crit 75\n\t[WARNING] - CPU usage at 55.00%\n\t \\_[OK] Heap usage at 12.00%\n\t \\_[OK] Open file descriptors at 12.00%\n\t \\_[WARNING] CPU usage at 55.00%\n\nFlags:\n      --file-descriptor-threshold-warn string   The percentage relative to the process file descriptor limit on which to be a warning result (default \"100\")\n      --file-descriptor-threshold-crit string   The percentage relative to the process file descriptor limit on which to be a critical result (default \"100\")\n      --heap-usage-threshold-warn string        The percentage relative to the heap size limit on which to be a warning result (default \"70\")\n      --heap-usage-threshold-crit string        The percentage relative to the heap size limit on which to be a critical result (default \"80\")\n      --cpu-usage-threshold-warn string         The percentage of CPU usage on which to be a warning result (default \"100\")\n      --cpu-usage-threshold-crit string         The percentage of CPU usage on which to be a critical result (default \"100\")\n      --unreachable-state int                   Exit with specified code if unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default 3)\n  -h, --help                                    help for health\n```\n\n### Pipeline\n\nDetermines the health of Logstash pipelines via \"inflight events\". These events are calculated as such: `inflight events = events.In - events.Out`\n\nHint: Use the queue backpressure for Logstash 8.\n\n```bash\nUsage:\n  check_logstash pipeline [flags]\n\nExamples:\n\n\t$ check_logstash pipeline --inflight-events-warn 5 --inflight-events-crit 10\n\t[WARNING] - Inflight events\n\t \\_[WARNING] inflight_events_example-input:9;\n\t \\_[OK] inflight_events_example-default-connector:4\n\n\t$ check_logstash pipeline --inflight-events-warn 5 --inflight-events-crit 10 --pipeline example\n\t[CRITICAL] - Inflight events\n\t \\_[CRITICAL] inflight_events_example:15\n\nFlags:\n  -P, --pipeline string               Pipeline Name (default \"/\")\n      --inflight-events-warn string   Warning threshold for inflight events to be a warning result. Use min:max for a range.\n      --inflight-events-crit string   Critical threshold for inflight events to be a critical result. Use min:max for a range.\n  -h, --help                          help for pipeline\n```\n\n### Pipeline Flow Metrics\n\nChecks the status of a Logstash pipeline's flow metrics (currently queue backpressure).\n\nHint: Requires Logstash 8.5.0\n\n```bash\n\nUsage:\n  check_logstash pipeline flow [flags]\n\nExamples:\n\n\t$ check_logstash pipeline flow --warning 5 --critical 10\n\t[OK] - Flow metrics alright\n\t \\_[OK] queue_backpressure_example:0.34;\n\n\t$ check_logstash pipeline flow --pipeline example --warning 5 --critical 10\n\t[CRITICAL] - Flow metrics alright\n\t \\_[CRITICAL] queue_backpressure_example:11.23;\n\nFlags:\n  -c, --critical string   Critical threshold for queue Backpressure\n  -h, --help              help for flow\n  -P, --pipeline string   Pipeline Name (default \"/\")\n  -w, --warning string    Warning threshold for queue Backpressure\n```\n\n### Pipeline Reload\n\nChecks the status of Logstash pipelines configuration reload.\n\n```bash\nUsage:\n  check_logstash pipeline reload [flags]\n\nExamples:\n\n\t$ check_logstash pipeline reload\n\t[OK] - Configuration successfully reloaded\n\t \\_[OK] Configuration successfully reloaded for pipeline Foobar for on 2021-01-01T02:07:14Z\n\n\t$ check_logstash pipeline reload --pipeline Example\n\t[CRITICAL] - Configuration reload failed\n\t \\_[CRITICAL] Configuration reload for pipeline Example failed on 2021-01-01T02:07:14Z\n\nFlags:\n  -P, --pipeline string               Pipeline Name (default \"/\")\n  -h, --help                          help for pipeline\n```\n\n## License\n\nCopyright (c) 2022 [NETWAYS GmbH](mailto:info@netways.de)\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public\nLicense as published by the Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied\nwarranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program. If not,\nsee [gnu.org/licenses](https://www.gnu.org/licenses/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetways%2Fcheck_logstash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetways%2Fcheck_logstash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetways%2Fcheck_logstash/lists"}