{"id":19723496,"url":"https://github.com/remind101/dockerstats","last_synced_at":"2025-04-29T22:30:59.009Z","repository":{"id":32481361,"uuid":"36061635","full_name":"remind101/dockerstats","owner":"remind101","description":"Easy scraping for the Docker stats api.","archived":false,"fork":false,"pushed_at":"2015-09-22T19:28:43.000Z","size":549,"stargazers_count":14,"open_issues_count":1,"forks_count":2,"subscribers_count":82,"default_branch":"master","last_synced_at":"2025-04-05T20:01:46.975Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/remind101.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-22T08:40:02.000Z","updated_at":"2022-06-04T04:24:41.000Z","dependencies_parsed_at":"2022-08-24T22:40:44.381Z","dependency_job_id":null,"html_url":"https://github.com/remind101/dockerstats","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remind101%2Fdockerstats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remind101%2Fdockerstats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remind101%2Fdockerstats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remind101%2Fdockerstats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remind101","download_url":"https://codeload.github.com/remind101/dockerstats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251592951,"owners_count":21614448,"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":[],"created_at":"2024-11-11T23:22:23.943Z","updated_at":"2025-04-29T22:30:57.889Z","avatar_url":"https://github.com/remind101.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dockerstats\n\nDockerstats is a simple docker container for collecting metrics from the [Docker Stats](https://docs.docker.com/reference/api/docker_remote_api_v1.17/#get-container-stats-based-on-resource-usage) API and sending them elsewhere. It supports adapters for configuring where you want metrics to be sent. It's heavily inspired by [logspout](https://github.com/gliderlabs/logspout) and is roughly similar to [cadvisor](https://github.com/google/cadvisor) but simpler.\n\nCurrently, the following adapters are provided:\n\n* **Log**: An adapter that logs stats to stdout. This adapter can be useful if you're already using something like [logspout](https://github.com/gliderlabs/logspout) to collect logs from containers. The format can be configured via the `STAT_TEMPLATE` environment variable. The default template is a template that will log stats in [l2met](https://github.com/ryandotsmith/l2met/wiki/Usage#logging-convention) format. Here's an [example](https://gist.github.com/ejholmes/c56a15b7d760389f041c) set of metrics with the default template.\n* **Statsd**: _TODO_\n* **Librato**: _TODO_\n\n## Usage\n\nSimply run the container and mount the docker socket:\n\n```console\n$ docker run --name=\"dockerstats\" \\\n    --volume=/var/run/docker.sock:/tmp/docker.sock \\\n    remind101/dockerstats\n```\n\n## Metrics\n\nThe following metrics will be created:\n\n```\nNetwork.RxDropped\nNetwork.RxBytes\nNetwork.RxErrors\nNetwork.TxPackets\nNetwork.RxPackets\nNetwork.TxErrors\nNetwork.TxBytes\n\nMemoryStats.Stats.TotalPgmafault\nMemoryStats.Stats.Cache\nMemoryStats.Stats.MappedFile\nMemoryStats.Stats.TotalInactiveFile\nMemoryStats.Stats.Pgpgout\nMemoryStats.Stats.Rss\nMemoryStats.Stats.TotalMappedFile\nMemoryStats.Stats.Writeback\nMemoryStats.Stats.Unevictable\nMemoryStats.Stats.Pgpgin\nMemoryStats.Stats.TotalUnevictable\nMemoryStats.Stats.Pgmajfault\nMemoryStats.Stats.TotalRss\nMemoryStats.Stats.TotalRssHuge\nMemoryStats.Stats.TotalWriteback\nMemoryStats.Stats.TotalInactiveAnon\nMemoryStats.Stats.RssHuge\nMemoryStats.Stats.HierarchicalMemoryLimit\nMemoryStats.Stats.TotalPgfault\nMemoryStats.Stats.TotalActiveFile\nMemoryStats.Stats.ActiveAnon\nMemoryStats.Stats.TotalActiveAnon\nMemoryStats.Stats.TotalPgpgout\nMemoryStats.Stats.TotalCache\nMemoryStats.Stats.InactiveAnon\nMemoryStats.Stats.ActiveFile\nMemoryStats.Stats.Pgfault\nMemoryStats.Stats.InactiveFile\nMemoryStats.Stats.TotalPgpgin\nMemoryStats.MaxUsage\nMemoryStats.Usage\nMemoryStats.Failcnt\nMemoryStats.Limit\n\nCPUStats.CPUUsage.UsageInUsermode\nCPUStats.CPUUsage.TotalUsage\nCPUStats.CPUUsage.UsageInKernelmode\nCPUStats.SystemCPUUsage\nCPUStats.ThrottlingData.Periods\nCPUStats.ThrottlingData.ThrottledPeriods\nCPUStats.ThrottlingData.ThrottledTime\n```\n\n## Roadmap\n\n* Add a statsd drain.\n* BlkioStats\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremind101%2Fdockerstats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremind101%2Fdockerstats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremind101%2Fdockerstats/lists"}