Add SLI docs

Author: lukasz-wal

README.md

@@ -0,0 +1,9 @@
+# CDP – COMPLIANCE DATA PLATFORM documentation
+
+## Overview
+
+...
+
+## Documentation
+
+[SLI](docs/sli/README.md)

docs/sli/README.md

@@ -0,0 +1,87 @@
+# SLI - Exposing
+
+## Overview
+
+This Compliance Data Platform (CDP) collects and exposes Service Level Indicators (SLIs) about Storage Providers (SP) measured by Bandwidth Measure System (BMS) and managed by RPA services.
+
+---
+
+## Collecting SLI - Architecture
+
+```mermaid
+sequenceDiagram
+        participant CDP_SERVICE
+        participant CDP_SERVICE_DB@{ "type" : "database" }
+        participant RPA_SERVICE
+
+        CDP_SERVICE->>+CDP_SERVICE_DB: get list of SP
+        CDP_SERVICE_DB->>-CDP_SERVICE: return list of SP
+
+        CDP_SERVICE->>CDP_SERVICE: prepare chunks for RPA API
+
+        loop PER CHUNK
+            CDP_SERVICE->>+RPA_SERVICE: POST: /providers
+            RPA_SERVICE->>-CDP_SERVICE: return list of SP with data
+            CDP_SERVICE->>CDP_SERVICE: prepare SLI data to save
+
+        end
+
+        CDP_SERVICE->>+CDP_SERVICE_DB: save SLI data
+```
+
+---
+
+## Available SLIs
+
+List all Service Level Indicators.
+
+### TTFB
+
+- Name: TTFB
+- Description: Time to first byte
+- Unit: `ms`
+
+---
+
+### RPA_RETRIEVABILITY
+
+- Name: RPA Retrievability
+- Description: RPA Retrievability percentage
+- Unit: `%`
+
+---
+
+### BANDWIDTH
+
+- Name: Bandwidth
+- Description: Download bandwidth
+- Unit: `Mbps`
+
+---
+
+### CAR_FILES
+
+- Name: CAR files Retrievability
+- Description: CAR files retrievability percentage
+- Unit: `%`
+
+---
+
+### IPNI_REPORTING
+
+- Name: IPNI Reporting
+- Description: Percentage of days in the last month on which the storage provider successfully reported to IPNI
+- Unit: `%`
+
+---
+
+## Metrics Exposure
+
+- Endpoint: `GET storage-providers/average-monthly-sli`
+- Format: `JSON`
+- Example:
+
+```curl -X 'GET' \
+  https://cdp.allocator.tech/storage-providers/average-monthly-sli?storageProvidersIds=f03623017&storageProvidersIds=f03644168' \
+  -H 'accept: application/json'
+```

src/controller/storage-providers/storage-providers.controller.ts

@@ -563,7 +563,7 @@ export class StorageProvidersController extends ControllerBase {
       sliMetricType: StorageProviderUrlFinderSliMetricType.IPNI_REPORTING,
       sliMetricName: 'IPNI Reporting',
       sliMetricDescription:
-        'Whether the storage provider has reported to IPNI in the last month',
+        'Percentage of days in the last month on which the storage provider successfully reported to IPNI',
       sliMetricUnit: '%',
     };