Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-3095] - local mongo collection #3673

Merged

Conversation

nicksanford
Copy link
Member

Ticket

  1. Document the Capture Directly to MongoDB feature.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Nov 13, 2024
Comment on lines 232 to 277
| `mongo_capture_config.uri` | string | Optional | The [MongoDB URI](https://www.mongodb.com/docs/v6.2/reference/connection-string/) data capture will attempt to write tabular data to after it is enqueued to be written to disk. When non empty, data capture will capture tabular data to the configured MongoDB database & collection at that URI.<br>See `mongo_capture_config.database` and `mongo_capture_config.collection` below for database & collection defaults. | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
| `mongo_capture_config.database` | string | Optional | When `mongo_capture_config.uri` is non empty, changes the database data capture will write tabular data to. <br> Default: `"sensorData"` | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
| `mongo_capture_config.collection` | string | Optional | When `mongo_capture_config.uri` is non empty, changes the collection data capture will write tabular data to.<br> Default: `"readings"` | <p class="center-text"><i class="fas fa-times" title="no"></i></p> |
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question for the docs team: Is this the proper way to document a config attribute which is an object with multiple fields? I wasn't sure how best to document each field of the mongo_capture_config object.

@nicksanford nicksanford mentioned this pull request Nov 13, 2024
@nicksanford nicksanford force-pushed the DOCS-3095-local-mongo-collection branch from 79202c8 to 2e21eab Compare November 13, 2024 18:30
Copy link
Member

@dmhilly dmhilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technical explanations LGTM! Thanks for doing this.

Copy link
Member

@n0nick n0nick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I only had a few style fixes / trying to align terminology with the rest of the page. Thank you!!

docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
docs/services/data/_index.md Outdated Show resolved Hide resolved
@nicksanford nicksanford force-pushed the DOCS-3095-local-mongo-collection branch from d0ad9ed to fcd6669 Compare November 14, 2024 15:15
Copy link
Collaborator

@sguequierre sguequierre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks nick!

This feature is intended to support use cases like offline dashboards which don't require strong data
delivery or consistency guarantees.

Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI
Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI as well as to the `~/.viam/capture` directory on disk:

delivery or consistency guarantees.

Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI
as well as to the Viam capture directory on disk:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
as well as to the Viam capture directory on disk:

docs/services/data/_index.md Outdated Show resolved Hide resolved
Co-authored-by: Sierra Guequierre <[email protected]>
@nicksanford nicksanford self-assigned this Nov 14, 2024
@viambot
Copy link
Member

viambot commented Nov 14, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3673

@nicksanford nicksanford merged commit 100547b into viamrobotics:main Nov 14, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants