DOCS-3499: Improve capture edge data #3956
Conversation
viambot
added
the
safe to build
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| - A data management {{< glossary_tooltip term_id="service" text="service" >}} that writes captured data to local edge device storage and syncs that data with the cloud. | ||
| - Individual {{< glossary_tooltip term_id="resource" text="resource" >}} configurations that specify what data to capture and how often. | ||
|
|
||
| ## How data capture and data sync works |
There was a problem hiding this comment.
Please make sure there is at least an intro sentence when you have bullet points.
Worth considering if the explanation of how it works is actually what's needed this early in the page. Do we expect people to come here primarily for setup or for explanation?
There was a problem hiding this comment.
IMO the old page was very setup oriented so I think more of an explanation is worth trying and presenting to eliot
There was a problem hiding this comment.
I don't view them as mutually exclusive; imo a quick overview / explanation of the system before getting into specific set up steps helps contextualize the set up work
There was a problem hiding this comment.
Sounds good. It's always a trade off between context and pushing the content people may be trying to get to below the fold. If you both in the future want to check data on this you can always look at clarity data.
only other consideration is whether you want to link to the more detailed how capture & sync works page. Please feel free to resolve once you've considered this
| - Data is synced to the Viam cloud at a configured sync interval using encrypted gRPC calls and deleted from the disk once synced. | ||
| - You can capture and sync data independently, one can run without the other. | ||
|
|
||
| ## Set up data capture and data sync |
There was a problem hiding this comment.
Headings should never be followed by another heading like this without text in between. This generally indicates a content design issue.
In this case I wouldn't be surprised it you'd also find that people accidentally skip the step to add the data mgmt service. There is nothing helping the reader to avoid this from happening so when they're just skimming, they could easily miss it.
There was a problem hiding this comment.
thank you for the explanation!
| The data management service is responsible for: | ||
|
|
||
| - Writing data from your configured Viam resources to local storage on your edge device | ||
| - Syncing data from the edge device to the cloud |
There was a problem hiding this comment.
This is explanatory content that you've put with a heading where readers would expect pragmatic content. This info should likely be with the "How data capture and data sync works" section.
| To start, configure the data management service to capture and sync data. | ||
| Data capture and sync in Viam involves two key pieces: | ||
|
|
||
| - A data management {{< glossary_tooltip term_id="service" text="service" >}} that writes captured data to local edge device storage and syncs that data with the cloud. |
There was a problem hiding this comment.
Unless this has changed, there can only be one data management service, that's why it should be a definite article.
|
|
||
| ## Configure data capture | ||
| Configure data capture for individual resources by: |
There was a problem hiding this comment.
I think you need to add where they'd do this though.
There was a problem hiding this comment.
I think those instructions are right below in the tabs. Do we need to repeat them twice?
|
|
||
| The following components and services support data capture and cloud sync: | ||
| ### Direct to MongoDB capture |
There was a problem hiding this comment.
I don't understand this headline - maybe "Capture directly to MongoDB"?
| You can configure direct capture of tabular data to a MongoDB instance alongside disk storage on your edge device. | ||
| This can be useful for powering real-time dashboards before data is synced from the edge to the cloud. | ||
|
|
||
| Configure using `mongo_capture_config` attributes in your data manager service. |
Co-authored-by: Naomi Pentrel <[email protected]>
| ## Stop data capture | ||
|
|
||
| If this is a test project, make sure you stop data capture to avoid charges for a large amount of unwanted data. | ||
| If you don't need to capture data, for instance in a test scenario, you can turn off data capture to reduce unnecessary storage. | ||
| Alternatively, see [advanced data capture and sync configurations](/data-ai/capture-data/capture-sync/#advanced-data-capture-and-sync-configurations) for other ways to control data usage, such as conditional sync or retention policies. |
There was a problem hiding this comment.
@jdamon96 did you want to keep this section above? I'm in favor of keeping it along with the text you added below
There was a problem hiding this comment.
yes - along w/ the text added - agree!
npentrel
dismissed
their stale review
Dismissing for now - will re-review once finalized
| @@ -705,25 +671,102 @@ To view all the captured data you have access to, go to the [**DATA** tab](https | |||
|
|
|||
| You can also access data from a resource or machine part menu. | |||
There was a problem hiding this comment.
Can we lift this above the 'Stop data capture' section? imo that order makes more sense
There was a problem hiding this comment.
integrating Devin's feedback re also informing user how to stop data sync, perhaps we should update the header to below & then add the equivalent language of how to toggle off data sync (+ intro comma phrases now that we're describing both), e.g.:
Stop data capture and sync
To turn off data capture for a specific resource's capture method (e.g., a Camera component capturing via the GetImage capture method) navigate to the Data capture section of your resource's configuration card and toggle the configured capture method's switch to Off . You can also globally turn off data capture on the data manager service configuration card by toggling the Capturing switch to Off.
To turn off data sync, navigate to the data manager service configuration card and toggle the Syncing switch to Off.
Click the Save button in the top right corner of the page to save your config.
|
|
||
| If you have captured data that you do not want to sync, delete the data on the machine before resuming cloud sync. | ||
| To delete the data locally, `ssh` into your machine and delete the data in the directory where you capture data. | ||
| - **Retain data up to a certain size or for a specific length of time:** Set `retention_policies` at the resource level. |
There was a problem hiding this comment.
i think it'd be helpful to add quick parenthetical examples here:
- Retain data up to a certain size (e.g., 100GB) or for a specific length of time (e.g., 14 days):
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)' |
Working with Jack/Devin