Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# OpenTelemetry WASI

Libraries to enable using OpenTelemetry within WebAssembly components backed by [WASI OTel](https://github.com/calebschoepp/wasi-otel).

## Notes about host implementation
TODO?
Comment on lines +5 to +6
Copy link
Owner

Choose a reason for hiding this comment

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

What's up with this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I thought it might be helpful to have a section that helps users get a sense for how to use the exported data on the host side. For example, we could share that metrics can be sent over otlp using a MetricExporter type, and a Span can be exported using a BatchSpanProcessor. Happy to remove this if you don't think it's a good idea.

Copy link
Owner

Choose a reason for hiding this comment

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

I'd personally lean towards not documenting this or at the very least not documenting this in the README. Ultimately there will be two consumers of opentelemetry-wasi: end-users who just want to use the SDK and runtime authors who want to support wasi-otel in their runtime. I think we should certainly document for end-users in this repo. But in my mind runtime authors are more likely to look to the wasi-otel repo and other runtime implementations then docs here. Also who are we to say what a runtime chooses to do with the data. For all we care they could send it to /dev/null.

To soften my feedback. I think the impulse to document is a good one, but I don't think this one makes the most sense.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Understood! I'm aware that I tend to over-document, so I was prepared to trim things like this. I'll get it removed this evening.

Loading