私のZennの書き方 / How I Write on Zenn

Zenncafe#5日比谷 - Zennfes表彰式＆年末懇親会のLTスライドです
https://zenn.connpass.com/event/374981/

Transcript

1. ©MIXI 私のZennの書き⽅ 『ログ基盤をPromtailからGrafana Alloyに移⾏する』を題材に Zenncafe#5⽇⽐⾕ - Zennfes表彰式＆年末懇親会 Yuuki Takahashi / yktakaha4
2. 2 ©MIXI - 2025年1⽉⼊社 - 「家族アルバム みてね」のSRE - Zenn歴は約5年 - 好きなもの - ⾳楽 - ⾷ - 猫 髙橋 祐輝 / Yuuki Takahashi / yktakaha4 株式会社MIXI みてね事業本部 みてねプラットフォーム部 SREグループ ⾃⼰紹介
3. 3 ©MIXI Zennfes 2025 「インフラ‧セキュリティ」テーマ 優秀賞 受賞ありがとうございます！！！ https://zenn.dev/contests/zennfes2025infra?tab=result より引⽤
4. 4 ©MIXI 私がZennを書くときに意識していること について話します！ LTするにはニッチな内容なので... 今⽇話すこと
5. 5 ©MIXI ① ⽬次から書く Zennを書くときに意識していること
6. 6 ©MIXI 過去に書いた記事の⽬次（⾒出し）構成をコピペして再利⽤ ⽬次で何を‧どこまで書くか決める ① ⽬次から書く A. 実装/手順説明型（約 40%の記事） # はじめに/なぜ調べたか/なにこれ # 環境/前提/準備 # 実装/手順/構築 ## 具体的な実装内容 ## 実行結果/動作確認/テスト # おわりに/まとめ B. 調査/解説型（約 35%の記事） # なぜ調べたか/背景 # 基本的な概念/概要 # 調べたこと/詳細な分析 ## 個別要素の詳細 ## 関連技術との関係 # 実際の使用例/ケーススタディ # おわりに # 参考文献 C. 体験記/振り返り型（約 15%の記事） # 結果/概要/ことのおこり # 背景/経緯/なぜやったか # 具体的な取り組み/実施内容 ## 詳細プロセス # 感じた効果/学んだこと/振り返り # おわりに 「私が今までに書いた Zennを読んで、目次の構成について整理してください」と生成 AIに質問 今回はこれを選択
7. 7 ©MIXI ① ⽬次から書く # はじめに/なぜ調べたか/なにこれ # 環境/前提/準備 # 実装/手順/構築 ## 具体的な実装内容 ## 実行結果/動作確認/テスト # おわりに/まとめ ## Promtailについて ## Grafana Alloyについて ### 少し詳細を見てみる ## 実装方式 ### ① DaemonSet + `loki.source.file` ### ② Deployment + クラスタリング + `loki.source.kubernetes` ### ③ DaemonSet + `loki.source.kubernetes` ### ④ Deployment + `loki.source.kubernetes` ### ⑤ StatefulSet（未検証） ## 役立った機能 ### `alloy convert` コマンド ### Prometheusメトリクス ### Alloy UIと`livedebugging`オプション ## 発生した挙動 ### メモリ使用量の増加と転送遅延 ### `too_far_behind`, `greater_than_max_sample_age` エラーの発生 ## おわりに 『ログ基盤をPromtailからGrafana Alloyに移⾏する』の⽬次構成 構成を決めてから 細分化する 試したことと ⽣じた結果は 分けて書く
8. 8 ©MIXI ② 記事を書く前提で作業ログを残す Zennを書くときに意識していること
9. 9 ©MIXI ② 記事を書く前提で作業ログを残す 記事を書こうと思ってから思い出すのは⼤変なので、 ⽇々の業務の中で作業ログを取り貯めておく ※1: https://grafana.com/docs/alloy/latest/introduction/estimate-resource-usage/#loki-logs より引⽤ ※2: https://zenn.dev/mitene/articles/migrate-promtail-to-alloy より引⽤ ※1 ※2 - 調査タスクで⾒つけたドキュメント - 検証結果のスクリーンショット - トラブルシューティングで参照したIssue - チャットツールでのやり取りへのリンク - etc... あとで探すの めっちゃ⼤変 その時しか取れない 情報もある
10. 10 ©MIXI ③ Zennならではの利点を活⽤する Zennを書くときに意識していること
11. 11 ©MIXI ③ Zennならではの利点を活⽤する GitHub連携して textlint や editorconfig-checker を組み込む PublicationやAIレビュー機能も便利！ ローカルPCで 好きなエディタを 使って執筆 Gitフックや CI/CDで 文章校正・フォーマット AIや同僚に レビューしてもらって 公開！
12. 12 ©MIXI ③ Zennならではの利点を活⽤する 困ったことがあったらContributeできる！ zenn-dev/zenn-community に相談 ※1 https://github.com/zenn-dev/zenn-community/issues より引⽤ ※2 https://x.com/zenn_dev/status/1986689447803691040 より引⽤ zenn-dev/zenn-editor にPR ※1 ※2
13. 13 ©MIXI ① ⽬次から書く ② 記事を書く前提で作業ログを残す ③ Zennならではの利点を活⽤する まとめ：Zennを書くときに意識していること