[rum] added extra installation method in readme #571

hdelaby · 2020-10-16T13:20:22Z

Motivation

Release of async loading of the SDK

Changes

Added "Choosing the right installation method"
Added async code snippet

Testing

Only documentation modification.

I have gone over the contributing documentation.

hdelaby · 2020-10-16T13:30:00Z

@bcaudan Few details I am not sure about:

I want to remove the dd-action-name part from here, wdyt?
What about renaming bundle to RUM snippet or code snippet? I feel like bundle isn't really mainstream (I left both on purpose in the code)

bcaudan · 2020-10-16T16:05:49Z

@hdelaby

hum yes public API section has been trimmed in DOCS-1217 RUM Browser Monitoring #531, we could maybe add a specific .md for that
FMU, bundle refers to the sdk file and snippet to the inline js code. I'd rather go with something like:

# setup
## NPM
## CDN async
## CDN sync

codecov-io · 2020-10-20T09:29:59Z

Codecov Report

Merging #571 into master will increase coverage by 0.50%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #571      +/-   ##
==========================================
+ Coverage   88.13%   88.63%   +0.50%     
==========================================
  Files          46       46              
  Lines        2359     2359              
  Branches      492      492              
==========================================
+ Hits         2079     2091      +12     
+ Misses        280      268      -12

Impacted Files	Coverage Δ
packages/rum/src/browser/performanceCollection.ts	`68.57% <0.00%> (+1.42%)`	⬆️
packages/rum/src/transport/batch.ts	`82.92% <0.00%> (+9.75%)`	⬆️
packages/rum/src/domain/parentContexts.ts	`95.58% <0.00%> (+10.29%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 818210e...2b013b3. Read the comment docs.

BenoitZugmeyer · 2020-10-20T09:56:05Z

packages/logs/README.md

+### CDN sync
+
+```html
+<script src="https://www.datadoghq-browser-agent.com/datadog-logs.js">


This should be:

Suggested change

<script src="https://www.datadoghq-browser-agent.com/datadog-logs.js">

<script src="https://www.datadoghq-browser-agent.com/datadog-logs.js"></script>

I'll add a prettier-ignore comment line otherwise I think this commit will break the prettier CI check for later commits.

packages/rum/README.md

packages/logs/README.md

Co-authored-by: Benoît Zugmeyer <benoit.zugmeyer@datadoghq.com>

kayayarai

docs look good

bcaudan · 2020-10-22T12:29:07Z

packages/logs/README.md

@@ -15,7 +15,7 @@ With the `datadog-logs` library, you can send logs directly to Datadog from JS c

 **Datadog client token**: For security reasons, [API keys][1] cannot be used to configure the `datadog-logs` library, because they would be exposed client-side in the JavaScript code. To collect logs from web browsers, a [client token][2] must be used. See the [client token documentation][2] for more details.

-**Datadog browser log library**: Configure the library through [NPM](#npm) or use the [bundle](#bundle) directly in the head tag.
+**Datadog browser log library**: Configure the library through [NPM](#npm) or use the [CDN async](#cdn-async) or [CDN sync](#cdn-sync) code snippets in the head tag.


what about getting rid of all bundle references then?

In the normal doc you mean?

in this page at least, in other doc would be great as well

My latest commit should have removed the last reference of bundle :)

bcaudan · 2020-10-22T12:50:05Z

packages/rum/README.md

@@ -133,22 +171,6 @@ init(configuration: {
 })
 ```

-### Name click actions
-
-The RUM library uses various strategies to automatically name click actions. If you want more control, define a `data-dd-action-name` attribute on clickable elements (or any of their parents) to name the action, for example:


is it documented elsewhere?

I'll open a PR to add it in the normal doc.

…owser-agent into hdelaby/document-async-bundle

bcaudan

LGTM!

Hugo Delaby added 2 commits October 16, 2020 15:21

[rum] added extra installation method in readme

6ee9c7c

[rum] added choose the right installation method

c06b158

hdelaby force-pushed the hdelaby/document-async-bundle branch from cff29cb to c06b158 Compare October 16, 2020 13:22

[rum] updated logs setup

0f46bf5

Hugo Delaby added 5 commits October 20, 2020 11:20

[rum] remove action naming workaround from set up doc

ffa55fd

[rum] renamed bundle to CDN

e78ee74

[logs] renamed bundle to CDN

645ca36

fixed format

7d4505e

fixed format

e8dc0ff

Hugo Delaby added 4 commits October 20, 2020 11:32

fixed format

bbb13e2

prettier ignore

cc69cc0

fixed last style issue

739164b

Merge branch 'master' into hdelaby/document-async-bundle

2de12bd

hdelaby marked this pull request as ready for review October 20, 2020 09:48

hdelaby requested review from a team as code owners October 20, 2020 09:48

hdelaby mentioned this pull request Oct 20, 2020

DOCS-1257 Browser Log Collection #575

Merged

hdelaby requested a review from ruthnaebeck October 20, 2020 09:49

BenoitZugmeyer reviewed Oct 20, 2020

View reviewed changes

Hugo Delaby and others added 5 commits October 20, 2020 14:40

Update packages/rum/README.md

ba22f03

Co-authored-by: Benoît Zugmeyer <benoit.zugmeyer@datadoghq.com>

Update packages/logs/README.md

dea60e0

Co-authored-by: Benoît Zugmeyer <benoit.zugmeyer@datadoghq.com>

[logs] fixed CDN sync

69960a6

removed semicolon

135a988

Merge branch 'master' into hdelaby/document-async-bundle

28cb33c

kayayarai approved these changes Oct 21, 2020

View reviewed changes

Hugo Delaby added 2 commits October 22, 2020 13:52

Merge branch 'master' into hdelaby/document-async-bundle

3337a65

ran prettier on the file

341c2dc

bcaudan reviewed Oct 22, 2020

View reviewed changes

fix logs/rum mismatch

2b013b3

bcaudan reviewed Oct 22, 2020

View reviewed changes

Hugo Delaby added 3 commits October 22, 2020 18:40

removed last occurence of bundle

4358504

Merge branch 'master' into hdelaby/document-async-bundle

aaed79a

Merge branch 'hdelaby/document-async-bundle' of github.com:DataDog/br…

00e8bd5

…owser-agent into hdelaby/document-async-bundle

ruthnaebeck removed their request for review October 22, 2020 20:29

bcaudan approved these changes Oct 23, 2020

View reviewed changes

Merge branch 'master' into hdelaby/document-async-bundle

f3ad20f

hdelaby merged commit b0c414c into master Oct 23, 2020

hdelaby deleted the hdelaby/document-async-bundle branch October 23, 2020 08:59

hdelaby mentioned this pull request Oct 26, 2020

added content for RUM async method DataDog/documentation#8911

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[rum] added extra installation method in readme #571

[rum] added extra installation method in readme #571

hdelaby commented Oct 16, 2020

hdelaby commented Oct 16, 2020

bcaudan commented Oct 16, 2020

codecov-io commented Oct 20, 2020 •

edited

Loading

BenoitZugmeyer Oct 20, 2020

hdelaby Oct 20, 2020

kayayarai left a comment

bcaudan Oct 22, 2020

hdelaby Oct 22, 2020

bcaudan Oct 22, 2020

hdelaby Oct 22, 2020

bcaudan Oct 22, 2020

hdelaby Oct 22, 2020

bcaudan left a comment

	<script src="https://www.datadoghq-browser-agent.com/datadog-logs.js">
	<script src="https://www.datadoghq-browser-agent.com/datadog-logs.js"></script>

[rum] added extra installation method in readme #571

[rum] added extra installation method in readme #571

Conversation

hdelaby commented Oct 16, 2020

Motivation

Changes

Testing

hdelaby commented Oct 16, 2020

bcaudan commented Oct 16, 2020

codecov-io commented Oct 20, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kayayarai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bcaudan left a comment

Choose a reason for hiding this comment

codecov-io commented Oct 20, 2020 •

edited

Loading