From 6ec3d2957561e1a0677cf6ab944418c905a9bc8a Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Thu, 25 Sep 2025 13:17:35 +0200 Subject: [PATCH 1/9] feat(obj): add doc on metrics and logs collected MTA-6463 --- .../logs-metrics-collection-cockpit.mdx | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx new file mode 100644 index 0000000000..37c5b5c1c6 --- /dev/null +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -0,0 +1,22 @@ +--- +title: Logs and metrics collected and sent to Cockpit +description: This page details what data is sent to Cockpit as logs and metrics for monitoring purposes +tags: data collect monitoring observability cockpit audit data plane +dates: + validation: 2025-09-25 + posted: 2025-09-25 +--- + +Scaleway Object Storage automatically sends logs and metrics to [Scaleway Cockpit](/cockpit/) for monitoring purposes. + +Cockpit collects the following metrics: + +- `object_storage_bucket_bandwidth_egress_bytes` +- `object_storage_bucket_bandwidth_ingress_bytes` +- `object_storage_bucket_http_response_time_seconds_bucket` +- `object_storage_bucket_http_response_time_seconds_count` +- `object_storage_bucket_http_response_time_seconds_sum` +- `object_storage_bucket_objects_total` +- `object_storage_bucket_parts_total` +- `object_storage_bucket_usage_bytes_total` + From 54583191d450251f52982925918cad2b257b8839 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Thu, 25 Sep 2025 14:39:10 +0200 Subject: [PATCH 2/9] Update pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com> --- .../reference-content/logs-metrics-collection-cockpit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx index 37c5b5c1c6..8c9e0edbac 100644 --- a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -1,6 +1,6 @@ --- title: Logs and metrics collected and sent to Cockpit -description: This page details what data is sent to Cockpit as logs and metrics for monitoring purposes +description: This page details what Object Storage data is sent to Cockpit as logs and metrics for monitoring purposes tags: data collect monitoring observability cockpit audit data plane dates: validation: 2025-09-25 From 785247685297d64e568d7c449ffdf89f41fecac5 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 30 Sep 2025 10:57:55 +0200 Subject: [PATCH 3/9] feat(obj): update --- .../logs-metrics-collection-cockpit.mdx | 36 ++++++++++++++----- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx index 8c9e0edbac..15ec55d79a 100644 --- a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -7,16 +7,34 @@ dates: posted: 2025-09-25 --- -Scaleway Object Storage automatically sends logs and metrics to [Scaleway Cockpit](/cockpit/) for monitoring purposes. +Scaleway Object Storage automatically sends detailed logs and metrics to [Scaleway Cockpit](/cockpit/) for monitoring, observability, and auditing purposes. + +To consult your Object Storage metrics and logs, refer to the [dedicated documentation](/object-storage/how-to/monitor-consumption/). + +## Metrics collected by Cockpit Cockpit collects the following metrics: -- `object_storage_bucket_bandwidth_egress_bytes` -- `object_storage_bucket_bandwidth_ingress_bytes` -- `object_storage_bucket_http_response_time_seconds_bucket` -- `object_storage_bucket_http_response_time_seconds_count` -- `object_storage_bucket_http_response_time_seconds_sum` -- `object_storage_bucket_objects_total` -- `object_storage_bucket_parts_total` -- `object_storage_bucket_usage_bytes_total` +- `object_storage_bucket_bandwidth_egress_bytes`: Total number of bytes sent from the bucket to clients (outbound traffic). +- `object_storage_bucket_bandwidth_ingress_bytes`: Total number of bytes received by the bucket from clients (inbound traffic). +- `object_storage_bucket_http_response_time_seconds_bucket`: Distribution of HTTP response times for bucket operations, grouped into time buckets. +- `object_storage_bucket_http_response_time_seconds_count`: Total count of HTTP responses for bucket operations. +- `object_storage_bucket_http_response_time_seconds_sum`: Cumulative sum of HTTP response times for bucket operations. +- `object_storage_bucket_objects_total`: Total number of objects currently stored in the bucket. +- `object_storage_bucket_parts_total`: Total number of multipart upload parts present in the bucket. +- `object_storage_bucket_usage_bytes_total`: Total storage space used by all objects in the bucket, in bytes. + +## Logs collected by Cockpit + +Cockpit collects the following logs: +- `@timestamp`: The exact time when the log entry was recorded. +- `hp.res.header.s3`: The specific S3 API operation performed (e.g., GetObject, PutObject). +- `hp.res.header.account`: The ProjectID associated with the request. +- `hp.req.uri`: The URI path of the HTTP request made to the bucket. +- `hp.req.method`: The HTTP method used for the request (e.g., GET, PUT, DELETE). +- `hp.res.status_code`: The HTTP status code returned in response to the request. +- `hp.req.header.host`: The value of the HTTP Host header in the request. +- `hp.res.header.bucket`: The name of the bucket targeted by the request. +- `hp.res.header.txid`: The unique transaction ID assigned to the request. +- `hp.net.client_ip`: The source IP address from which the request originated. \ No newline at end of file From 54768015bdf600f07661cb01a90208c7c6473340 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 30 Sep 2025 11:31:17 +0200 Subject: [PATCH 4/9] feat(obj): update --- .../logs-metrics-collection-cockpit.mdx | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx index 15ec55d79a..6006ddb085 100644 --- a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -15,14 +15,16 @@ To consult your Object Storage metrics and logs, refer to the [dedicated documen Cockpit collects the following metrics: -- `object_storage_bucket_bandwidth_egress_bytes`: Total number of bytes sent from the bucket to clients (outbound traffic). -- `object_storage_bucket_bandwidth_ingress_bytes`: Total number of bytes received by the bucket from clients (inbound traffic). -- `object_storage_bucket_http_response_time_seconds_bucket`: Distribution of HTTP response times for bucket operations, grouped into time buckets. -- `object_storage_bucket_http_response_time_seconds_count`: Total count of HTTP responses for bucket operations. -- `object_storage_bucket_http_response_time_seconds_sum`: Cumulative sum of HTTP response times for bucket operations. -- `object_storage_bucket_objects_total`: Total number of objects currently stored in the bucket. -- `object_storage_bucket_parts_total`: Total number of multipart upload parts present in the bucket. -- `object_storage_bucket_usage_bytes_total`: Total storage space used by all objects in the bucket, in bytes. +| Metric Name | Description | Unit | Refresh Frequency | +|--------------------------------------------------|-----------------------------------------------------------------------------|--------|-------------------| +| `object_storage_bucket_bandwidth_egress_bytes` | Total number of bytes sent from the bucket to clients (outbound traffic). | Bytes | 1 minute | +| `object_storage_bucket_bandwidth_ingress_bytes` | Total number of bytes received by the bucket from clients (inbound traffic).| Bytes | 1 minute | +| `object_storage_bucket_http_response_time_seconds_bucket` | Distribution of HTTP response times for bucket operations, grouped into time buckets. | Seconds | 1 minute | +| `object_storage_bucket_http_response_time_seconds_count` | Total count of HTTP responses for bucket operations. | Count | 1 minute | +| `object_storage_bucket_http_response_time_seconds_sum` | Cumulative sum of HTTP response times for bucket operations. | Seconds | 1 minute | +| `object_storage_bucket_objects_total` | Total number of objects currently stored in the bucket. | Count | 5 minutes | +| `object_storage_bucket_parts_total` | Total number of multipart upload parts present in the bucket. | Count | 5 minutes | +| `object_storage_bucket_usage_bytes_total` | Total storage space used by all objects in the bucket, in bytes. | Bytes | 5 minutes | ## Logs collected by Cockpit From 170305aa7aafefa7a0c2ba82d438802126a36d93 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 30 Sep 2025 11:35:06 +0200 Subject: [PATCH 5/9] feat(obj): update --- pages/object-storage/how-to/monitor-consumption.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pages/object-storage/how-to/monitor-consumption.mdx b/pages/object-storage/how-to/monitor-consumption.mdx index c809230282..6ef854f12c 100644 --- a/pages/object-storage/how-to/monitor-consumption.mdx +++ b/pages/object-storage/how-to/monitor-consumption.mdx @@ -46,3 +46,7 @@ To view your Object Storage metrics and logs, use the Grafana dashboard, which i Your Object Storage metrics and logs dashboards are also accessible from the console via the **Metrics** and **Logs** tabs of a bucket. + +## Collected metrics and logs + +Refer to the [dedicated documentation](/object-storage/reference-content/logs-metrics-collection-cockpit/) for more information on metrics and logs collected by Cockpit for Object Storage From 0c33988294128b68f9c8cc0a12a808c02ebd5e5e Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 30 Sep 2025 14:01:11 +0200 Subject: [PATCH 6/9] feat(obj): update --- .../logs-metrics-collection-cockpit.mdx | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx index 6006ddb085..8f06679242 100644 --- a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -13,30 +13,30 @@ To consult your Object Storage metrics and logs, refer to the [dedicated documen ## Metrics collected by Cockpit -Cockpit collects the following metrics: +Cockpit collects the following metrics for each Object Storage bucket: | Metric Name | Description | Unit | Refresh Frequency | |--------------------------------------------------|-----------------------------------------------------------------------------|--------|-------------------| -| `object_storage_bucket_bandwidth_egress_bytes` | Total number of bytes sent from the bucket to clients (outbound traffic). | Bytes | 1 minute | -| `object_storage_bucket_bandwidth_ingress_bytes` | Total number of bytes received by the bucket from clients (inbound traffic).| Bytes | 1 minute | -| `object_storage_bucket_http_response_time_seconds_bucket` | Distribution of HTTP response times for bucket operations, grouped into time buckets. | Seconds | 1 minute | -| `object_storage_bucket_http_response_time_seconds_count` | Total count of HTTP responses for bucket operations. | Count | 1 minute | -| `object_storage_bucket_http_response_time_seconds_sum` | Cumulative sum of HTTP response times for bucket operations. | Seconds | 1 minute | -| `object_storage_bucket_objects_total` | Total number of objects currently stored in the bucket. | Count | 5 minutes | -| `object_storage_bucket_parts_total` | Total number of multipart upload parts present in the bucket. | Count | 5 minutes | -| `object_storage_bucket_usage_bytes_total` | Total storage space used by all objects in the bucket, in bytes. | Bytes | 5 minutes | +| `object_storage_bucket_objects_total` | Total number of objects currently stored in the bucket. | Objects | 1 hour | +| `object_storage_bucket_usage_bytes_total` | Total storage space used by all objects in the bucket, in bytes. | Bytes | 1 hour | +| `object_storage_bucket_parts_total` | Total number of multipart upload parts present in the bucket. | Parts | 1 hour | +| `object_storage_bucket_bandwidth_egress_bytes` | Total number of bytes sent from the bucket to clients (outbound traffic). | KB/MB per day | 1 minute | +| `object_storage_bucket_bandwidth_ingress_bytes` | Total number of bytes received by the bucket from clients (inbound traffic).| KB/MB per day | 1 minute | +| `object_storage_bucket_http_response_time_seconds_bucket` | Distribution of HTTP response times for bucket operations. | s/ms | 1 minute | +| `object_storage_bucket_http_response_time_seconds_count` | Total count of HTTP responses for bucket operations. | min/s/ms | 1 minute | +| `object_storage_bucket_http_response_time_seconds_sum` | Cumulative sum of HTTP response times for bucket operations. | s/ms | 1 minute | ## Logs collected by Cockpit -Cockpit collects the following logs: +Cockpit collects the following logs for each request received by Object Storage buckets: - `@timestamp`: The exact time when the log entry was recorded. -- `hp.res.header.s3`: The specific S3 API operation performed (e.g., GetObject, PutObject). -- `hp.res.header.account`: The ProjectID associated with the request. -- `hp.req.uri`: The URI path of the HTTP request made to the bucket. -- `hp.req.method`: The HTTP method used for the request (e.g., GET, PUT, DELETE). -- `hp.res.status_code`: The HTTP status code returned in response to the request. -- `hp.req.header.host`: The value of the HTTP Host header in the request. -- `hp.res.header.bucket`: The name of the bucket targeted by the request. -- `hp.res.header.txid`: The unique transaction ID assigned to the request. -- `hp.net.client_ip`: The source IP address from which the request originated. \ No newline at end of file +- `s3_call`: The specific S3 API operation performed (e.g., GetObject, PutObject). +- `project_id`: The ProjectID associated with the request. +- `URI`: The URI path of the HTTP request made to the bucket. +- `http_method`: The HTTP method used for the request (e.g., GET, PUT, DELETE). +- `http_status_code`: The HTTP status code returned in response to the request. +- `http_host`: The value of the HTTP Host header in the request. +- `bucket`: The name of the bucket targeted by the request. +- `txid`: The unique transaction ID assigned to the request. +- `source_ip`: The source IP address from which the request originated. From b93d7bf5c6921f9f387b2c19c345ac5e6dd3411b Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 10 Oct 2025 17:23:21 +0200 Subject: [PATCH 7/9] feat(obj): tech review --- .../reference-content/logs-metrics-collection-cockpit.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx index 8f06679242..13ae4cd6c3 100644 --- a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -9,7 +9,7 @@ dates: Scaleway Object Storage automatically sends detailed logs and metrics to [Scaleway Cockpit](/cockpit/) for monitoring, observability, and auditing purposes. -To consult your Object Storage metrics and logs, refer to the [dedicated documentation](/object-storage/how-to/monitor-consumption/). +To find out how to consult your Object Storage metrics and logs, refer to the [dedicated documentation](/object-storage/how-to/monitor-consumption/). ## Metrics collected by Cockpit @@ -26,6 +26,10 @@ Cockpit collects the following metrics for each Object Storage bucket: | `object_storage_bucket_http_response_time_seconds_count` | Total count of HTTP responses for bucket operations. | min/s/ms | 1 minute | | `object_storage_bucket_http_response_time_seconds_sum` | Cumulative sum of HTTP response times for bucket operations. | s/ms | 1 minute | + +Each metric collected by Cockpit includes a `resource-id` that identifies the specific bucket it originates from. + + ## Logs collected by Cockpit Cockpit collects the following logs for each request received by Object Storage buckets: From fb0f726d59e1e68531431ae7c8a4d564e0cfa144 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 14 Oct 2025 15:35:41 +0200 Subject: [PATCH 8/9] Update pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx Co-authored-by: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> --- .../reference-content/logs-metrics-collection-cockpit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx index 13ae4cd6c3..95db60a890 100644 --- a/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx +++ b/pages/object-storage/reference-content/logs-metrics-collection-cockpit.mdx @@ -7,7 +7,7 @@ dates: posted: 2025-09-25 --- -Scaleway Object Storage automatically sends detailed logs and metrics to [Scaleway Cockpit](/cockpit/) for monitoring, observability, and auditing purposes. +Scaleway Object Storage automatically sends detailed logs and metrics to [Scaleway Cockpit](/cockpit/) for monitoring, observability, and auditing purposes. To find out how to consult your Object Storage metrics and logs, refer to the [dedicated documentation](/object-storage/how-to/monitor-consumption/). From 54020e8f14d35ce48ab3d04cc8b7619a5c2cfd59 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Tue, 14 Oct 2025 15:45:07 +0200 Subject: [PATCH 9/9] feat(obj): rebase fix --- pages/object-storage/menu.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pages/object-storage/menu.ts b/pages/object-storage/menu.ts index c19c8ee907..d5e4593493 100644 --- a/pages/object-storage/menu.ts +++ b/pages/object-storage/menu.ts @@ -197,6 +197,10 @@ export const objectStorageMenu = { label: 'Supported checksums', slug: 'supported-checksums', }, + { + label: 'Logs and metrics collected by Cockpit', + slug: 'logs-metrics-collection-cockpit', + }, ], label: 'Additional Content', slug: 'reference-content',