update doc comment

Author: lalitb

opentelemetry-sdk/src/logs/log_processor.rs

@@ -264,20 +264,21 @@ type LogsData = Box<(LogRecord, InstrumentationScope)>;
 ///     .with_log_processor(processor)
 ///     .build();
 ///
-/// 
+///
 // **Memory Management in BatchLogProcessor**
 //
 // The `BatchLogProcessor` manages memory through the following stages of log processing:
 //
 // 1. **Record Ingestion**:
 //    - Each `LogRecord` is **cloned** upon entering the processor.
 //    - `LogRecordAttributes` utilize a hybrid memory model:
-//      - Attributes up to `PREALLOCATED_ATTRIBUTE_CAPACITY` are **stack-allocated**.
-//      - Exceeding attributes trigger **heap allocation** in a dynamically growing vector.
+//      - First 5 attributes are **stack-allocated**.
+//      - Adding additional attribtues trigger **heap allocation** in a dynamically growing vector.
 //    - The `LogRecord` and its associated `InstrumentationScope` are **boxed together**
 //      to allocate them on the heap before entering the queue. This means:
-//      - The entire `LogRecord` object, including its stack-allocated inline attributes, is moved to the heap.
-//      - Any overflow attributes already on the heap remain unaffected.
+//      - The `LogRecord`'s inline attributes (if any) are moved to the heap as part of the boxed structure.
+//      - Any dynamically allocated data already on the heap (e.g., strings, overflow attributes) remains unaffected.
+//      - Ownership of the boxed data is transferred to the queue, ensuring it can be processed independently of the original objects.
 //
 // 2. **Queue Management**:
 //    - Uses **two bounded synchronous channels** (`sync_channel`):
@@ -311,19 +312,19 @@ type LogsData = Box<(LogRecord, InstrumentationScope)>;
 //    - During the export process:
 //        - The worker thread retrieves records from the log record queue until `max_export_batch_size` is reached or the queue is empty.
 //        - The retrieved records are processed in batches and passed to the exporter.
-//    - The `ExportLog` message in the control queue explicitly triggers an export operation:
-//        - It is generated when the current batch size reaches `max_export_batch_size`.
-//        - A flag ensures only one `ExportLog` message is sent at a time to prevent redundant processing.
-//        - This message prompts the worker thread to process and export the current batch immediately, regardless of the scheduled delay.
 //    - The exporter's `export()` method receives references to the log records and `InstrumentationScope`.
 //        - If the exporter requires retaining the log records (e.g., for retries or asynchronous operations), it must **clone** the records inside the `export()` implementation.
 //    - After successful export:
 //        - The original boxed records are dropped, releasing heap memory.
 //    - Export is triggered in the following scenarios:
-//        - When the batch size reaches `max_export_batch_size`.
+//        - When the batch size reaches `max_export_batch_size`, resulting in `ExportLog` control message being sent to the worker thread.
 //        - When the scheduled delay timer expires.
-//        - When `force_flush` is called.
-//        - During processor shutdown.
+//        - When `force_flush` is called by the application, resulting in a `ForceFlush` control message being sent to the worker thread.
+//        - During processor shutdown initiated by the application, resulting in a `Shutdown` control message being sent to the worker thread.
+//    - Generation of `ExportLog` control message:
+//        - The `ExportLog` control message is generated by the application thread when a new record is added to the log record queue, and the current batch size reaches `max_export_batch_size`.
+//        - To prevent redundant messages, the `ExportLog` message is only sent if the previous one has been processed by the worker thread.
+//        - Upon receiving this message, the worker thread immediately processes and exports the current batch, overriding any scheduled delay.
 //
 // 5. **Memory Limits**:
 //    - **Worst-Case Memory Usage**: