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

chore(docs): Add macOS troubleshooting section to VRL web playground #17824

Merged
merged 4 commits into from
Jul 3, 2023
Merged

chore(docs): Add macOS troubleshooting section to VRL web playground #17824

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
42c06c2
docs: Add troubleshooting section to VRL web playground
pront Jun 30, 2023
e38fbec
remove unknown words, they are not necessary
pront Jun 30, 2023
4087f15
address review points
pront Jun 30, 2023
131bb06
markdownlint fixes
pront Jul 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
41 changes: 39 additions & 2 deletions lib/vector-vrl/web-playground/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To build the project we need to use `wasm-pack`. This compiles our Rust code
to WebAssembly which can then be used within the browser. Install it by running:

```shell
cargo install --version 0.10.3 wasm-pack
cargo install --locked --version 0.10.3 wasm-pack
```

After installing `wasm-pack` we must compile our project by running:
Expand All @@ -30,6 +30,8 @@ For more information on Rust and WebAssembly please visit
[the mozilla docs][mozilla-wasm-rust-docs] or
[the Rust book wasm chapter][rust-book-wasm]

## Run locally

The `src/lib.rs` file is the entry point of the `web-playground` crate.
This file is necessary so we can use the `run_vrl()` function in the browser.
Notice our `index.html` imports the VRL wasm module from `./vrl_web_playground.js`
Expand Down Expand Up @@ -65,7 +67,42 @@ but they will either error (enrichment functions) or abort (all the others) at r
- `get_enrichment_table_record`

Functions from VRL stdlib that are currently not supported can be found
with this [issue filter][vrl-wasm-unsupported-filter]
with this [issue filter][vrl-wasm-unsupported-filter].

### macOS Troubleshooting
Copy link
Member

Choose a reason for hiding this comment

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

👏 thanks for recording these


If you are getting compilation errors on macOS here are some things to check:

```shell
xcode-select -p
# Example: '/Library/Developer/CommandLineTools
# To change this use: xcode-select -s
```

You can clean and reinstall with:

```shell
rm -rf /Library/Developer/CommandLineTools # might require sudo elevation
xcode-select --install
```

Check your `llvm` installation and ensure that there are no conflicting installations. Check that the following command returns the expected version:

```shell
clang --version
# Example:
# Homebrew clang version 16.0.6
# Target: arm64-apple-darwin22.5.0
# Thread model: posix
# InstalledDir: /opt/homebrew/opt/llvm/bin
```

The output of the following command should contain `WebAssembly`:

```shell
llvm-config --targets-built # WebAssembly should be in the results
# Example: AArch64 <omitted> WebAssembly <omitted>
```

## Examples

Expand Down