Giter Club home page Giter Club logo

observability-diagramming's Introduction

Observability Diagramming

Somewhat opinionated assets for Observability Diagramming.

Mental Model

Samples

Signals

SDKs

Pipelines

Platforms

SLI / SLO

Goals

  • Provide a set of ready to go Icons for various Observability Concepts
  • Help create better diagraming for the Observability Ecosystem
  • Adopt diagraming standards with the help of community review when they provide a clear value add.
  • Use existing concepts / iconology where it is allowed
  • If a concept does not yet exist create an icon for it

Non Goals

  • Dictate how to diagram / what icons to use
  • Try to Adhere to every diagramming standard / approach, without subject matter experts / community support. If I don't understand a diagraming standard I won't phone it in.
  • Play one up-manship against current diagrams used to demonstrate Observability concepts. I use them as inspiration for my examples, but am certainly not saying my way is right!
  • Be a SIG (Special Interest Group)
  • Be biased towards a vendor

Why Non Goals

  • Below are a few representations of the Data Flow of the Otel Demo App. https://opentelemetry.io/docs/demo/collector-data-flow-dashboard/#data-flow-overview
  • All representations, I feel, accurately represent the state of what's going on with the Otel Demo App
  • However the diagrams are quite different in the way they represent the information
  • There are many other ways to represent this information. Hence why I don't want to dictate adherence to models but rather focus on providing raw assets that people can use as they want.

Rationale

  • This medium article covers a lot of the decisions made with these icons.
  • #TODO write the article

Excalidraw as a First Class Citizen

  • Most of these Icon Sets were created and are distributed as Excalidraw Assets.
  • Excalidraw provides very useful tools to export a component of library to SVG or PNG but with 81+ assets that's becoming impratical to maintain.
  • I Provide the Excalidraw assets I used to create the icons and in future will think about CI/CD automation to package these in different ways
  • I might convert these to pure SVG representations further down the track if there is interest.

TODO:

  • Concept - Resource Discovery
  • Example - djaglowski for Collector Architecture with SDK components

Attributions

observability-diagramming's People

Contributors

firecube-oss avatar puckpuck avatar

Stargazers

 avatar Jerry.Z avatar OMID Zamani avatar Sebastian YEPES avatar Sascha avatar Gustavo Pantuza avatar Thomas Ankcorn avatar Devrim Demiroz avatar

Watchers

Sascha avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.