{"id":40778262,"url":"https://github.com/boynux/squid-exporter","last_synced_at":"2026-01-21T19:14:48.927Z","repository":{"id":41344715,"uuid":"96635568","full_name":"boynux/squid-exporter","owner":"boynux","description":"Squid Prometheus Exporter","archived":false,"fork":false,"pushed_at":"2025-05-03T12:29:27.000Z","size":2002,"stargazers_count":144,"open_issues_count":10,"forks_count":54,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-03T12:30:09.819Z","etag":null,"topics":["prometheus","squid"],"latest_commit_sha":null,"homepage":"https://www.boynux.com/squid-exporter","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/boynux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":["boynux"],"patreon":null,"open_collective":null,"ko_fi":"boynux","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2017-07-08T18:01:21.000Z","updated_at":"2025-05-03T12:29:30.000Z","dependencies_parsed_at":"2023-01-29T13:45:46.835Z","dependency_job_id":"4431383d-c65a-4850-9684-fce750480a78","html_url":"https://github.com/boynux/squid-exporter","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/boynux/squid-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boynux%2Fsquid-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boynux%2Fsquid-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boynux%2Fsquid-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boynux%2Fsquid-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boynux","download_url":"https://codeload.github.com/boynux/squid-exporter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boynux%2Fsquid-exporter/sbom","scorecard":{"id":249549,"data":{"date":"2025-08-11","repo":{"name":"github.com/boynux/squid-exporter","commit":"7a7d91627080d9d4c0f1d2b25d7b485a9655654d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Code-Review","score":5,"reason":"Found 10/20 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/docker.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/boynux/squid-exporter/release.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:16","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/docker.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.13.0 not signed: https://api.github.com/repos/boynux/squid-exporter/releases/216656034","Warn: release artifact v1.12.2 not signed: https://api.github.com/repos/boynux/squid-exporter/releases/216338177","Warn: release artifact v1.12.1 not signed: https://api.github.com/repos/boynux/squid-exporter/releases/216300669","Warn: release artifact v1.12.0 not signed: https://api.github.com/repos/boynux/squid-exporter/releases/162145892","Warn: release artifact v1.11.0 not signed: https://api.github.com/repos/boynux/squid-exporter/releases/142759143","Warn: release artifact v1.13.0 does not have provenance: https://api.github.com/repos/boynux/squid-exporter/releases/216656034","Warn: release artifact v1.12.2 does not have provenance: https://api.github.com/repos/boynux/squid-exporter/releases/216338177","Warn: release artifact v1.12.1 does not have provenance: https://api.github.com/repos/boynux/squid-exporter/releases/216300669","Warn: release artifact v1.12.0 does not have provenance: https://api.github.com/repos/boynux/squid-exporter/releases/162145892","Warn: release artifact v1.11.0 does not have provenance: https://api.github.com/repos/boynux/squid-exporter/releases/142759143"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/docker.yml:9"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Vulnerabilities","score":2,"reason":"8 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2025-3488 / GHSA-6v2p-p543-phr9","Warn: Project is vulnerable to: GO-2022-0603 / GHSA-hp87-p4gw-j4gq"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T08:12:09.116Z","repository_id":41344715,"created_at":"2025-08-17T08:12:09.117Z","updated_at":"2025-08-17T08:12:09.117Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28640654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T18:04:35.752Z","status":"ssl_error","status_checked_at":"2026-01-21T18:03:55.054Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["prometheus","squid"],"created_at":"2026-01-21T19:14:48.187Z","updated_at":"2026-01-21T19:14:48.922Z","avatar_url":"https://github.com/boynux.png","language":"Go","funding_links":["https://github.com/sponsors/boynux","https://ko-fi.com/boynux","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=3TH7YAMMEC5L4\u0026source=url"],"categories":[],"sub_categories":[],"readme":"[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/boynux/squid-exporter)\n\n[![Github Actions](https://github.com/boynux/squid-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/boynux/squid-exporter/actions/workflows/release.yml)\n[![Github Docker](https://github.com/boynux/squid-exporter/actions/workflows/docker.yml/badge.svg)](https://github.com/boynux/squid-exporter/actions/workflows/docker.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/boynux/squid-exporter)](https://goreportcard.com/report/github.com/boynux/squid-exporter)\n[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/boynux/squid-exporter)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=3TH7YAMMEC5L4\u0026source=url)\n\n**Note: I've been very busy on the past couple of months with my personal life and work. Thanks for filing issues and feature requests. I'll start to go through them and provide updates very soon.**\n\n\nSquid Prometheus exporter\n--------------------------\n\nExports squid metrics in Prometheus format\n\n**NOTE**: From release 1.0 metric names and some parameters has changed. Make sure you check the docs and update your deployments accordingly!\n\nNew\n-----\n\n* Using environment variables to configure the exporter\n* Adding custom labels to metrics\n* Enabling TLS for exporter via [WebConfig](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md)\n\nUsage:\n------\nSimple usage:\n\n    squid-exporter -squid-hostname \"localhost\" -squid-port 3128\n\n[Configure Prometheus](https://github.com/boynux/squid-exporter/blob/master/prometheus/prometheus.yml) to scrape metrics from `localhost:9301/metrics`\n\n    - job_name: squid\n      # squid-exporter is installed, grab stats about the local\n      # squid instance.\n      target_groups:\n        - targets: ['localhost:9301']\n\nTo get all the parameteres, command line arguments always override default and environment variables configs:\n\n    squid-exporter -help\n\nThe following environment variables can be used to override default parameters:\n\n```\nSQUID_EXPORTER_LISTEN\nSQUID_EXPORTER_WEB_CONFIG_PATH\nSQUID_EXPORTER_METRICS_PATH\nSQUID_HOSTNAME\nSQUID_PORT\nSQUID_LOGIN\nSQUID_PASSWORD\nSQUID_EXTRACTSERVICETIMES\n```\n\nUsage with docker:\n------\nBasic setup assuming Squid is running on the same machine:\n\n    docker run --net=host -d boynux/squid-exporter\n\nSetup with Squid running on a different host\n\n    docker run -p 9301:9301 -d boynux/squid-exporter -squid-hostname \"192.168.0.2\" -squid-port 3128 -listen \":9301\"\n\nWith environment variables\n\n    docker run -p 9301:9301 -d -e SQUID_PORT=\"3128\" -e SQUID_HOSTNAME=\"192.168.0.2\" -e SQUID_EXPORTER_LISTEN=\":9301\" boynux/squid-exporter\n\n\nBuild:\n--------\n\nThis project is written in Go, so all the usual methods for building (or cross compiling) a Go application would work.\n\nIf you are not very familiar with Go you can download the binary from [releases](https://github.com/boynux/squid-exporter/releases).\n\nOr build it for your OS:\n\n`go install https://github.com/boynux/squid-exporter`\n\nthen you can find the binary in: `$GOPATH/bin/squid-exporter`\n\nFeatures:\n---------\n\n- [ ] Expose Squid counters\n  -  [x] Client HTTP\n  -  [x] Server HTTP\n  -  [x] Server ALL\n  -  [x] Server FTP\n  -  [x] Server Other\n  -  [ ] ICP\n  -  [ ] CD\n  -  [x] Swap\n  -  [ ] Page Faults\n  -  [ ] Others\n- [ ] Expose Squid service times\n  - [x] HTTP requests\n  - [x] Cache misses\n  - [x] Cache hits\n  - [x] Near hits\n  - [ ] Not-Modified replies\n  - [x] DNS lookups\n  - [ ] ICP queries\n- [ ] Expose squid Info\n  - [x] Squid service info (as label)\n  - [x] Connection information for squid\n  - [x] Cache information for squid\n  - [ ] Median Service Times (seconds)  5 min\n  - [x] Resource usage for squid\n  - [x] Memory accounted for\n  - [x] File descriptor usage for squid\n  - [x] Internal Data Structures\n- [ ] Histograms\n- [ ] Other metrics\n- [x] Squid Authentication (Basic Auth)\n\nFAQ:\n--------\n\n- Q: Which versions of Squid are supported?\n- A: Squid version 3.2.0.10 and later.\n\n- Q: Why are no Squid metrics reported by the exporter?\n- A: This usually means that the exporter cannot reach the Squid server, or that the cachemgr ACLs\n     are incorrect. To debug and mitigate:\n  - First make sure that the host running the exporter can access the Squid cachemgr URL, e.g.:\n    `curl http://localhost:3128/squid-internal-mgr/info`\n\n  - If that fails, verify that the Squid ACL configuration allows the exporter host to access the\n    cachemgr. In the following example, a custom `prometheus` ACL is defined to allow cachemgr\n    endpoint access from outside the Squid host, via the network (use with caution).\n  ```\n  acl prometheus src 192.0.2.0/24\n  http_access allow localhost manager\n  http_access allow prometheus manager\n  http_access deny manager\n  ```\n\n- Q: Why `process_open_fds` metric is not exported?\n- A: This usualy means exporter don't have permission to read `/proc/\u003csquid_proc_id\u003e/fd` folder. You can either\n\n1. _[recommended]_ Set `CAP_DAC_READ_SEARCH` capability for squid exporter process (or docker). (eg. `sudo setcap 'cap_dac_read_search+ep' ./bin/squid-exporter`)\n2. _[not recommended]_ Run the exporter as root.\n\nContribution:\n-------------\n\nPull request and issues are very welcome.\n\nIf you found this program useful please consider donations [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=3TH7YAMMEC5L4\u0026source=url)\n\nCopyright:\n----------\n\n[MIT License](https://opensource.org/licenses/MIT)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboynux%2Fsquid-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboynux%2Fsquid-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboynux%2Fsquid-exporter/lists"}