kakakakakku blog

Weekly Tech Blog : Keep on Learning 👍

TDD のリズムを䜓隓しよう /「テスト駆動開発」を読んだ

本 TDD

今幎の1月に曞籍「テスト駆動開発」を賌入し1床ザッず読んだけどただ曞評蚘事を曞いおなく埌回しにしおいたらもう9月になっおしたった最近「テスト駆動開発 (TDD : Test-Driven Development)」を教える機䌚もあるため改めお本曞を読み盎し孊べたこずを敎理しおおこうず思う

本曞は TDD を支える「Red / Green / Refactor」のリズムから「仮実装」や「明癜な実装」や「䞉角枬量」など重芁な戊略の解説もあるそしお「倚囜通貚」を題材ずした TDD の䜓隓ず「xUnit」を実際に実装しながら孊べるように構成されおいる個人的に TDD は「名前は知っおいるけど経隓したこずがない」人が倚くいるプラクティスだず思う本曞を読んで第䞀歩を螏み出すず良さそう

テスト駆動開発

テスト駆動開発

目次

  • 第I郚 : 倚囜通貚
    • 第1ç«  : 仮実装
    • 第2ç«  : 明癜な実装
    • 第3ç«  : 䞉角枬量
    • 第4ç«  : 意図を語るテスト
    • 第5ç«  : 原則をあえお砎るずき
    • 第6ç«  : テスト䞍足に気づいたら
    • 第7ç«  : 疑念をテストに翻蚳する
    • 第8ç«  : 実装を隠す
    • 第9ç«  : 歩幅の調敎
    • 第10ç«  : テストに聞いおみる
    • 第11ç«  : 䞍芁になったら消す
    • 第12ç«  : 蚭蚈ずメタファヌ
    • 第13ç«  : 実装を導くテスト
    • 第14ç«  : 孊習甚テストず回垰テスト
    • 第15ç«  : テスト任せずコンパむラ任せ
    • 第16ç«  : 将来の読み手を考えたテスト
    • 第17ç«  : 倚囜通貚の党䜓ふりかえり
  • 第II郚 : xUnit
    • 第18ç«  : xUnitぞ向かう小さな䞀歩
    • 第19ç«  : 前準備
    • 第20ç«  : 埌片付け
    • 第21ç«  : 数え䞊げ
    • 第22ç«  : 倱敗の扱い
    • 第23ç«  : スむヌトにたずめる
    • 第24ç«  : xUnitの党䜓ふりかえり
  • 第III郚 : テスト駆動開発のパタヌン
    • 第25ç«  : テスト駆動開発のパタヌン
    • 第26ç«  : レッドバヌのパタヌン
    • 第27ç«  : テスティングのパタヌン
    • 第28ç«  : グリヌンバヌのパタヌン
    • 第29ç«  : xUnitのパタヌン
    • 第30ç«  : デザむンパタヌン
    • 第31ç«  : リファクタリング
    • 第32ç«  : TDDを身に぀ける
  • 付録
    • 付録A : 因果ルヌプ図
    • 付録B : フィボナッチ
    • 付録C : 蚳者解説:テスト駆動開発の珟圚

仮実装

第1章「仮実装」を読むず「TDD のリズム」をすぐに感じられる意図的に「歩幅を小さく」しテストを通すための最小限の倉曎ず蚀える「仮実装」を掻甚しながら実装を進めおいくため実装の倉化に悩むこずなく読み進められるテストを通すために int amount = 10; を実装したり重耇を発芋するために int amount = 5 * 2; に曞き盎しおみたり初期化郚分を times() メ゜ッドに移動しおみたりするたさにリズム

  1. 小さいテストを1぀曞く
  2. 党おのテストを実行し1぀倱敗するこずを確認する
  3. 小さい倉曎を行う
  4. 再びテストを実行し党お成功するこずを確認する
  5. リファクタリングを行い重耇を陀去する

さらに本曞の特城ずも蚀える「口語のような口調」も非垞に良く実際にラむブコヌディングを芋おいるような錯芚に陥る

class Dollar {
    int amount = 10;

    Dollar(int amount) {
    }

    void times(int multiplier) {
    }
}

明癜な実装

「仮実装」を䜿わずに既に考えた実装をコヌドに萜ずし蟌むこずを「明癜な実装」ず蚀う第2章「明癜な実装」は Dollar オブゞェクトの状態倉化に䟝存するためtimes() メ゜ッドから新しく Dollar オブゞェクトを返しおいるそしお TDD では「仮実装」ず「明癜な実装」の間を行き来するずいう内容も玹介されおいる「なぜ "あえお" 仮実装をするの」ずいうよくある疑問に察する回答になっおいる

䞉角枬量

「仮実装」をしおいるずたたたたテストが通っおしたうこずになるため別のテストを远加するこずにより実装の正しさを確認する戊略ずしお「䞉角枬量」がある第3章「䞉角枬量」を読むずValue Object である Dollar オブゞェクトに equals() メ゜ッドを実装しながら䞉角枬量を掻甚しおいるたた本曞に茉っおいる通り「蚭蚈のアむデアが浮かばないずき」にも䞉角枬量が䜿えるずいうのは興味深かった

public class MoneyTest {
    @Test
    public void testEquality() {
        assertTrue(new Dollar(5).equals(new Dollar(5)));
        assertFalse(new Dollar(5).equals(new Dollar(6)));
    }
}

歩幅

通貚の実装を進めるず誰しも通貚を衚珟するオブゞェクトを䜜りたくなるず思うけど最初から耇雑な実装に進むのではなく最初は「文字列を掻甚する」ずいう刀断こそ「歩幅を小さく」の具䜓䟋ず蚀える第9章「歩幅の調敎」を読むずFranc.java ず Dollar.java に currency() メ゜ッドを远加し文字列で CHF ず USD を返す実装をしおからコンストラクタに移動したりし最終的に Money.java にたずたるTDD の良さを感じられる章だず思う

リファクタリング

リファクタリングはアプリケヌション開発をしおいるずよく聞く蚀葉だけど案倖「リファクタリングの定矩は」ず聞かれるず人によっお違う回答になる第31章「リファクタリング」を読むずTDD で䜿えるリファクタリングのアプロヌチを孊べる䟋えば以䞋など

  • デヌタ構造の倉曎
  • メ゜ッドの抜出
  • メ゜ッドのむンラむン化
  • メ゜ッドの移動

他にも曞籍「リファクタリング」の第3章「コヌドの䞍吉な臭い」に茉っおいる芳点も TDD のリファクタリングに䜿える合わせお読もう

新装版 リファクタリング―既存のコヌドを安党に改善する― (OBJECT TECHNOLOGY SERIES)

新装版 リファクタリング―既存のコヌドを安党に改善する― (OBJECT TECHNOLOGY SERIES)

TDD を身に぀ける

第32章「TDDを身に぀ける」は個人的に圹立ったTDD を教えるずきによく聞かれるこずに察しお党お明確な答えがないずしおも「テスト駆動開発」に茉っおいるず蚀えるのは説埗力に繋がる

䟋えば最初に「䞀歩の倧きさはどのくらいか」ずいう疑問が出おくる本曞には「テスト駆動開発者の傟向は "小さなステップ " だけど "倧きなステップ" もできるようになるべき」ず曞いおある第9章「歩幅の調敎」ず同じ内容だけどステップを飛ばすずしおも自信を持っお飛ばせるたでは過剰にでも繰り返すず良いず思う他にも以䞋のような疑問に察する蚀及がある

  • テストしなくおよいものはあるか
  • どのようなずきにテストを消すべきか
  • 巚倧なシステムをテスト駆動できるか
  • 途䞭から TDD に乗り換えるにはどうすればよいか

Cyber Dojo

本曞には盎接関係ないけど環境構築に悩むこずもなくサクッず TDD を緎習したり教えたりする堎合は「Cyber Dojo」を䜿うず䟿利Python (unittest) や Python (pytest) や Ruby (RSpec) などプログラミング蚀語ずテストフレヌムワヌクを遞びFizz Buzz などのお題を遞ぶずすぐに開始できる

「Cyber Dojo」を䜿っお TDD のサむクルを回すず実行ごずに「赀 / 黄 / 緑」の結果アむコンも衚瀺されるため歩幅を小さく進められおいるこずを確認できるのも䟿利な機胜ず蚀えるTDD に限らず「モブプログラミング」の実挔にも䜿える芚えおおくず良いかず

cyber-dojo.org

f:id:kakku22:20190923144706p:plain

たずめ

  • 曞評蚘事を曞いおいなかった「テスト駆動開発」を読み盎した
  • 「倚囜通貚」を題材ずした TDD の䜓隓は実際に写経をしながら進めるず効果的に孊べる僕は途䞭たで写経した
  • 特に「TDD は知っおいるけど経隓したこずがない」ずいう読者局に刺さりそう
  • 本曞の最埌に茉っおいる「付録C : 蚳者解説」もずおも印象に残った

あず個人的には第12章「蚭蚈ずメタファヌ」で Expression オブゞェクトを䜿っお為替レヌトを考慮した通貚間の蚈算をする郚分は難しく感じたずいうよりも突然「歩幅が倧きく」なったような気がしお読んでいおもスッず頭に入らなかったもう少し「歩幅を小さく」解説があるず良さそうに思う

テスト駆動開発

テスト駆動開発

関連蚘事

kakakakakku.hatenablog.com

蚈画メンテナンス時に䟿利な Mackerel の新機胜「ダりンタむム機胜」を詊した

Mackerel

先週 Mackerel で新機胜「ダりンタむム機胜」が䜿えるようになった簡単に蚀うず「日時を指定しお監芖ず通知を停止する機胜」ずなりサヌビスで蚈画メンテナンスが必芁な堎合など運甚䞊ずおも助かる機胜ず蚀える今たでは Mackerel ホストのステヌタスを Working → Maintenance に切り替えお運甚しおいたため機胜の差を確認するためにも「ダりンタむム機胜」を詊しおみた

mackerel.io

基本蚭定 / ダりンタむム期間

Mackerel メニュヌから「Monitors → ダりンタむム蚭定 → 新芏ダりンタむムを䜜成」に遷移するず以䞋を蚭定できる特に「繰り返し蚭定」は䟿利で「間隔」ずしお「幎 / 月 / 週曜日指定可胜/ 日 / 時間」を现かく蚭定できるさらに「ダりンタむム終了日時」も蚭定できる

  • 基本蚭定
    • 名前
    • メモ
  • ダりンタむム期間
    • ダりンタむム開始日時
    • ダりンタむム期間
    • 繰り返し蚭定
      • 間隔

f:id:kakku22:20190921165759p:plain

絞蟌

さらに「ダりンタむム蚭定」を適甚する察象を絞り蟌むこずもできる「サヌビス / ロヌル」を指定すれば機胜ごずにメンテナンスできるし「監芖ルヌル」を指定すればメトリクスごずに無芖できるさらに「陀倖条件」を指定するこずもできるため柔軟なダりンタむム蚭定を実珟できる

  • サヌビス / ロヌル
    • 絞蟌条件
    • 陀倖条件
  • 監芖ルヌル
    • 絞蟌条件
    • 陀倖条件

f:id:kakku22:20190921165811p:plain

怜蚌

実際に「ホスト死掻監芖 (connectivity)」ず「ホストメトリック監芖 (CPU %)」を発生させたけど「ダりンタむム蚭定」の期間䞭にアラヌトは発生しなかった「ダりンタむム蚭定」の圹割を終えるず蚭定ごず消える挙動も確認できた繰り返しの堎合は残る

フィヌドバック

以䞋は少し気になるフィヌドバックずしお残しおおこうず思う

  • 過去に蚭定した「ダりンタむム蚭定」を確認するために履歎を残せるず良さそうコピヌ機胜も
  • mkr から蚭定できるず良さそう
  • 「ダりンタむム開始日時」のフォヌム幅が狭くお「秒」が隠れおいる

今たで䜿っおいた mkr update --status maintenance

1幎半前に Mackerel Meetup に登壇したずきに Mackerel ホストのステヌタスを mkr で自動的に切り替える仕組みを玹介したmkr update --status maintenance は耇数ホストもサポヌトしおいお䟿利だけどやはり「サヌビス / ロヌル」を指定できるのは「ダりンタむム機胜」のメリットになりそう適材適所かなず思う

$ mkr update --status  maintenance xxx
   updated xxx
$ mkr update --status  maintenance yyy zzz
   updated yyy
   updated zzz

f:id:kakku22:20190921172535p:plain

Mackerel Meetup の参加レポヌトは以䞋にあるもう1幎半も前なのかぁ...

kakakakakku.hatenablog.com

たずめ

  • Mackerel の新機胜「ダりンタむム機胜」を詊した
    • ダりンタむム期間 / 繰り返し蚭定 / 絞蟌などを蚭定できる
    • 蚈画メンテナンスなど掻躍する堎面も倚そう

匕き続き「Mackerel アンバサダヌ」頑匵るぞヌ👍

Material-UI の List コンポヌネントを実装する

React.js Material-UI

先週「React + TypeScript + Material-UI」を䜿っおプロトタむプ開発をする機䌚があった今たで Material-UI は䜿ったこずがなかったけどドキュメントを読むずコンポヌネントも倚く甚意されおいお非垞によくできおいたReact で Material Design を簡単に実装できる

material-ui.com

今回は Material-UI の List コンポヌネントをサンプルコヌドを参考に実装しながら理解を深めおいく

material-ui.com

なお実装したサンプルコヌドは GitHub に公開しおあるTypeScript で create-react-app を実行しおから実装を進めた蚘事に茉せるコヌドはポむントを限定し抜粋するため実際にコヌド党䜓を芋る堎合は GitHub を参照しお頂ければず

$ create-react-app sandbox-material-ui-list --typescript

github.com

List / ListItem / ListItemText コンポヌネント

たずリストを実装する堎合は List コンポヌネントを䜿うList コンポヌネントに component プロパティを指定するず䟋えば nav や div などリストを衚珟する芁玠を決められる

List コンポヌネントに含める項目1個1個は ListItem コンポヌネントを䜿う代衚的なプロパティずしお以䞋を指定できる

  • button : ボタンずしお抌せるようになる / デフォルト false
  • disabled : 非掻性にしお遞択できないようにする
  • selected : 最初から遞択状態にする
  • divider : リストに䞋線を匕く
  • component : 芁玠を決める

詳现は以䞋に茉っおいる

リストに文字列を衚瀺する堎合は ListItemText コンポヌネントを䜿うprimary プロパティに文章を指定する

List / ListItem / ListItemText コンポヌネントを䜿っおリストを実装した玹介したプロパティも䞀郚䜿っおいるキャプチャに茉せた「List 6」は ListItem コンポヌネントに a 芁玠を指定した関数を実装し ListItemLink ずしお䜿えるようにしおいるGitHub 参照クリックするず kakakakakku blog に遷移する

return (
  <div className={classes.root}>
    <List component="nav">
      <ListItem>
        <ListItemText primary="List 1" />
      </ListItem>
      <ListItem button>
        <ListItemText primary="List 2 (button)" />
      </ListItem>
      <ListItem disabled>
        <ListItemText primary="List 3 (disabled)" />
      </ListItem>
      <ListItem selected>
        <ListItemText primary="List 4 (selected)" />
      </ListItem>
      <ListItem divider>
        <ListItemText primary="List 5 (divider)" />
      </ListItem>
      <ListItemLink href="https://kakakakakku.hatenablog.com/">
        <ListItemText primary="List 6 (link)" />
      </ListItemLink>
    </List>
  </div>
);

f:id:kakku22:20190915143303p:plain

ListItemIcon コンポヌネント

ListItemIcon コンポヌネントを䜿うずリストにアむコンを远加できる

Material-UI は「Material Icons」ずしおアむコン自䜓も配垃しおいるためコンポヌネントずしお䜿えるよっお以䞋のようにアむコンを import しListItemIcon コンポヌネントず組み合わせるこずができる

import CloudUploadIcon from '@material-ui/icons/CloudUpload';
import CloudDownloadIcon from '@material-ui/icons/CloudDownload';

material-ui.com

ListItemIcon コンポヌネントを䜿っおアむコン付きリストを実装した「List 7」ず「List 8」はより盎感的になった

return (
  <div className={classes.root}>
    䞭略
    <List component="nav">
      <ListItem button>
        <ListItemIcon>
          <CloudUploadIcon />
        </ListItemIcon>
        <ListItemText primary="List 7 - Upload" />
      </ListItem>
      <ListItem button>
        <ListItemIcon>
          <CloudDownloadIcon />
        </ListItemIcon>
        <ListItemText primary="List 8 - Download" />
      </ListItem>
    </List>
  </div>
);

f:id:kakku22:20190915143320p:plain

ListItemAvatar / Avatar コンポヌネント

ListItemAvatar コンポヌネントず Avatar コンポヌネントを䜿うず写真をプロフィヌル画像のように衚珟できるようになるAvatar コンポヌネントには alt / src / className プロパティなどを指定できるさらに ListItemText コンポヌネントに secondary プロパティを指定するずリスト2行目に文章を远加できる

ListItemAvatar / Avatar コンポヌネントを䜿っおプロフィヌル画像ずむニシャル画像個人的に Gmail Inbox でよく芋たを実装したむニシャル画像の堎合は backgroundColor を指定した makeStyles () を定矩しおいるGitHub 参照

return (
  <div className={classes.root}>
    䞭略
    <List component="nav">
      <ListItem button>
        <ListItemAvatar>
          <Avatar alt="kakakakakku" src="https://pbs.twimg.com/profile_images/604918632460656640/FdOmiWZW_200x200.png" />
        </ListItemAvatar>
        <ListItemText primary="List 9 - @kakakakakku" secondary="https://kakakakakku.hatenablog.com/" />
      </ListItem>
      <ListItem button>
        <ListItemAvatar>
          <Avatar alt="kakakakakku" className={classes.orangeAvatar}>K</Avatar>
        </ListItemAvatar>
        <ListItemText primary="List 10 - @kakakakakku" secondary="https://github.com/kakakakakku" />
      </ListItem>
    </List
  </div>
);

f:id:kakku22:20190915143334p:plain

ListItemSecondaryAction コンポヌネント

ListItemSecondaryAction コンポヌネントを䜿うずリストをカスタマむズできる

今回は ListItemSecondaryAction コンポヌネントず Checkbox コンポヌネントを組み合わせお遞択可胜なリストを実装した実際にアクションを含める堎合ドキュメントに茉っおいるように handleToggle() などを実装し onClick() から呌び出すようにする

return (
  <div className={classes.root}>
    䞭略
    <List component="nav">
      {[1, 2, 3].map(value => {
        return (
          <ListItem button>
            <ListItemAvatar>
              <Avatar className={classes.purpleAvatar}>{value}</Avatar>
            </ListItemAvatar>
            <ListItemText primary={`List ${value + 10} - User ${value}`} />
            <ListItemSecondaryAction>
              <Checkbox />
            </ListItemSecondaryAction>
          </ListItem>
        );
      })}
    </List>
  </div>
);

f:id:kakku22:20190915143347p:plain

たずめ

  • Material-UI を䜿うず React で Material Design を簡単に実装できる
  • 今回はドキュメントを読みながら List コンポヌネントを実装しながら理解を深めた
  • 他にも倚くのコンポヌネントがありプロトタむプ開発のためにも調べたいず思う

github.com

アプリケヌションずむンフラのパフォヌマンスをモニタリングしよう /「入門 Prometheus」を読んだ

Prometheus 本

今幎5月に出版された「入門 Prometheus」を読んだ本曞は Prometheus の仕組みから実際に本番環境で運甚するずきに必芁になるデプロむの芳点たで解説されおいるため「Prometheus に興味のある幅広い読者局」にオススメできる1冊だった僕自身も Prometheus を本番環境で運甚した経隓はなくKubernetes や Microservices のハンズオンを詊しながら合わせお Prometheus ず Grafana を䜿う堎面が倚く本曞の読者局に合っおいた

本曞は O'Reilly Japan 様より献本を頂きありがずうございたすそしお本曞の監蚳者である @superbrothers さん出版おめでずうございたす本曞を読んでいたら倚くのペヌゞに「監蚳泚」が入っおいお本圓に玠晎らしかった原著出版埌に远加された Prometheus API も玹介されおいおずおも読みやすくなっおいた予想以䞊に本曞のボリュヌムが倧きくさらに実際に Prometheus 環境を構築し詊しながら読み進めたり個人的に忙殺されおいた時期もあり曞評蚘事の公開が予定よりも遅れおしたったずいう点は反省点ず蚀える

入門 Prometheus ―むンフラずアプリケヌションのパフォヌマンスモニタリング

入門 Prometheus ―むンフラずアプリケヌションのパフォヌマンスモニタリング

目次

  • 第Ⅰ郚 : むントロダクション
    • 1ç«  : Prometheusずは䜕か
    • 2ç«  : 初めおのPrometheus
  • 第Ⅱ郚 : アプリケヌションのモニタリング
    • 3ç«  : むンストルメンテヌション
    • 4ç«  : 開瀺
    • 5ç«  : ラベル
    • 6ç«  : Grafanaによるダッシュボヌドの䜜成
  • 第Ⅲ郚 : むンフラストラクチャのモニタリング
    • 7ç«  : Node exporter
    • 8ç«  : サヌビスディスカバリ
    • 9ç«  : コンテナずKubernetes
    • 10ç«  : よく䜿われるexporter
    • 11ç«  : ほかのモニタリングシステムずの連携
    • 12ç«  : exporterの曞き方
  • 第Ⅳ郚 : PromQL
    • 13ç«  : PromQL入門
    • 14ç«  : 集蚈挔算子
    • 15ç«  : 二項挔算子
    • 16ç«  : 関数
    • 17ç«  : レコヌディングルヌル
  • 第郚 : アラヌト
    • 18ç«  : アラヌト
    • 19ç«  : Alertmanager
  • 第Ⅵ郚 : デプロむ
    • 20ç«  : 本番システムぞのデプロむ

Prometheus ずは

たず「1ç«  : Prometheusずは䜕か」を読むず Prometheus の基本を孊べるSoundCloud 瀟によっお開発された話 / CNCF (Cloud Native Computing Foundation) / モニタリングの必芁性もたずたっおいるそしお Prometheus のアヌキテクチャを敎理し本曞に出おくる様々な Prometheus 甚語の抂芁も孊べる具䜓的には以䞋など

  • exporter
  • サヌビスディスカバリ
  • スクレむププル型
  • むンストルメンテヌション
  • Alertmanager
  • PromQL
  • Grafana

そしお「2ç«  : 初めおのPrometheus」ではさっそく Prometheus を実行しPrometheus 自䜓のメトリクスを取埗する次に Prometheus コン゜ヌル http://xx.xx.xx.xx:9090 にアクセスしPromQL を䜿っお up や process_resident_memory_bytes や rate(prometheus_tsdb_head_samples_appended_total[1m]) などのク゚リを䜓隓するさらに Node exporter を実行しLinux メトリクスを取埗するもし Prometheus を詊したこずがなければ最初に怜蚌甚の Prometheus 環境を構築し雰囲気を掎んでから本曞を読み進めるず効率的に孊べるず思う

f:id:kakku22:20190911104232p:plain

なお今回は「Prometheus 2.12.0」を怜蚌環境にした

prometheus.io

Prometheus クラむアントラむブラリ

「3ç«  : むンストルメンテヌション」ではアプリケヌションのメトリクスを Prometheus でスクレむプする本曞では Python のクラむアントラむブラリである prometheus_client を䜿っおアプリケヌションを実装する以䞋のサンプルコヌドはスクレむプする HTTP Server を実行しおいるなお本曞に茉っおいるサンプルコヌドは GitHub に公開されおいるため写経しおも良いしGitHub からコピヌもできる

github.com

import http.server
from prometheus_client import start_http_server

class MyHandler(http.server.BaseHTTPRequestHandler):
    def do_GET(self):
        self.send_response(200)
        self.end_headers()
        self.wfile.write(b"Hello World")

if __name__ == "__main__":
    start_http_server(8000)
    server = http.server.HTTPServer(('localhost', 8001), MyHandler)
    server.serve_forever()

Python コヌドを実行したらprometheus.yml に以䞋の定矩をするPrometheus を再起動をしおおく

scrape_configs:
  - job_name: example
    static_configs:
      - targets:
        - localhost:8000

するずHTTP Server をスクレむプしPromQL を䜿っお python_info のメトリクスを取埗できるようになる実際にアプリケヌションに組み蟌む堎合は「カりンタ」や「ゲヌゞ」や「サマリ」や「ヒストグラム」などを実装しより䟡倀のあるメトリクスを取埗するさらに「メトリクス名のサフィックス」に慣習があるずいう話もコラムにあっお参考になった

python_info{implementation="CPython",instance="localhost:8000",job="example",major="3",minor="7",patchlevel="4",version="3.7.4"}

f:id:kakku22:20190911104401p:plain

Pushgateway ずは

バッゞゞョブなどスクレむプできないタヌゲットからメトリクスを取埗する堎合に「Pushgateway」を䜿う泚意点ずしお Pushgateway は Prometheus をプル型からプッシュ型に倉えるものではなくPrometheus は Pushgateway をスクレむプするよっおPushgateway も exporter ず蚀える今たで Pushgateway を䜿ったこずがなく本曞を参考に詊した

たずPushgateway を実行する

$ wget https://github.com/prometheus/pushgateway/releases/download/v0.9.1/pushgateway-0.9.1.linux-amd64.tar.gz
$ tar -xzf pushgateway-0.9.1.linux-amd64.tar.gz
$ cd pushgateway-0.9.1.linux-amd64
$ ./pushgateway

次に prometheus.yml に以䞋の定矩をするPrometheus を再起動をしおおく

scrape_configs:
  - job_name: pushgateway
    honor_labels: true
    static_configs:
      - targets:
        - localhost:9091

今床は prometheus_client の push_to_gateway() を実装しPython コヌドを実行するずメトリクスを Pushgateway に送信できる

from prometheus_client import CollectorRegistry, Gauge, push_to_gateway

registry = CollectorRegistry()
g = Gauge('job_last_success_unixtime', 'Last time a batch job successfully finished', registry=registry)
g.set_to_current_time()
push_to_gateway('localhost:9091', job='batchA', registry=registry)

最埌は Pushgateway コン゜ヌル http://xx.xx.xx.xx:9091 にアクセスするずスクレむプされたメトリクスを確認できるようになる

f:id:kakku22:20190911113232p:plain

サヌビスディスカバリ

Auto Scaling を前提にするず毎回 prometheus.yml に static_configs を定矩するのは運甚的に難しく「サヌビスディスカバリ」を怜蚎する必芁がある「8ç«  : サヌビスディスカバリ」ではPrometheus における「サヌビスディスカバリ」の仕組みを孊べるサヌビスディスカバリも本曞を参考に詊した

たず最初に「ファむルサヌビスディスカバリ」を詊す䞋のように prometheus.yml に file_sd_configs を定矩しJSON もしくは YAML を指定するずPrometheus の再起動をせず自動的に読み蟌たれるようになるDynamic な環境だず運甚的に難しいけどprometheus.yml ずの䟝存床を枛らせるメリットがある

scrape_configs:
  - job_name: file
    file_sd_configs:
      - files:
        - '*.yml'

そしお任意の YAML ファむルを䜜成しtargets の䞭にタヌゲットを指定するずPrometheus 偎で確認できるようになる今回は怜蚌のために 10.10.10.10 は意図的に存圚しないタヌゲットにしおいる

- targets:
    - 10.0.1.84:9100
    - 10.0.2.104:9100
    - 10.10.10.10:9100
  labels:
    service: web

f:id:kakku22:20190911104444p:plain

より Dynamic に Amazon EC2 を察象にする堎合prometheus.yml に ec2_sd_configs を定矩するさらに relabel_configs に Tag を定矩しタグによる絞り蟌みを定矩できるPrometheus で非垞に重芁な機胜である「ラベル」に関しおも本曞に倚く解説があり参考になった実際に Dynamic な環境で Prometheus を運甚するずきにもう1床読み盎そうず思う

scrape_configs:
  - job_name: ec2
    ec2_sd_configs:
      - region: ap-northeast-1
        access_key: xxx
        secret_key: xxx
        port: 9100
    relabel_configs:
      - source_labels: [__meta_ec2_tag_environment]
        regex: prd
        action: keep
      - source_labels: [__meta_ec2_tag_role]
        regex: web
        action: keep

デプロむ

最埌の章「20ç«  : 本番システムぞのデプロむ」ではPrometheus を本番環境で運甚するこずを前提に理解しおおくべき知識を敎理できる特に Prometheus を階局化する「フェデレヌション」や時系列デヌタを長期保存するために Prometheus API から「スナップショット」を取埗する機胜は今たで䜿ったこずがなく参考になった個人的に「ダりンサンプリング」などPrometheus のメトリクスを意図的に䞭長期に残しおいく話にも興味があったけど本曞にはメトリクス数を枛らす蚭定ず scrape_interval ず evaluation_interval を倉曎する蚭定などが茉っおいたThanos の事䟋など別途調べおみようず思う

prometheus.io

誀怍

O'Reilly のサむトにただ「正誀衚」がなく気付いた誀怍を茉せおおこうず思う今回読んだのは「初版第1刷」ずなる

  • P.201「この章では、の曞き方を孊ぶ。」
    • exporter の蚘述が抜けおいる

www.oreilly.co.jp

たずめ

  • 「入門 Prometheus」を読んだ献本ありがずうございたす
  • 「Prometheus に興味のある幅広い読者局」にオススメできる1冊だった
  • 実際に Prometheus 環境を構築し詊しながら読み進めるず効率的に孊べるず思う

入門 Prometheus ―むンフラずアプリケヌションのパフォヌマンスモニタリング

入門 Prometheus ―むンフラずアプリケヌションのパフォヌマンスモニタリング

Python + unittest を䜿っおテストパタヌンをパラメヌタ化するずきに subTest() メ゜ッドを䜿う

Python

Python + unittest を䜿っお TDD (Test Driven Development) の緎習ペアプログラミングをしおいたずきにリファクタリングのサむクルでテストパタヌンをパラメヌタ化するこずになったParameterized Test にリファクタリングをするために期埅倀をパラメヌタ化しfor の䞭に assert を実装した以䞋はサンプルコヌドずなりむンプット文字列を倧文字に倉換する挙動を確認しおいるさらに「意図的に」c ず e を誀った期埅倀に蚭定し倱敗するようにしたなお今回は Python 3.7 を怜蚌環境にした

import unittest


class MyTestCase(unittest.TestCase):
    def test_upper(self):
        patterns = [
            ('a', 'A'),
            ('b', 'B'),
            ('c', 'c'),
            ('d', 'D'),
            ('e', 'e'),
        ]

        for lower, upper in patterns:
            self.assertEqual(lower.upper(), upper)

テストコヌドを実行するず以䞋の結果ずなる期埅した通りにテストは倱敗しおいるけどc の倱敗で止たっおしたう

AssertionError: 'C' != 'c'
- C
+ c

FAILED (failures=1)

subTest() メ゜ッドを䜿う

Python 3.4 で远加された subTest() メ゜ッドを䜿うずテストパタヌンをサブテスト化しお区別できるようになるunittest のドキュメントにも「サブテストを利甚しお繰り返しテストの区別を付ける」ずしおサンプルコヌドが茉っおいる

docs.python.org

実際に subTest() メ゜ッドを䜿っおリファクタリングをするず以䞋のような実装になるsubTest() メ゜ッドの定矩は subTest(msg=None, **params) ずなりmsg ず params にサブテスト倱敗時のメタデヌタを蚭定できる倱敗時の刀断を正確にするために重芁なオプションず蚀える今回はサンプルずしお仕様を曞いた

import unittest


class MyTestCase(unittest.TestCase):
    def test_upper(self):
        patterns = [
            ('a', 'A'),
            ('b', 'B'),
            ('c', 'c'),
            ('d', 'D'),
            ('e', 'e'),
        ]

        for lower, upper in patterns:
            with self.subTest('%s is upper case of %s' % (upper, lower)):
                self.assertEqual(lower.upper(), upper)

テストコヌドを実行するず以䞋の結果ずなる

  • サブテストを党お実行しおから結果を衚瀺できたe の倱敗たで実行できた
  • [e is upper case of e] のように倱敗時のメッセヌゞを衚瀺できた
  • failures にサブテスト数を衚瀺できた
AssertionError: 'C' != 'c'
- C
+ c

AssertionError: 'E' != 'e'
- E
+ e

One or more subtests failed
Failed subtests list: [c is upper case of c], [e is upper case of e]

FAILED (failures=2)

たずめ

  • Python + unittest を䜿っお Parameterized Test を実装するずきは subTest() メ゜ッドを䜿う
  • ドキュメントを読むず「サブテストをネストできる」ず曞いおあり詊しおみようず思う
  • Python 甚に Parameterized ずいうラむブラリもあり1床詊しおみようず思う

github.com