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.

Sign up for GitHub

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

Add a warning to browser getting started #3125

Merged
merged 3 commits into from
Aug 3, 2023
Merged

Add a warning to browser getting started #3125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a0e8b1
Add a warning to browser getting started
svrnm Aug 2, 2023
c51e91f
Update content/en/docs/instrumentation/js/getting-started/browser.md
svrnm Aug 3, 2023
f3935c2
Put note into hugo.yaml
svrnm Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions content/en/docs/instrumentation/js/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ weight: 20

{{% docs/instrumentation/index-intro js /%}}

{{% alert title="Warning" color="warning" %}}
{{% _param notes.browser-instrumentation %}} {{% /alert %}}

## Further Reading

- [OpenTelemetry for JavaScript on GitHub](https://github.com/open-telemetry/opentelemetry-js)
Expand Down
3 changes: 3 additions & 0 deletions content/en/docs/instrumentation/js/getting-started/browser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ aliases: [/docs/js/getting_started/browser]
weight: 20
---

{{% alert title="Warning" color="warning" %}}
{{% _param notes.browser-instrumentation %}} {{% /alert %}}

While this guide uses the example application presented below, the steps to
instrument your own application should be similar.

Expand Down
10 changes: 1 addition & 9 deletions content/en/docs/instrumentation/js/manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,15 +332,7 @@ above, you have a `TracerProvider` setup for you already. You can continue with
#### Browser

{{% alert title="Warning" color="warning" %}}

Instrumentation for the browser is experimental and this is mostly unspecified:
this may break in the future. If you want to help changing that, you can join
the Client Instrumentation SIG on CNCF Slack channel
[#otel-client-side-telemetry](https://cloud-native.slack.com/archives/C0239SYARD2)
or by attending
[their meetings](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit)

{{% /alert %}}
{{% _param notes.browser-instrumentation %}} {{% /alert %}}

First, ensure you've got the right packages:

Expand Down
3 changes: 3 additions & 0 deletions hugo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@ params:
docker-compose-v2: |
`docker-compose` is deprecated. For details, see
[Migrate to Compose V2](https://docs.docker.com/compose/migrate/).
browser-instrumentation: |
Client instrumentation for the browser is **experimental** and mostly **unspecified**. If you are interested in
helping out, get in touch with the [Client Instrumentation SIG](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit)
Copy link
Contributor

Choose a reason for hiding this comment

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

Oops, missed that: this sentence should end with a period.

Copy link
Member Author

Choose a reason for hiding this comment

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

let's have a follow up PR then for the period.

Copy link
Contributor

Choose a reason for hiding this comment

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

See #3134.


services:
googleAnalytics:
Expand Down