Haskell で Open Telemetry を利用してオブザーバビリティーを向上させよう

Open Telemetry って何?

この記事では Open Telemetry のトレースの機能を使います。トレースを使うと、サーバーを越境してコールグラフとその実行時間などを取得することができます。下の画像は Jaeger のスクリーンショットです。Jaeger は Open Telemetry の規格にのっとったコレクター実装のひとつです。

この例では HTTP サーバーと HTTP クライアントでトレースを取得しています。まずサーバーが /1 のパスでリクエストを受けつけたことが分かります。このリクエストに対してレスポンスを返すまでに 845μs かかっていますね。このトレースにおけるひとつの区間をスパンといいます。

次にサーバーはこのリクエストに対して処理をする途中で localhost:7777/2 に HTTP リクエストを投げたことが分かります。リクエストを投げてレスポンスが返ってくるまでに 729μs かかっています。

最後に /2 へのリクエストに対してサーバーが応答したスパンが記録されています。

この例では便宜上、サーバーは自分に対して再度リクエストをしていますが、これは物理的なサーバーが別であっても同様にトレースが取得できます。

Haskell のプログラムに対してトレースを記録したい

Open Telemetry はプログラミング言語や OS などに依存しない仕様ですから、Haskell でもトレースを記録したいです。そうすれば Istio や Node などのスパンとつながったトレースを見ることができます。Haskell では hs-opentelemetry ライブラリーを使用します。

github.com

自分もいっぱいコントリビュートしています。HERP 社からの委託を受け開発しています。

インターフェースは今後破壊的変更が入る可能性が多分にありますが、HERP 社で本番運用している程度に完成しています。

hs-opentelemetry の使い方

hs-opentelemetry はいくつかのパッケージに分かれています。まず基本となるものは hs-opentelemetry-api と hs-opentelemetry-sdk です。apisdk に分かれているのは Open Telemetry の仕様が分けるよう指示しているためであまり意味はありません。トレースを取得するためのトレーサーおよびトレーサーを作成するためのトレーサープロバイダーを作成するために使用します。また「ここからここまでスパンを取得する」というように手動で指定する場合に使用します。手動で指定するには下記の型をもつ inSpan 関数を使用します。

module OpenTelemetry.Trace.Core

…

inSpan ::
  (MonadUnliftIO m, HasCallStack) =>
  Tracer ->
  -- | The name of the span. This may be updated later via 'updateName'
  Text ->
  -- | Additional options for creating the span, such as 'SpanKind',
  -- span links, starting attributes, etc.
  SpanArguments ->
  -- | The action to perform. 'inSpan' will record the time spent on the
  -- action without forcing strict evaluation of the result. Any uncaught
  -- exceptions will be recorded and rethrown.
  m a ->
  m a

inSpan の第4引数の所要時間をスパンとして記録します。

これでスパンは記録できますが、全部を inSpan で書いていくのはいささか邪魔くさいです。そこでインスツルメンテーションが用意されています。初めのトレースの例では wai 用のインスツルメンテーションと http-client インスツルメンテーションを使用しています。インスツルメンテーションを使用すると初めのトレースの例の実装は下のようになります。

{-# LANGUAGE OverloadedStrings #-}

import qualified Network.HTTP.Client as H
import qualified Network.HTTP.Types.Status as H
import qualified Network.Wai as W
import qualified Network.Wai.Handler.Warp as W
-- Network.HTTP.Client の代わりに he-opentelemetry のインスツルメンテーションを使用する
import OpenTelemetry.Instrumentation.HttpClient (
  Manager (),
  defaultManagerSettings,
  httpLbs,
  newManager,
 )
-- he-opentelemetry のインスツルメンテーションで提供される WAI ミドルウェアを使用する
import OpenTelemetry.Instrumentation.Wai (newOpenTelemetryWaiMiddleware)
import OpenTelemetry.Trace (
  initializeTracerProvider,
  setGlobalTracerProvider,
 )


main :: IO ()
main = do
  -- デフォルト設定でトレーサープロバイダーを作成する
  tracerProvider <- initializeTracerProvider
  -- グローバルな IORef に作成したトレーサープロバイダーを参照させる
  setGlobalTracerProvider tracerProvider
  -- トレースが取れるようラップされた http-client を作成する
  httpClient <- newManager defaultManagerSettings
  -- トレースを取得する WAI ミドルウェアを作成する
  tracerMiddleware <- newOpenTelemetryWaiMiddleware
  W.run 7777 $ tracerMiddleware $ app httpClient


app :: Manager -> W.Application
app httpManager req res =
  case W.pathInfo req of
    ["1"] -> do
      newReq <- H.parseRequest "http://localhost:7777/2"
      newRes <- httpLbs newReq httpManager
      res $ W.responseLBS H.ok200 [] $ "1 (" <> H.responseBody newRes <> ")"
    ["2"] -> res $ W.responseLBS H.ok200 [] "2"
    _ -> res $ W.responseLBS H.ok200 [] "other"

app 関数はこれまで通りの書きごこちですが、HTTP リクエストを受けてレスポンスを返すまで、HTTP リクエストを投げてレスポンスを受けるまでのスパンが取得できるようになっています。簡単ですね。

インスツルメンテーションには他にも mysql-simple 版や grpc-haskell 版などが用意されています(というか作成しました)。また Datadog 仕様のトレースと接続するためにプロパゲーターなども用意されています(これも作成しました)。

実際に手元で動かしてみたい場合はリポジトリーの examples ディレクトリーを参照してください。

Open Telemetry を活用してオブザーバビリティーを上げていきましょう。

それではメリークリスマス!


これは Haskell アドベントカレンダー 2023 25日目の記事です。

qiita.com

カトーのボギー貨車用連結器を作った

カトーのタキ1000 1000号入りセットを買ったので、アーノルトカプラーをグリーンマックスのナックルカプラーに換えた

すると、機関車との高低差が大きく登坂後に解結してしまった

そんなわけでカプラー(連結器)を作った

これを3度ぐらい現物合わせで修正していい感じになったらディテールを追加する

パラメーターの問題なのかうちの造形機の問題なのか分からないけどディテールうまく出なかった

制作過程らしき動画

STL は CC BY 4.0 で公開するので許可された範囲で好きに使ってほしい

dot ファイル 2022年版

現状の dot ファイルのたぐいをメモするついでに人に見せる形でまとめておこうと思う。

自分の思想として「フレームワークよりライブラリー」というのがあるので、プロシージャーの形で定型処理をまとめておいて実際の dot ファイルはプロシージャーを呼び出すようにしている。

github.com

Bash

Linux ではデフォルトのことが多い Bash を使っている。

リポジトリーをクローンしてきたところに各種 example を置いてあるので、それをコピーしてきて随時そのマシンに合わせて書き換える。

cd

mv .profile .profile.back
mv .bashrc .bashrc.back
mv .bash_logout .bash_logout.back

dot_files='path/to/this/repo'
cp "$dot_files/bash/.bash_profile.example" .bash_profile
cp "$dot_files/bash/.bashrc.example" .bashrc
cp "$dot_files/bash/.bash_logout.example" .bash_logout

# edit .bash_profile .bashrc .bash_logout

.bash_profile

.bash_profile はこんな感じ。

# dotfiles リポジトリーのディレクトリーを指定する
dot_files=.

# ここでプロシージャーを定義してあるライブラリーをロードする
# shellcheck source=/dev/null
source "$dot_files/sh/lib.sh"
# shellcheck source=/dev/null
source "$dot_files/bash/lib.bash"

# ~/.bin とかを PATH に追加
add_local_bin

# shellcheck source=/dev/null
source "$HOME/.bashrc"

# X 環境なら
setup_sands

# SSH エージェントを起動
# WSL2 の場合は Windows で起動してあるエージェントにつなぎに行くようにしてある(が、ちょっとバグってる
# くわしくは https://kakkun61.hatenablog.com/entry/2022/06/28/WSL2_%E3%81%AE_SSH_Agent_%E7%9B%86%E6%A0%BD
start_ssh_agent
# start_ssh_agent_wsl

# もろもろ設定のための環境変数の定義
setup_gpg

setup_git_env

setup_saml2aws

.bash_logoutSSH エージェントの後始末だけ。

.bashrc

.bashrc はこんな感じ。

# この辺は .bash_profile と一緒
dot_files=.

# shellcheck source=/dev/null
source "$dot_files/sh/lib.sh"
# shellcheck source=/dev/null
source "$dot_files/bash/lib.bash"

# もろもろ設定
# 環境変数の定義したり eval したり source したり
setup_nix

setup_less

setup_prompt "$dot_files"

setup_dircolors

setup_bashmarks "$dot_files"

setup_fuck

setup_bash_config

setup_ls

setup_shellcheck

setup_direnv

setup_git_completion "$dot_files"

使ってるツール

あんまり多くは使ってないが使ってるのは次のような感じ。

  • fuck
    • 「それはまちがいだからこう実行しなおしてね」というエラーのときに fuck と打てばよくなる
  • direnv
    • nix と連携してる
  • nix
    • バージョン違いの C ライブラリーとかインストールして管理できる
  • shellcheck

PowerShell

しごとでないときは WindowsPowerShell を使っている。

PowerShell には標準でパッケージマネージャーが付いてくるので外部ライブラリーを入れるのが簡単。

[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingInvokeExpression', '', Justification = 'For the fuck')]

param ()

# dotfiles リポジトリーのディレクトリーを指定する
$dotFiles = '.'

# 自前ライブラリーをインポート
. $dotFiles\pwsh\lib.ps1

# 外部ライブラリーをインポート
Import-Module Posh-Git
Import-Module posh-sshell
Import-Module PSBookmark
Import-Module psake
Import-Module ghcman
Import-Module path-switcher
Import-Module code-page

Import-DotenvModule

# SSH エージェントの起動
Start-SshAgent -Quiet

# 環境変数の設定とかローカルの ps1 ファイルのインポートとか
Initialize-Chocolatey
Initialize-Python

# the fuck
Invoke-Expression "$(thefuck --alias)"

# prompt
Set-Item -Path Function:\prompt -Value (Get-Prompt) -Options ReadOnly

# arduino
. $dotFiles\lib\arduino-cli\completion.ps1

使ってるツール

  • Posh-Git
    • プロンプトに Git の情報を表示したり
  • posh-sshell
    • SSH エージェントの管理
  • PSBookmark
  • psake
  • ghcman
    • GHC の管理(自作)
  • path-switcher
    • PATH の管理用ユーティリティー(自作)
  • code-page

NixOS

この年末年始に NixOS 機が1つできたのでそれは当然 /etc/nixos/configuration.nix で管理しているが、home-manager までは手が出ていない。

github.com

RSS 監視して Discord に投げるやつを Raspberry Pi で動かした

これをしようとコードを書いた。クロスコンパイルの容易さから Go で書いた。Raspberry Pi 2 Model B で動かしている。

feed-trigger

ひとつめは feed-trigger。

github.com

これは RSS をチェックして更新があると指定されたコマンドの標準入力に新規エントリーのみを含めたフィードを渡して起動するやつ。

discord-feed-post

ふたつめは discord-feed-post

github.com

これは標準入力から取得した RSS フィードを Discord に投稿するやつ。

これらふたつを合わせて cron で1時間に1回起動するようにした。

課題

RSS 2・RSS 1・Atom のどれか(もしくは複数)で失敗している。

wd コマンドをリリースした

wd コマンドって?

これがしたかった。

$ wd ディレクトリー コマンド オプション

とすると「ディレクトリー」をワーキングディレクトリーにして「コマンド」を「オプション」付きで実行する。

pushd でもできるけど popd と合わせるとタイプ数が多かった。

インストール

GitHub のリリースページに WindowsLinuxmacOS (x64) 用のバイナリーがある1

github.com

自分でビルドする場合は cabalghc が必要。

$ make install

気に入ったら GitHub にスターをよろしくね。


  1. GitHub Actions に macOS (ARM) が提供されるとそのバイナリーを追加するつもり。

初めての Modellbahn-Shop Lippe(ドイツ型鉄道模型)

芦屋のモデルバーンに行ったらドイツ国有鉄道(Deutsche Reichsbahn-Gesellschaft)03形蒸気機関車サウンド付きが22000円とびっくりお手ごろ価格だったのでウッカリしてしまった。

www.instagram.com

ESU LokSound v3 搭載の2004年製品のようだが十分に恰好いい。キャブにスピーカーがデデンと鎮座している以外は何も文句がない。デデンなスピーカーだけあって音がいい。

単行も悪くはないが、そうは言っても引かれるものがほしくなってくるというもの。

調べると急行用機関車だそうなので客車を物色する。

ヤフオク!で一等二等合造客車と荷物車のセットがあったので落札。これもちょっと古そうな製品だけど悪くない。2両で税込8635円、送料1130円。

www.instagram.com

ほんでもうちょっと引きたいな~となったのでドイツのお店に発注!界隈で有名な Modellbahn-Shop Lippe

一二三等合造車と三等車と食堂車。実はちょっとまちがえて DRB と略される方の Deutsche Reichsbahn の車両なのでちょっと時代が違うがまあよかろう1。それぞれ54.54ユーロ、送料35ユーロ。

www.instagram.com

8月1日15時に発注して着荷は8月8日午前だった。早い。

最後に走行シーン。

www.instagram.com

ほな!


  1. 1924-1937 はドイツ国有鉄道(Deutsche Reichsbahn-Gesellschaft)、1937-1945 はドイツ帝国鉄道(Deutsche Reichsbahn)。