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

📝 [RUM-5172] add react integration documentation #2873

Merged
merged 5 commits into from
Jul 19, 2024

Conversation

BenoitZugmeyer
Copy link
Member

@BenoitZugmeyer BenoitZugmeyer commented Jul 18, 2024

Motivation

Document how to use the react integration. See it rendered: https://github.com/DataDog/browser-sdk/blob/benoit/react-doc/packages/rum-react/README.md

Changes

Add documentation to the README

Testing

  • Local
  • Staging
  • Unit
  • End to end

I have gone over the contributing documentation.

@BenoitZugmeyer BenoitZugmeyer requested review from a team as code owners July 18, 2024 10:27
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
Copy link

cit-pr-commenter bot commented Jul 18, 2024

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum 161.62 KiB 161.62 KiB 0 B 0.00%
Logs 57.95 KiB 57.95 KiB 0 B 0.00%
Rum Slim 110.14 KiB 110.14 KiB 0 B 0.00%
Worker 25.21 KiB 25.21 KiB 0 B 0.00%
🚀 CPU Performance
Action Name Base Average Cpu Time (ms) Local Average Cpu Time (ms) 𝚫
addglobalcontext 0.001 0.001 0.000
addaction 0.030 0.033 0.003
adderror 0.031 0.037 0.006
addtiming 0.001 0.001 0.000
startview 0.913 1.162 0.248
startstopsessionreplayrecording 0.780 1.027 0.247
logmessage 0.019 0.021 0.002
🧠 Memory Performance
Action Name Base Consumption Memory (bytes) Local Consumption Memory (bytes) 𝚫 (bytes)
addglobalcontext 20.46 KiB 19.79 KiB -687 B
addaction 72.73 KiB 71.82 KiB -931 B
adderror 86.60 KiB 88.72 KiB 2.13 KiB
addtiming 19.47 KiB 18.78 KiB -703 B
startview 349.22 KiB 352.59 KiB 3.37 KiB
startstopsessionreplayrecording 14.21 KiB 14.34 KiB 125 B
logmessage 70.55 KiB 70.39 KiB -161 B

🔗 RealWorld

Copy link
Contributor

@jhgilbert jhgilbert left a comment

Choose a reason for hiding this comment

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

I left some comments for style. Let me know when you'd like another look. Thank you!

packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Jul 18, 2024

Library Vulnerabilities

Critical badge

@BenoitZugmeyer BenoitZugmeyer requested a review from jhgilbert July 18, 2024 16:08
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.67%. Comparing base (2490414) to head (a919bf4).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2873      +/-   ##
==========================================
- Coverage   93.68%   93.67%   -0.02%     
==========================================
  Files         266      266              
  Lines        7584     7584              
  Branches     1687     1687              
==========================================
- Hits         7105     7104       -1     
- Misses        479      480       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
packages/rum-react/README.md Outdated Show resolved Hide resolved
@BenoitZugmeyer BenoitZugmeyer merged commit 0c2af27 into main Jul 19, 2024
20 checks passed
@BenoitZugmeyer BenoitZugmeyer deleted the benoit/react-doc branch July 19, 2024 15:53
RomanGaignault pushed a commit that referenced this pull request Jul 23, 2024
* 📝 [RUM-5172] add react integration documentation

* Apply suggestions from code review

Co-authored-by: Nicolas Ulrich <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jen Gilbert <[email protected]>

* use link references

* Apply suggestions from code review

Co-authored-by: Thomas Lebeau <[email protected]>

---------

Co-authored-by: Nicolas Ulrich <[email protected]>
Co-authored-by: Jen Gilbert <[email protected]>
Co-authored-by: Thomas Lebeau <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants