Review feedback, add new attributes to specification.md

open-telemetry · Oct 23, 2024 · 3d03bdd · 3d03bdd
1 parent c037c2e
commit 3d03bdd
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/proto/opamp.proto b/proto/opamp.proto
@@ -817,7 +817,7 @@ message PackageDownloadDetails {
     double download_percent = 1;
 
     // The current package download rate in bytes per second.
-    uint64 download_rate = 2;
+    uint64 download_bytes_per_second = 2;
 }
 
 // The status of this package.

diff --git a/specification.md b/specification.md
@@ -88,6 +88,7 @@ Status: [Beta]
       - [PackageStatus.server_offered_hash](#packagestatusserver_offered_hash)
       - [PackageStatus.status](#packagestatusstatus)
       - [PackageStatus.error_message](#packagestatuserror_message)
+      - [PackageStatus.download_details](#packagestatusdownload_details)
   * [Connection Settings Management](#connection-settings-management)
     + [OpAMP Connection Setting Offer Flow](#opamp-connection-setting-offer-flow)
     + [Trust On First Use](#trust-on-first-use)
@@ -1310,11 +1311,14 @@ message PackageStatus {
     bytes server_offered_hash = 5;
     enum Status {
         INSTALLED = 0;
-        INSTALLING = 1;
-        INSTALL_FAILED = 2;
+        INSTALL_PENDING = 1;
+        INSTALLING = 2;
+        INSTALL_FAILED = 3;
+        DOWNLOADING = 4;
     }
     Status status = 6;
     string error_message = 7;
+    PackageDownloadDetails download_details = 8;
 }
 ```
 
@@ -1393,6 +1397,20 @@ failure.
 
 An error message if the status is erroneous.
 
+##### PackageStatus.download_details
+
+Status: [Development]
+
+The download_details contains additional details that descibe a package download.
+It should only be set if the status is `DOWNLOADING`.
+
+```protobuf
+message PackageDownloadDetails {
+  double download_percent = 1;
+  uint64 download_bytes_per_second = 2;
+}
+```
+
 ### Connection Settings Management
 
 Status: [Beta]