{"id":26367645,"url":"https://github.com/molu8bits/s3bucket_exporter","last_synced_at":"2025-10-14T04:12:39.370Z","repository":{"id":54623458,"uuid":"209885296","full_name":"molu8bits/s3bucket_exporter","owner":"molu8bits","description":"S3 bucket exporter exposing metrics size and number of objects","archived":false,"fork":false,"pushed_at":"2024-03-13T22:32:48.000Z","size":79,"stargazers_count":17,"open_issues_count":4,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T17:49:27.009Z","etag":null,"topics":["exporter","molu8bits","s3","s3-exporter","s3bucket","s3bucket-exporter"],"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/molu8bits.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}},"created_at":"2019-09-20T21:39:20.000Z","updated_at":"2024-04-22T20:33:59.000Z","dependencies_parsed_at":"2024-06-20T17:31:38.665Z","dependency_job_id":"ca9f623e-6abd-4856-81dc-13758966d9d6","html_url":"https://github.com/molu8bits/s3bucket_exporter","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molu8bits%2Fs3bucket_exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molu8bits%2Fs3bucket_exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molu8bits%2Fs3bucket_exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/molu8bits%2Fs3bucket_exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/molu8bits","download_url":"https://codeload.github.com/molu8bits/s3bucket_exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243933441,"owners_count":20370988,"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":["exporter","molu8bits","s3","s3-exporter","s3bucket","s3bucket-exporter"],"created_at":"2025-03-16T21:18:09.384Z","updated_at":"2025-10-14T04:12:39.285Z","avatar_url":"https://github.com/molu8bits.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# S3bucket Exporter\n\ns3bucket_exporter collects informations about size and object list about all the buckets accessible by user. Was designed to work with ceph, but should work will all S3 compatible endpoints.\n\n## Badges\n\n[![License](https://img.shields.io/github/license/molu8bits/s3bucket_exporter)](/LICENSE)\n[![Release](https://img.shields.io/github/release/molu8bits/s3bucket_exporter.svg)](https://github.com/molu8bits/s3bucket_exporter/releases/latest)\n[![GitHub Releases Stats of s3bucket_exporter](https://img.shields.io/github/downloads/molu8bits/s3bucket_exporter/total.svg?logo=github)](https://somsubhra.github.io/github-release-stats/?username=molu8bits\u0026repository=s3bucket_exporter)\n[![CI](https://github.com/molu8bits/s3bucket_exporter/actions/workflows/ci.yaml/badge.svg?branch=master\u0026event=push)](https://github.com/molu8bits/s3bucket_exporter/actions/workflows/ci.yaml?branch=master\u0026event=push)\n[![Frogbot Scan Pull Request](https://github.com/molu8bits/s3bucket_exporter/actions/workflows/frogbot-scan-pr-go.yaml/badge.svg)](https://github.com/molu8bits/s3bucket_exporter/actions/workflows/frogbot-scan-pr-go.yml)\n[![Scanned by Frogbot](https://raw.github.com/jfrog/frogbot/master/images/frogbot-badge.svg)](https://github.com/jfrog/frogbot#readme)\n[![Go Report Card](https://goreportcard.com/badge/github.com/molu8bits/s3bucket_exporter)](https://goreportcard.com/report/github.com/molu8bits/s3bucket_exporter)\n![Docker Image Size](https://img.shields.io/docker/image-size/molu8bits/s3bucket_exporter.svg?sort=date)\n![Docker Image Version (latest by date):](https://img.shields.io/docker/v/molu8bits/s3bucket_exporter.svg?sort=date)\n![Docker Pulls](https://img.shields.io/docker/pulls/molu8bits/s3bucket_exporter.svg)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=s3bucket_exporter\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=s3bucket_exporter)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=s3bucket_exporter\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=s3bucket_exporter)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=s3bucket_exporter\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=s3bucket_exporter)\n[![codecov](https://codecov.io/github/molu8bits/s3bucket_exporter/branch/master/graph/badge.svg?token=6KIJFNB8WG)](https://codecov.io/github/molu8bits/s3bucket_exporter)\n\n[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B37992%2Fgithub.com%2Fmolu8bits%2Fs3bucket_exporter.svg?type=large)](https://app.fossa.com/projects/custom%2B37992%2Fgithub.com%2Fmolu8bits%2Fs3bucket_exporter?ref=badge_large)\n\n## Getting started\n\nRun from command-line:\n\n```sh\n./s3bucket_exporter [flags]\n```\n\nRun from command-line - example with minimal parameter list:\n\n```sh\n./s3bucket_exporter -s3_endpoint=192.168.0.1:7480 -s3_access_key=akces123 -s3_secret_key=secret123 -s3_name=MyS3Endpoint\n```\n\nRun as docker container - example for local s3-like buckets with ssl disabled:\n\n```sh\ndocker run -p 9655:9655 -d -e LISTEN_PORT=:9655 -e S3_DISABLE_SSL=True -e S3_ENDPOINT=192.168.0.1:7480 -e S3_ACCESS_KEY=akces123 -e S3_SECRET_KEY=secret123 -e S3_NAME=MyS3Endpoint docker.io/molu8bits/s3bucket_exporter:0.3 \n```\n\nRun from command-line - example for AWS\n/*Please note that you need to have buckets only in one region. Otherwise script will fail with message \"...BucketRegionError: incorrect region, the bucket is not in ...\"*/\n\n```sh\n./s3bucket-exporter -s3_endpoint https://s3.us-east-1.amazonaws.com -listen_port :9655 -s3_access_key ABCD12345678 -s3_secret_key mySecretKey -s3_name=My2S3Endpoint --s3_region=us-east-1 --s3_force_path_style=false --s3_disable_endpoint_host_prefix=true\n```\n\nThe exporter supports two different configuration ways: command-line arguments take precedence over environment variables.\n\nAs for available flags and equivalent environment variables, here is a list:\n\n|     environment variable          |    argument                       |     description                                    |        default        |     example              |\n| --------------------------------- | --------------------------------- | -------------------------------------------------- | --------------------- | ------------------------ |\n| S3_NAME                           | -s3_name                         | S3 configuration name, visible as a tag            |                       | MyS3Endpoint             |\n| S3_ENDPOINT                       | -s3_endpoint                     | S3 endpoint url with port  |                       |                       | 192.168.0.1:7480         |\n| S3_ACCESS_KEY                     | -s3_access_key                   | S3 access_key (aws_access_key)                     |                       | myAkcesKey               |\n| S3_SECRET_KEY                     | -s3_secret_key                   | S3 secret key (aws_secret_key)                     |                       | mySecretKey              |\n| S3_REGION                         | -s3_region                       | S3 region name                                     | default               | \"default\" or \"eu-west-1\" |\n| LISTEN_PORT                       | -listen_port                     | Exporter listen Port cluster                       | :9655                 | :9123                   |\n| LOG_LEVEL                         | -log_level                       | Log level. Info or Debug                           | Info                  | Debug                    |\n| S3_DISABLE_SSL                    | -s3_disable_ssl                  | If S3 endpoint is not secured by SSL set to True   | False                 | True                     |\n| S3_DISABLE_ENDPOINT_HOST_PREFIX   | -s3_disable_endpoint_host_prefix | Disable endpoint host prefix                       | False                 | True                     |\n| S3_FORCE_PATH_STYLE               | -s3_force_path_style             | Force use path style (bucketname not added to url) | True                  | False                    |\n\n\u003e Warning: For security reason is not advised to use credential from command line\n\n## Prometheus configuration example:\n\n```yaml\n  - job_name: 's3bucket'\n    static_configs:\n    - targets: ['192.168.0.5:9655']\n```\n\n## Grafana\n\nGrafana dashboad ([resources/grafana-s3bucket-dashboard.json] (resources/grafana-s3bucket-dashboard.json)):\n\n![](images/grafana-s3bucket-dashboard.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmolu8bits%2Fs3bucket_exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmolu8bits%2Fs3bucket_exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmolu8bits%2Fs3bucket_exporter/lists"}