Zio: ZIO Tracing & ZMX docs

Created on 14 Apr 2020  路  3Comments  路  Source: zio/zio

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

documentation

Most helpful comment

@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:

https://github.com/zio/zio/pull/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.

All 3 comments

@neko-kai for sure we need to do this

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

@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:

https://github.com/zio/zio/pull/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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jdegoes picture jdegoes  路  4Comments

adamgfraser picture adamgfraser  路  4Comments

reibitto picture reibitto  路  3Comments

ioleo picture ioleo  路  3Comments

iravid picture iravid  路  3Comments