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

Jump to bottom

chore: update support table in readme #116

Merged
merged 1 commit into from
Aug 25, 2023
Merged

chore: update support table in readme #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 27 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Adapter, please open an issue here or email
**Note:** Any supported Runtime SDK can be paired with any Adapter from the same
language.

| Language | Runtime SDKs | Adapters |
| ---------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Rust | [Wasmtime](/rust) | [Datadog](/rust/src/adapter/datadog.rs), [OpenTelemetry (STDOUT)](/rust/src/adapter/otelstdout.rs), [Zipkin](/rust/src/adapter/zipkin.rs) |
| Go | [Wazero](/go) | [Datadog](/go/adapter/datadog/), [OpenTelemetry (STDOUT)](/go/adapter/otel_stdout/) |
| JavaScript | [Native](/js) (Browser, Node, Deno, Bun) | [Datadog](/js/packages/observe-sdk-datadog) |
| Language | Runtime SDKs | Adapters |
| ---------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Comment on lines +29 to +30
Copy link
Member Author

Choose a reason for hiding this comment

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

my editor adds these superfluous hyphens.. pretty sure the spec just asks for a single hyphen! not harming anything to leave though I suppose.

| Rust | [Wasmtime](/rust) | [Datadog](/rust/src/adapter/datadog.rs), [Honeycomb](/rust/src/adapter/honeycomb.rs), [Lightstep](/rust/src/adapter/lightstep.rs), [OpenTelemetry (stdout)](/rust/src/adapter/otelstdout.rs), [Zipkin](/rust/src/adapter/zipkin.rs) |
| Go | [Wazero](/go) | [Datadog](/go/adapter/datadog/), [Honeycomb](/go/adapter/honeycomb/), [Lightstep](/go/adapter/lightstep/), [OpenTelemetry (stdout)](/go/adapter/otel_stdout/) |
| JavaScript | [Native](/js) (Browser, Node, Deno, Bun) | [Datadog](/js/packages/observe-sdk-datadog), [Honeycomb](/js/packages/observe-sdk-honeycomb), [Lightstep](/js/packages/observe-sdk-lightstep) |

_More languages, SDKs, and adapters are coming soon! Reach out to help us
prioritize these additional components
Expand All @@ -45,11 +45,14 @@ There are two components to this process:

## Including a runtime SDK and an Adapter

First you should choose a Host SDK corresponding to your host application's language and Wasm runtime.
The Host SDK captures raw observability events from the running Wasm module and sends them to an adapter.
You must choose an adapter based on where you want your data to go. At the moment, we support a few systems out of the box.
In the future we will support a lot more and will have more community driven options. If you don't see support for your
favorite observability tools feel free to reach out to us at ([support@dylibso.com](mailto:support@dylibso.com)).
First you should choose a Host SDK corresponding to your host application's
language and Wasm runtime. The Host SDK captures raw observability events from
the running Wasm module and sends them to an adapter. You must choose an adapter
based on where you want your data to go. At the moment, we support a few systems
out of the box. In the future we will support a lot more and will have more
community driven options. If you don't see support for your favorite
observability tools feel free to reach out to us at
([support@dylibso.com](mailto:support@dylibso.com)).

Each language includes some examples demonstrating use with different adapters.
You can view these examples here:
Expand All @@ -62,11 +65,13 @@ You can view these examples here:

There are two ways to instrument the Wasm modules: automatically and manually.


### Automatically instrument your Wasm

The easiest way to instrument your code right now is to use our instrumenting compiler. This is a tool that can look at your Wasm and recompile it with instrumentation built in.
The compiler is available as a service. You can generate a key to use [this service for free here](https://compiler-preview.dylibso.com/).
The easiest way to instrument your code right now is to use our instrumenting
compiler. This is a tool that can look at your Wasm and recompile it with
instrumentation built in. The compiler is available as a service. You can
generate a key to use
[this service for free here](https://compiler-preview.dylibso.com/).

To use the key:

Expand All @@ -85,11 +90,16 @@ curl --fail -F wasm=@code.wasm https://compiler-preview.dylibso.com/instrument -

### Manually instrument your Wasm

The Host SDKs expose a series of host functions that make up our *Observe API*. You can code directly against this if you wish.
Because we are still changing and experimenting with this API, we have not built much tooling or support for this yet. See [the Observe API README](observe-api/) to learn more about the API and the language bindings we provide.
The Host SDKs expose a series of host functions that make up our _Observe API_.
You can code directly against this if you wish. Because we are still changing
and experimenting with this API, we have not built much tooling or support for
this yet. See [the Observe API README](observe-api/) to learn more about the API
and the language bindings we provide.

Expect to see some documentation and alpha tools by September 2023. We will be building out a lot of the language specific layers, but we hope the community
can help by building tools on top of it and integrating with existing libraries like OpenTelemetry.
Expect to see some documentation and alpha tools by September 2023. We will be
building out a lot of the language specific layers, but we hope the community
can help by building tools on top of it and integrating with existing libraries
like OpenTelemetry.

## Development

Expand Down
Loading