{"id":18541918,"url":"https://github.com/cardinate/subsquid-checkmk","last_synced_at":"2025-05-15T04:11:45.377Z","repository":{"id":230267608,"uuid":"778936195","full_name":"cardinate/subsquid-checkmk","owner":"cardinate","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-28T18:06:37.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-17T08:41:46.526Z","etag":null,"topics":["checkmk","subsquid"],"latest_commit_sha":null,"homepage":"","language":"Python","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/cardinate.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}},"created_at":"2024-03-28T17:44:26.000Z","updated_at":"2024-03-28T18:05:32.000Z","dependencies_parsed_at":"2024-03-28T19:29:50.278Z","dependency_job_id":"ba76a311-6496-400b-b901-7f92f6887742","html_url":"https://github.com/cardinate/subsquid-checkmk","commit_stats":null,"previous_names":["cardinate/subsquid-checkmk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cardinate%2Fsubsquid-checkmk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cardinate%2Fsubsquid-checkmk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cardinate%2Fsubsquid-checkmk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cardinate%2Fsubsquid-checkmk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cardinate","download_url":"https://codeload.github.com/cardinate/subsquid-checkmk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270652,"owners_count":22042861,"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":["checkmk","subsquid"],"created_at":"2024-11-06T20:06:44.266Z","updated_at":"2025-05-15T04:11:40.367Z","avatar_url":"https://github.com/cardinate.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Subsquid Worker CheckMK Monitoring Plugin\n\nThis plugin allows you to monitor Subsquid workers via the enterprise IT monitoring platform [CheckMK](https://checkmk.com/). It works using the [piggyback mechanism](https://docs.checkmk.com/latest/en/piggyback.html). This means that the plugin is installed on a central monitoring host and centrally gathers data for all deployed workers.\n\n## Installation\n\nFirst, ensure that you have installed the necessary distribution packages to create Python virtualenvs. For example, on Ubuntu, that would be:\n\n```sh\nsudo apt install python3-pip python3-venv\n```\n\nClone the git repository, create a virtualenv and copy the script into a place where it will be found by the check_mk agent:\n\n```sh\ngit clone https://github.com/cardinate/subsquid-checkmk.git\ncd subsquid-checkmk\nsudo python3 -m venv /usr/local/lib/check-subsquid-worker/\nsudo /usr/local/lib/check-subsquid-worker/bin/pip install -r requirements.txt\nsudo cp check-subsquid-worker /usr/lib/check_mk_agent/local/check-subsquid-worker\nsudo chmod a+x /usr/lib/check_mk_agent/local/check-subsquid-worker\n```\n\n## Configuration\n\nFor each worker that you monitor, you create a file in `/var/lib/check-subsquid-worker` (create this directory if it does not exist). The file name must be equal to the hostname in CheckMK, and the content must be the public key/P2P address of the (`12D3…`) worker's RPC node.\n\nAdditionally, you can create a file `/etc/default/check-subsquid-worker` to configure the following environment variables that affect the behaviour of the check.\n\n| Variable | Meaning | Default |\n|----------|---------|---------|\n| `SUBSQUID_WORKERS_DIR` | The directory where the worker configuration files are found | `/var/lib/check-subsquid-worker` |\n| `SUBSQUID_PING_TIMEOUT` | Timeout for retrieving basic data via the ping endpoint | `30` |\n| `SUBSQUID_CHUNKS_TIMEOUT` | Timeout for retrieving chunk allocations | `30`\n| `SUBQSUID_METRICS_TIMEOUT` | Timeout for retrieving additional per-worker metrics | `30`\n\n## Known issues and limitations\n\n* The plugin works by scraping Subsquid's monitoring endpoints, which an be rather slow to respond. Consider using a rather large interval between checks to prevent issues.\n* Traffic metrics (`responseBytes`) are currently not returned from the metrics endpoint.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcardinate%2Fsubsquid-checkmk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcardinate%2Fsubsquid-checkmk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcardinate%2Fsubsquid-checkmk/lists"}