Add notes on canonical log lines

Author: rednafi

.github/workflows/ci.yml

@@ -68,7 +68,8 @@ jobs:
           HUGO_ENVIRONMENT: production
           HUGO_ENV: production
         run: |
-          make init
+          git submodule update --init --recursive
+          npm ci || true
           hugo \
             --gc \
             --minify \

.github/workflows/update-hugo.yml

@@ -69,8 +69,8 @@ jobs:
       - name: Build site with updated Hugo
         if: env.hugo_update_needed == 'true'
         run: |
-          npm ci || true
           git submodule update --init --recursive
+          npm ci || true
           hugo --gc --minify
         continue-on-error: false
 

.gitignore

@@ -3,6 +3,7 @@ public
 .venv
 .ruff_cache
 node_modules
+static
 
 
 # Byte-compiled / optimized / DLL files

Makefile

@@ -1,41 +1,35 @@
-define PRINT_STEP
-	@echo "$$(tput setaf 6)$$(tput bold)\n:> $1\n$$(tput sgr0)"
-endef
+SHELL := /bin/bash -ex
+MAKEFLAGS += --silent
 
 # Define packages as a space-separated list
 BREW_PACKAGES := gh hugo pre-commit prettier [email protected] uv
 
-init:
-	@git submodule update --init --recursive
-	@npm install
 
-ifeq ($(CI),)
-	@$(call PRINT_STEP,installing brew dependencies)
-	@for pkg in $(BREW_PACKAGES); do \
-		brew list $$pkg &>/dev/null || (echo "Installing $$pkg..." && brew install $$pkg); \
+init:
+	git submodule update --init --recursive
+	npm install
+	npm install -g wrangler
+	for pkg in $(BREW_PACKAGES); do \
+		brew list $$pkg &>/dev/null || brew install $$pkg; \
 	done
-
-	@$(call PRINT_STEP,creating python venv)
-	@uv venv -p 3.12
-
-	@$(call PRINT_STEP,installing python dependencies)
-	@. .venv/bin/activate
-	@uv pip install black blacken-docs mypy pytest pytest-cov ruff
-
-	@$(call PRINT_STEP,initialization complete)
-endif
-
+	uv venv -p 3.12
+	. .venv/bin/activate
+	uv pip install black blacken-docs mypy pytest pytest-cov ruff
 
 lint:
-	@pre-commit run --all-files
-	@prettier --write .
-
+	pre-commit run --all-files
+	prettier --write .
 
 update:
-	@git submodule update --remote --merge
-	@pre-commit autoupdate -j 4
-	@npm update
-
+	git submodule update --remote --merge
+	pre-commit autoupdate -j 4
+	npm update
 
 devserver:
-	@hugo server --disableFastRender -e production --bind 0.0.0.0 --ignoreCache
+	hugo server --disableFastRender -e production --bind 0.0.0.0 --ignoreCache
+
+upload-static:
+	find static -type f | while read filepath; do \
+		key=$$(echo "$$filepath" | sed 's|^|blog/|'); \
+		wrangler r2 object put $$key --file "$$filepath"; \
+	done

content/feed/2024.md

@@ -8,6 +8,26 @@ hideMeta: true
 ShowShareButtons: false
 ---
 
+### September 09
+
+#### [Canonical log lines — Stripe Engineering Blog][8]
+
+I’ve been practicing this for a while but didn’t know what to call it. Canonical log lines
+are arbitrarily wide structured log messages that get fired off at the end of a unit of
+work. In a web app, you could emit a special log line tagged with different IDs and
+attributes at the end of every request. The benefit is that when debugging, these are the
+logs you’ll check first. Sifting through fewer messages and correlating them with other logs
+makes investigations much more effective, and the structured nature of these logs allows for
+easier filtering and automated analysis.
+
+> _Out of all the tools and techniques we deploy to help get insight into production,
+> canonical log lines in particular have proven to be so useful for added operational
+> visibility and incident response that we’ve put them in almost every service we run—not
+> only are they used in our main API, but there’s one emitted every time a webhook is sent,
+> a credit card is tokenized by our PCI vault, or a page is loaded in the Stripe Dashboard._
+
+---
+
 ### September 07
 
 #### [Recognizing the Gell-Mann Amnesia effect in my use of LLM tools][6]
@@ -115,6 +135,7 @@ his next book, [Recursion][2].
 
 ---
 
+[8]: https://stripe.com/blog/canonical-log-lines
 [7]: https://en.wikipedia.org/wiki/Michael_Crichton#GellMannAmnesiaEffect
 [6]: https://x.com/rednafi/status/1832414343952265432
 [5]: https://x.com/fchollet/status/1831029432653599226

wrangler.toml

@@ -0,0 +1,7 @@
+name = "r2-uploader"
+account_id = "f2c208344e8adb0cf3ea1e48dccf7218"
+
+[[r2_buckets]]
+binding = "blog"
+bucket_name = "blog"
+preview_bucket_name = "blog"