Skip to content

Commit

Permalink
whitepaper: Syncing changes from the 1.0 community review & contribut…
Browse files Browse the repository at this point in the history
…ion period. (#132)

* whitepaper: Syncing changes from the 1.0 community review & contribution period.

Thanks everyone for amazing feedback! Apologies for a bit short period,
but the paper was sitting for 2y without changes, so it made sense to time
box 1.0 and allow structured work on further iterations.

Still, within [this community review & contribution period](https://docs.google.com/document/d/19am_KCYWU28ebLiIXv_P3ji96edxCTscVb4CzemXV5A/edit)
I counted 67 individual contributions (count of comment/suggestion bubbles, excluding my own and not counting individual discussion comments)
from 7 new contributors.

High level changes (suggested by community, but also clean up by me):

* Note on aggregatability and volume of metrics.
* Added non goals
* Changing example from temperature to memory gauge
* Add reasons for metric efficiency
* Added info about cardinality (new section)
* Mentioned metric data models
* Added info about types
* Metric time series vs count
* Addressing feedback on logs, traces
* Adding profile screenshot
* Cleaning up, simplifying correlation section
* Removing how to setup Prometheus with exemplars
* Transitions
* Box based monitoring refactor - changing "closed box" traditional
* Clarified SLO/SLA
* Added image and figure captions
* More automatic and non-intrusive instrumentation solutions in OSS
* Linking ebay paper
* Added gap around streaming API, not enough DBs and standarized query language
* Did grammarly pass for typos.

...and more.

As mentioned in [the doc](https://docs.google.com/document/d/19am_KCYWU28ebLiIXv_P3ji96edxCTscVb4CzemXV5A/edit) I went through
all additional and old feedback. It's now either addressed in this PR or added as
todos in [separate issues](https://github.com/cncf/tag-observability/issues?q=is%3Aissue+is%3Aopen+label%3Acn-o11y-whitepaper-v1.1)

I admit, it was fun to process that doc! Reminds me of year ago when I was, fully focused, writing my [book](https://www.oreilly.com/library/view/efficient-go/9781098105709/) on sligthly different topic.


Signed-off-by: bwplotka <[email protected]>

* Added Jaana and Alois as contributors.

Thanks for your ideas and feedback in https://github.com/cncf/tag-observability/issues/16\

Signed-off-by: bwplotka <[email protected]>

* Apply suggestions from Richi's code review

Co-authored-by: RichiH-travel <[email protected]>
Signed-off-by: Bartlomiej Plotka <[email protected]>

* Apply suggestions from code review

Co-authored-by: RichiH-travel <[email protected]>
Signed-off-by: Bartlomiej Plotka <[email protected]>

* Fixed references, added tip version.

Signed-off-by: bwplotka <[email protected]>

---------

Signed-off-by: bwplotka <[email protected]>
Signed-off-by: Bartlomiej Plotka <[email protected]>
Co-authored-by: RichiH-travel <[email protected]>
  • Loading branch information
bwplotka and RichiH-travel authored Oct 17, 2023
1 parent a52165e commit a1dfbed
Show file tree
Hide file tree
Showing 14 changed files with 857 additions and 286 deletions.
Binary file added assets/burn-rate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/correlation1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/correlation2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/correlation3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/correlation4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/correlation5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/correlation6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/primary-signals.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/slo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/trace-spans.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/tracing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
555 changes: 555 additions & 0 deletions tip/whitepaper-draft.md

Large diffs are not rendered by default.

588 changes: 302 additions & 286 deletions whitepaper.md

Large diffs are not rendered by default.

0 comments on commit a1dfbed

Please sign in to comment.