Skip to content

Commit 249f954

Browse files
svrnmchalin
andauthored
Add a warning to browser getting started (open-telemetry#3125)
Co-authored-by: Patrice Chalin <[email protected]>
1 parent 929ab15 commit 249f954

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

content/en/docs/instrumentation/js/_index.md

+3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ weight: 20
1111

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

14+
{{% alert title="Warning" color="warning" %}}
15+
{{% _param notes.browser-instrumentation %}} {{% /alert %}}
16+
1417
## Further Reading
1518

1619
- [OpenTelemetry for JavaScript on GitHub](https://github.com/open-telemetry/opentelemetry-js)

content/en/docs/instrumentation/js/getting-started/browser.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ aliases: [/docs/js/getting_started/browser]
44
weight: 20
55
---
66

7+
{{% alert title="Warning" color="warning" %}}
8+
{{% _param notes.browser-instrumentation %}} {{% /alert %}}
9+
710
While this guide uses the example application presented below, the steps to
811
instrument your own application should be similar.
912

content/en/docs/instrumentation/js/manual.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -332,15 +332,7 @@ above, you have a `TracerProvider` setup for you already. You can continue with
332332
#### Browser
333333

334334
{{% alert title="Warning" color="warning" %}}
335-
336-
Instrumentation for the browser is experimental and this is mostly unspecified:
337-
this may break in the future. If you want to help changing that, you can join
338-
the Client Instrumentation SIG on CNCF Slack channel
339-
[#otel-client-side-telemetry](https://cloud-native.slack.com/archives/C0239SYARD2)
340-
or by attending
341-
[their meetings](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit)
342-
343-
{{% /alert %}}
335+
{{% _param notes.browser-instrumentation %}} {{% /alert %}}
344336

345337
First, ensure you've got the right packages:
346338

hugo.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,9 @@ params:
171171
docker-compose-v2: |
172172
`docker-compose` is deprecated. For details, see
173173
[Migrate to Compose V2](https://docs.docker.com/compose/migrate/).
174+
browser-instrumentation: |
175+
Client instrumentation for the browser is **experimental** and mostly **unspecified**. If you are interested in
176+
helping out, get in touch with the [Client Instrumentation SIG](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit)
174177
175178
services:
176179
googleAnalytics:

0 commit comments

Comments
 (0)