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: correct the build instructions #615

Merged
merged 2 commits into from Aug 14, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -24,13 +24,13 @@ This browser extension allows you to inject [OpenTelemetry](https://opentelemetr
Run the following in your shell to download and build the extension from source:

```shell
git clone https://github.com/svrnm/opentelemetry-browser-extension
cd opentelemetry-browser-extension
git clone https://github.com/open-telemetry/opentelemetry-js-contrib.git
cd opentelemetry-js-contrib/packages/opentelemetry-browser-extension-autoinjection
npm install
npm run compile
npm run build
```

This will create a so called unpacked extension into the `build/` folder you now can load into your browser:
This will create a so-called unpacked extension into the `build/` folder you now can load into your browser:

* Open a new browser window and go to chrome://extensions
* Turn on "Developer Mode"
Expand Down Expand Up @@ -58,4 +58,4 @@ Click on `Save & Reload`, check the developer toolbar to see how spans being are

3. Firefox support is unstable, sometimes it works, sometimes not. If you have experience building extensions for firefox, please reach out.

4. The website you are targeting with this extension might have a [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) (CSP) in place and block the extension from injecting javascript or block the exporters from sending spans to a collector. To work around this limitation, you need another browser extension, that allows you to disable CSP for a website.
4. The website you are targeting with this extension might have a [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) (CSP) in place and block the extension from injecting javascript or block the exporters from sending spans to a collector. To work around this limitation, you need another browser extension, that allows you to disable CSP for a website.