Skip to content

Commit

Permalink
chore: add repo logo and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nilslice committed Jul 28, 2023
1 parent 3371ffd commit fea03f8
Show file tree
Hide file tree
Showing 2 changed files with 156 additions and 4 deletions.
149 changes: 149 additions & 0 deletions .github/assets/observe-wasm.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Observe
![WebAssembly Observability](./.github/assets/observe-wasm.svg)

# WebAssembly Observability Toolkit

Observe provides observability SDKs for WebAssembly, enabling continuous
monitoring of WebAssembly code as it executes within a runtime.
Expand Down Expand Up @@ -33,10 +35,10 @@ prioritize these additional components

There are two components to this process:

1. [Instrumenting the Wasm code](#instrumenting-wasm-module)
1. [Instrumenting the Wasm code](#instrumenting-wasm-modules)
2. [Including a runtime/host SDK](#including-a-runtime-sdk)

## Instrumenting Wasm Module
## Instrumenting Wasm Modules

This package expects the wasm code to be instrumented using our instrumenting
compiler. The only way to instrument your wasm right now is through the
Expand All @@ -61,7 +63,8 @@ curl -F [email protected] https://compiler-preview.dylibso.com/instrument -X POST
## Including a runtime SDK

First install the cargo dependency for the SDK:
This example covers the integration of the Rust SDK for Wasmtime. First install
the cargo dependency for the SDK:

```toml
[dependencies]
Expand Down

0 comments on commit fea03f8

Please sign in to comment.