Skip to content

Latest commit

聽

History

History
212 lines (180 loc) 路 9.83 KB

observability-charter.md

File metadata and controls

212 lines (180 loc) 路 9.83 KB
Raw

CNCF TAG Observability Charter

Review and contributions from: Alex Nauda, Alois Reitbauer, Bart艂omiej (Bartek) P艂otka, Daniel Khan, Daniel Prata, Lincoln Sward, Matthew Young, Matthias Loibl, Michael Hausenblas, Ricardo Aravena, Richard Hartmann, Sergey Kanzhelev, Steve Flanders, Ted Young, Tigran Najaryan, Tommy Chong, and Umair Ishaq.*

Introduction

This document describes the purpose and operations of the Cloud Native Computing Foundation (CNCF) Technical Advisory Group(TAG) on Observability.

This TAG focuses on topics pertaining to the observation of cloud native workloads. Additionally, it produces supporting material and best practices for end-users and provides guidance and coordination for CNCF projects working within the TAG鈥檚 scope.

A full list of CNCF projects can be found at landscape.cncf.io.

Mission

Consistent with the CNCF TAG definition, the mission of TAG Observability is to:

  • Foster and grow the ecosystem of observability related projects, users, and maintainers.
  • Identify and report gaps in the CNCF's project portfolio on topics of observability to the TOC and the wider CNCF community.
  • Collect, curate, champion, and disseminate patterns and current best practices related to the observation of cloud-native systems that are effective and actionable.
  • Educate and inform users with unbiased, accurate, and pertinent information.
  • Educate and help other CNCF projects in regarding observability techniques and practices available within the CNCF.
  • Provide and maintain a vendor-neutral venue for relevant thought validation, discussion, and project feedback.
  • Provide a ladder for community members to become involved with the technical oversight of projects within the TAG's scope in an open, transparent, and inclusive way.

Areas considered in Scope

Observability focuses on patterns, projects, tools, and techniques related to topics such as:

  • Methodologies for instrumenting, collecting, processing, storing, querying, curating, and correlating observational data such as metrics, logging/events, trace spans, and profiling of cloud native workloads.
  • Using distributed trace tooling to observe a series of calls between microservices to understand where time is being spent.
  • Managing the complexity, operational cost, and resource consumption of observability tools and systems at the enterprise scale.
  • Best practices for meaningful alerting, queries, and operational dashboards including how to manage things including rules, definitions, thresholds and policies.
  • How developers, operators, Site Reliability Engineers (SRE), IT Engineers, and other actors comprehend, process, and reason on distributed cloud-native systems.
  • Projects that incorporate novel & insightful approaches to utilizing observability data such as:
    • ML, model training, Bayesian networks, and other data science techniques that enable anomaly & intrusion detection.
    • Correlating resource consumption with costing data to reduce the total cost of cloud native infrastructure
    • Using observability data exposed by service meshes, orchestrators, and other metric sources to inform continuous deployment tooling (e.g. Canary Predicates/Judges).
  • Objective curation and generation of case studies pertaining to delivering observability tools/systems to end users.
  • Best practices around observability and its continuous improvement, e.g. post mortems, runbooks
  • Provide guidance around and foster interoperability between observability solutions without trying to enforce one specific standard.
  • Foster understanding of the prerequisites and corner-stones of observability like SLI/KPI, service objectives, and internal/external commitments.

The following is a non-exhaustive sample list of activities and deliverables that are in-scope for this TAG

  • Summary and overview of projects available in the community.
  • Catalog of reference architectures that draw from CNCF projects, combining them in useful and novel ways.
  • Definitions of implementations and patterns for best practices for delivering observability tooling at enterprise scale.
  • Tooling composition and toolchain creation based on existing projects.
  • Best practices for operations and monitoring workflows using CNCF Projects.
  • Organizing and helping to provide visibility to Meetups, Blogs, and Podcasts related to the scope of the TAG.
  • Guidance for application development and architecture that is observable.
  • Replicatable reference architectures.
  • Patterns for observing application delivery pipelines.
  • Education regarding instrumentation cloud native workloads.
  • Processing and Accessing relevant observability data at scale.
  • Policy and security controls for observability data.
  • Creating artifacts as part of CI/CD pipelines that facilitate observation of services. Concrete examples might be:
    • Service profiles for Linkerd.
    • Debug binaries or other diagnostic metadata.
    • representative trace spans from failing CI tests.

Areas considered out of Scope

Anything not explicitly considered in the scope above.

Examples include:

  • Datastores that are not primarily used for observability. Those datastores might be in the scope of TAG Storage.
  • Security aspects that need to be present when setting up cloud native infrastructure, these might be more relevant for TAG Security.
  • How cloud native applications that need observability are deployed; this would fall in the scope of TAG App Delivery
  • Tools and projects that are used to run cloud native workloads that in some cases need observability would fall under the scope of TAG-Runtime.

Roadmap & Initial Efforts

  • Contribute to Due Diligence (DD) Reviews in accordance with the TOC's Due Diligence Guidelines and Due Diligence Review Template to assist the CNCF TOC for projects in the scope of the SIG.

  • Facilitate webinars and presentations from CNCF projects and domain experts in the scope of the TAG.

  • Formation of TAG working group(s) as resource capacity and member contribution allows.

    TAGs may choose to spawn focussed and time-limited working groups to achieve some of their responsibilities (for example, to produce a specific educational white paper, or portfolio gap analysis report). Working groups should have a clearly documented charter, timeline (typically a few quarters at most), and set of deliverables. Once the timeline has elapsed, or the deliverables delivered, the working group dissolves, or is explicitly re-chartered.

Governance

Operations