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-1798: Add performance metrics capture #2607

Merged
merged 6 commits into from
Mar 27, 2024

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Mar 1, 2024

Hey @ale7714 and @MirandaKapin, I'm thinking of adding this page to make it especially easy to use the new module:
https://docs-test.viam.dev/2607/data/capture/performance-metrics/

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Mar 1, 2024
@viambot
Copy link
Member

viambot commented Mar 1, 2024

Overall readability score: 55.59 (🟢 +0)

File Readability
performance-metrics.md 52.16 (-)
sensor-control.md 58.51 (🟢 +1.44)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
performance-metrics.md 52.16 44.75 10.88 13.7 12.93 7.82
  - - - - - -
sensor-control.md 58.51 56.96 9.44 11.2 12.06 8.75
  🟢 +1.44 🔴 -0.31 🔴 -0.03 🟢 +0.3 🟢 +0.58 🟢 +0.09

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.59 47.43 10.64 13.22 12.08 7.61
  🟢 +0 🔴 -0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@npentrel npentrel requested review from ale7714 and MirandaKapin March 4, 2024 09:47
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.

This is very cool-- some small fixes and suggestions otherwise LGTM!

docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
2. Then select the `viam:viam-sensor:telegrafsensor` model from the [`viam-telegraf-sensor` module](https://app.viam.com/module/viam/viam-telegraf-sensor).
3. Click **Add module**, then enter a name for your sensor, for example `my-telegrafsensor`, and click **Create**.

In the next step you will configure the data manager to capture and sync the performance metrics from your configured sensor.
Copy link
Collaborator

Choose a reason for hiding this comment

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

(opt) I would veer on the side of referring to it as data management service consistently. Also not sure if this sentence is necessary although it does provide a bit of a transition. Maybe consider line 43 before 41?

docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
docs/data/capture/performance-metrics.md Outdated Show resolved Hide resolved
npentrel and others added 2 commits March 26, 2024 18:37
@npentrel npentrel requested a review from sguequierre March 26, 2024 17:41
@npentrel
Copy link
Collaborator Author

@sguequierre ready for re-review

@viambot
Copy link
Member

viambot commented Mar 26, 2024

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

@npentrel npentrel merged commit 4aa490b into viamrobotics:main Mar 27, 2024
10 checks passed
@npentrel npentrel deleted the DOCS-1798 branch March 27, 2024 13:40
sguequierre pushed a commit to sguequierre/docs that referenced this pull request Apr 25, 2024
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.

3 participants