From d61700b0265876a4aaa5c6bece8718c50369b41b Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 7 Feb 2025 18:42:06 +0100 Subject: [PATCH] update readme --- README.md | 18 +++++++++++++++--- docker-compose.yaml | 2 +- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a2e8cd3..3753287 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ -# S3bucket Exporter +# S3 bucket Exporter -s3-bucket-exporter collects informations about size and object list about all the buckets accessible by user. +S3-bucket-exporter collects informations about size and object list about all the buckets accessible by user. Was designed to work with AWS, but should work will all S3 compatible endpoints (Minio, Ceph, Localstack, etc). +Provides the following metrics: + +Total metrics: + - `s3_total_size` + - `s3_total_object_number` + - `s3_list_total_duration_seconds` + +Bucket level metrics: + - `s3_bucket_size` + - `s3_bucket_object_number` + - `s3_list_duration_seconds` + ## Getting started Run from command-line: @@ -20,7 +32,7 @@ Run from command-line - example with minimal parameter list: Run as docker container - example for local s3-like buckets: ```sh -docker run -p 9655:9655 -d -e S3_ENDPOINT=http://127.0.0.1:9000 -e S3_ACCESS_KEY=minioadmin -e S3_SECRET_KEY=minioadmin -e S3_BUCKET_NAMES=my-bucket-name docker.io/tropnikovvl/s3-bucket-exporter:latest +docker run -p 9655:9655 -d -e S3_ENDPOINT=http://127.0.0.1:9000 -e S3_ACCESS_KEY=minioadmin -e S3_SECRET_KEY=minioadmin -e S3_BUCKET_NAMES=my-bucket-name ghcr.io/tropnikovvl/s3-bucket-exporter:latest ``` Run from command-line - example for AWS diff --git a/docker-compose.yaml b/docker-compose.yaml index a1f45a8..b0ece85 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,6 +1,6 @@ services: s3bucketexporter: - image: docker.io/tropnikovvl/s3-bucket-exporter:latest + image: ghcr.io/tropnikovvl/s3-bucket-exporter:latest restart: always ports: - "9655:9655"