About This Project
What is the goal of this project? To provide a clear, concise, and unbiased overview of cloud-native observability.
Why is that important? Despite untold millions of marketing dollars spent in and around observability (or maybe because of the untold millions of marketing dollars spent), cloud-native observability practice today is often shallow, siloed, or both. It doesn't need to be that way.
Who is this for? Observability practitioners, SRE's and DevOps engineers, end-users of observability systems, and anyone involved in building and running cloud-native software at scale.
How can you help? You can contribute in several ways --
- Adding your stories and learnings to an appendix.
- Helping refine and shape this repository through contributions
- Tackling a good first issue
- Giving us a star and sharing the repository!
This project is in a draft state. We are actively refining, polishing, and iterating on the content. Our goal is to spend March 2022 doing refinement, then make it generally available in April 2022.
What We're Looking For
Currently, we would appreciate feedback (either via issues or pull requests) in the following areas:
- Overall structure and flow of the document.
- Overall comprehension of the text/themes.
- Un-defined, under-defined, or over-defined themes/concepts/terms.
- General feedback on the ideas.
- Illustrations and explanatory diagrams.
Table of Contents
- README
- Foreward
- Glossary
- Introduction
- Customers and Engineers, Transactions and Resources
- The Anatomy of Observability
- Telemetry Creation and OpenTelemetry
- Effective Monitoring
- Effective Investigation
- Effective SLO's
- Telemetry ROI -- The Elephant in the Room
- Organizational Concerns
Contributing
We gladly accept pull requests! Please see CONTRIBUTING.md for more.
Special Thanks
This guide is made possible thanks to Lightstep.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.