docs: add grafana dashboard image to instrumentation

anycable · Sep 16, 2021 · 5f328bf · 5f328bf
1 parent 3710a24
commit 5f328bf
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/.github/workflows/docs-lint.yml b/.github/workflows/docs-lint.yml
@@ -60,4 +60,4 @@ jobs:
     - name: Run liche
       run: |
         export PATH=$PATH:$(go env GOPATH)/bin
-        liche -c 4 -r docs/* -x "(ruby|deployment)/" -v
+        liche -c 4 -r docs/* -x "(ruby|deployment|assets)/" -d docs/ -v
diff --git a/docs/instrumentation.md b/docs/instrumentation.md
@@ -2,7 +2,11 @@
 
 AnyCable-Go provides useful statistical information about the service (such as the number of connected clients, received messages, etc.).
 
-> See the [demo](https://github.com/anycable/anycable_rails_demo/pull/22) of instrumenting AnyCable with Prometheus, Grafana and [Yabeda](https://github.com/yabeda-rb).
+<p style="text-align:center;">
+  <img width="70%" alt="AnyCable Grafana" src="/assets/images/grafana.png">
+</p>
+
+> Read the ["Real-time stress: AnyCable, k6, WebSockets, and Yabeda"](https://evilmartians.com/chronicles/real-time-stress-anycable-k6-websockets-and-yabeda) post to learn more about AnyCable observability and see example Grafana dashboards.
 
 ## Prometheus
 

diff --git a/forspell.dict b/forspell.dict
@@ -45,3 +45,4 @@ Protobufs
 Grafana
 Hotwire
 blazingly
+observability
diff --git a/lefthook.yml b/lefthook.yml
@@ -12,7 +12,7 @@ pre-commit:
       run: mdl {staged_files}
     liche:
       glob: "docs/*.md"
-      run: liche -c 4 -r docs/* -x "(ruby|deployment)/" && test "{staged_files}"
+      run: liche -c 4 -r docs/* -x "(ruby|deployment|assets)/" -d docs/ && test "{staged_files}"
     forspell:
       glob: "docs/*.md"
       run: forspell {staged_files}