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.

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

ZIO Tracing & ZMX docs #3365

Open
neko-kai opened this issue Apr 14, 2020 · 3 comments
Open

ZIO Tracing & ZMX docs #3365

neko-kai opened this issue Apr 14, 2020 · 3 comments
Labels
documentation Documentation improvements

Comments

@neko-kai
Copy link
Member

neko-kai commented Apr 14, 2020

There's currently no microsite section for tracing & fiber dumps. It would be great to rectify that and have a section describing:

  1. .traced/untraced
  2. Fiber.dump & ZMX
  3. Runtime.withTracing & TracingConfig options
  4. How to read traces, what do they mean and how are they obtained
  5. How to read fiber dumps

/cc @softinio

@neko-kai neko-kai added the documentation Documentation improvements label Apr 14, 2020
@softinio
Copy link
Contributor

@neko-kai for sure we need to do this

@calvinlfer
Copy link
Member

@neko-kai and @softinio, @FrancisToth and I would be happy to take this on with some initial help and guidance from you

@softinio
Copy link
Contributor

@calvinlfer @FrancisToth that would be awesome thank you

items 1, 3 & 4 - @neko-kai can provide input and I would start with these

Iets separate Fiber Dump and ZMX

Fiber Dump
I have this PR on its way and have started a page on it in this PR so perhaps post this PR expand on what I have in that PR especially on how to use fiber dumps in code. Happy to help and also @adamgfraser can provide his input here:

#2976

zmx

We have moved it, to its own repo with some new goals and re-writing for the project:

https://github.com/zio/zio-zmx

We probably need to put together its own microsite. The code for it is already there as part of the scaffold we create so maybe use the contents in the README to create an initial microsite for zmx. I am happy to provide input on other content for it too. Maybe once microsite up in ZIO docs under fiber dump we can reference it?

Any questions let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvements
Projects
None yet
Development

No branches or pull requests

3 participants