OpenTelemetry Browser Extension
+published builds available on:
+
+ *
+ 
+ *
+ 
+ ...or build it yourself!
+OpenTelemetry Browser Extension
+published builds available on:
+
+ *
+
+ *
+
+ ...or build it yourself!
+
-## Download
-
-| Browser | Link |
-|-|-|
-|Chrome|[Download it from the Chrome web store](https://chromewebstore.google.com/detail/opentelemetry-browser-ext/bgjeoaohfhbfabbfhbafjihbobjgniag)|
-
## Features
* Automatically instrument your webpages to collect traces and logs, sent to an OTLP-compatible collector
@@ -24,11 +30,11 @@ A [Plasmo](https://docs.plasmo.com/) browser extension that automatically instru
* Propagate b3 and w3c trace context to websites of your choosing (matched by regular expressions)
-## Browser support
+## Browser compatibility
-Currently, this extension has only been confirmed to work with compatible Chromium-based browsers (Chrome, Edge, etc) which support [manifest v3](https://developer.chrome.com/docs/extensions/develop/migrate/what-is-mv3) and `chrome.scripting.executeScript({ world: 'MAIN' })`.
+Because this extension relies on the use of `chrome.scripting.executeScript({ ... , world: 'MAIN' })`, it is only compatible with browsers which support the `MAIN` execution world as a parameter. Luckily, this seems to include every browser except Firefox ([where development to support the feature is in-progress](https://bugzilla.mozilla.org/show_bug.cgi?id=1736575)).
-## Getting Started
+## Developing
Initialize submodules (we use a custom build of Plasmo):
@@ -55,12 +61,34 @@ pnpm dev
Then, open your browser and load the appropriate development build. For example, if you're developing for Chrome, using manifest v3, use: `build/chrome-mv3-dev`.
-## Making production build
+## Making a production build
Run the following:
```bash
pnpm build
```
+or, for targeting a specific browser:
+
+```bash
+pnpm build:chrome
+# or
+pnpm build:safari
+# or
+pnpm build:edge
+```
Then, follow the same steps as with running the development server, but load the appropriate production build from the `build` directory, i.e: `build/chrome-mv3-prod`.
+
+### Safari
+
+Safari requires a bit of extra work. After building the extension, run the following command to convert the extension to a an XCode project:
+
+```bash
+cd build && xcrun safari-web-extension-converter safari-mv3-prod
+```
+
+Then, build the extension in XCode (using the MacOS target), and enable it in Safari
+
+> [!NOTE]
+> Safari requires extensions to be signed before they can be installed. You can either sign the extension yourself, or load it as an unsigned extension after enabling "allow unsigned extensions" in Safari's developer settings.
diff --git a/assets/chrome.svg b/assets/chrome.svg
new file mode 100644
index 0000000..4ff6ab6
--- /dev/null
+++ b/assets/chrome.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/assets/edge.svg b/assets/edge.svg
new file mode 100644
index 0000000..ccd0516
--- /dev/null
+++ b/assets/edge.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/assets/safari.svg b/assets/safari.svg
new file mode 100644
index 0000000..d4cde6c
--- /dev/null
+++ b/assets/safari.svg
@@ -0,0 +1,31 @@
+
\ No newline at end of file
diff --git a/docker-compose.yaml b/docker-compose.yaml
index 1e68f5f..9f9c669 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -9,7 +9,7 @@ services:
ports:
- 7280:7280
command: ["run"]
- # attach: false
+ attach: false # comment this line if you'd like to view quickwit log output
otel-collector:
image: otel/opentelemetry-collector:latest
diff --git a/package.json b/package.json
index 33132cd..c5e4249 100644
--- a/package.json
+++ b/package.json
@@ -1,15 +1,24 @@
{
"name": "opentelemetry-browser-extension",
"displayName": "OpenTelemetry Browser Extension",
- "version": "0.0.6",
+ "version": "0.0.7",
"description": "An extension for instrumenting webpages using OpenTelemetry",
"author": "Theodore Brockman