Skip to content

Commit 41e4801

Browse files
authored
docs: Fix incorrect status message deduplication claim (#859)
- Remove the incorrect claim that the SDK deduplicates status message API calls (it doesn't — `set_status_message()` always calls the API) - Replace the misleading "(separate from logs)" note with accurate behavior: when running locally, the SDK logs the status message instead of sending it to the platform - Apply the same fix to the versioned docs snapshot - Context: flagged during review of apify/apify-sdk-js#586 by @barjin
1 parent 390ccaf commit 41e4801

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

docs/02_concepts/01_actor_lifecycle.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,10 @@ Before triggering a reboot, persist any essential state externally (e.g., to the
9797

9898
## Status message
9999

100-
[Status messages](https://docs.apify.com/platform/actors/development/programming-interface/status-messages) are lightweight, human-readable progress indicators displayed with the Actor run on the Apify platform (separate from logs). Use them to communicate high-level phases or milestones, such as "Fetching list", "Processed 120/500 pages", or "Uploading results".
100+
[Status messages](https://docs.apify.com/platform/actors/development/programming-interface/status-messages) are lightweight, human-readable progress indicators displayed with the Actor run in Apify Console. Use them to communicate high-level phases or milestones, such as "Fetching list", "Processed 120/500 pages", or "Uploading results". When running locally, the SDK logs the status message instead of sending it to the platform.
101101

102102
Update the status only when the user's understanding of progress changes - avoid frequent updates for every processed item. Detailed information should go to logs or storages (dataset, key-value store) instead.
103103

104-
The SDK optimizes updates by sending an API request only when the message text changes, so repeating the same message incurs no additional cost.
105-
106104
<RunnableCodeBlock className="language-python" language="python">{StatusMessageExample}</RunnableCodeBlock>
107105

108106
## Conclusion

website/versioned_docs/version-3.3/02_concepts/01_actor_lifecycle.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,10 @@ Before triggering a reboot, persist any essential state externally (e.g., to the
9797

9898
## Status message
9999

100-
[Status messages](https://docs.apify.com/platform/actors/development/programming-interface/status-messages) are lightweight, human-readable progress indicators displayed with the Actor run on the Apify platform (separate from logs). Use them to communicate high-level phases or milestones, such as "Fetching list", "Processed 120/500 pages", or "Uploading results".
100+
[Status messages](https://docs.apify.com/platform/actors/development/programming-interface/status-messages) are lightweight, human-readable progress indicators displayed with the Actor run in Apify Console. Use them to communicate high-level phases or milestones, such as "Fetching list", "Processed 120/500 pages", or "Uploading results". When running locally, the SDK logs the status message instead of sending it to the platform.
101101

102102
Update the status only when the user's understanding of progress changes - avoid frequent updates for every processed item. Detailed information should go to logs or storages (dataset, key-value store) instead.
103103

104-
The SDK optimizes updates by sending an API request only when the message text changes, so repeating the same message incurs no additional cost.
105-
106104
<RunnableCodeBlock className="language-python" language="python">{StatusMessageExample}</RunnableCodeBlock>
107105

108106
## Conclusion

0 commit comments

Comments
 (0)