runbooks
mermaid
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
runbooks
-
Monitoring system health, Logs and scheduled jobs
There are also good patterns for monitoring the status of jobs.
-
Jenkins build time in Prometheus
Check out this job monitoring pattern.
-
Alert Reference Documentation
For a freely available resource, I found GitLab’s Runvbooks a good example to strive towards. But this is the output of a large team and several years. My advice is to just start with something simple.
-
Gitlab is ALWAYS down
It's a weighted combination of all services. The SLA weightings for all service areas are defined in the gitlab.com service catalog.
- An impatient SRE's guide to deleting alerts
-
Any simple ways to record the duration of arbitrary processes?
Take a look at this pushgateway-based job monitoring pattern.
- Gitlab S-1
-
To use Gitlab Dashboards - How to use grafonnet with jsonnet to produce a json file that I can use with Grafana
I want to use the GitLab dashboards here in my local Grafana environment - https://gitlab.com/gitlab-com/runbooks/-/tree/master/dashboards
-
Looking for Grafana dashboards to help us monitor our GitLab services running in Kubernetes
Also, take a look at the code https://gitlab.com/gitlab-com/runbooks
-
Is a runbook what I’m looking for?
GitLab puts everything in a git repo in markdown. A single repo that contains a few different things. All of the production alerts are sourced from there. This makes it possible to review alerts and runbook changes in the same code review.
mermaid
-
AsciidocFX: The Asciidoc Editor for documentation and authoring
Mermaid Diagram - Create diagrams using text and code
-
Creating Animated Diagrams for LinkedIn
Mermaid - https://mermaid.js.org/
-
ChatCraft Adventures #13, UI Changes
This is an Issue I opened up for a potential feature. A couple weeks ago, I added nomnoml support to ChatCraft. ChatCraft renders previews for Mermaid and Nomnoml.
-
Building a Mermaid.js Gantt Chart in a FileMaker Web Viewer
Mermaid JS is a powerful JavaScript library that allows developers to create complex diagrams and visualizations using simple text and code syntax. It’s a lot like markdown, but for charts instead of plain text.
-
ChatCraft Adventures #10
Currently, ChatCraft supports Mermaid rendering. This feature request involves adding support for nomnoml rendering. Nomnoml is similar to Mermaid, in that they're both used in generating uml diagrams.
- Ask HN: Anyone use a code to mindmap/flowchart tool?
- Mermaid: Generation of diagrams like flowcharts or sequence diagrams from text
-
Show HN: Marimo – an open-source reactive notebook for Python
Marimo looks and feels great!
Have you considered adding support for mermaid.js in the markdown? I tried including some mermaid.js in a `mo.md` invocation, but it didn't render the diagram :-)
https://mermaid.js.org/
-
Penrose – Penrose
This feels like the LaTeX version of Mermaid.js [0]. I can do anything with it, but I gotta learn a lot of new syntax. So, really cool! Gonna have to dig into this.
[0] https://mermaid.js.org/
- Mermaid: Diagramming and Charting Tool
What are some alternatives?
postgres_exporter - A PostgreSQL metric exporter for Prometheus
plantuml - Generate diagrams from textual description
operator - Kubernetes operator for Victoria Metrics
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
diagrams - :art: Diagram as Code for prototyping cloud system architectures
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
gl-infra
draw.io - draw.io is a JavaScript, client-side editor for general diagramming.
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
graphviz
Graphviz - Simple Python interface for Graphviz