OpenTelemetry対応でさまざまなアプリからデータを取得＆追跡できるオープンソースなシステム監視・分析ツール「SigNoz」を使ってみた

システムの状態を監視するためのツールは多数存在していますが、その中でもSigNozはメトリクス・トレース・ログというシステム観測の3本柱に対応しており、さらに「OpenTelemetry」を利用してさまざまなアプリのデータを取得できるツールとのことなので、実際に使って試してみました。

Open source APM | SigNoz
https://signoz.io/

SigNozはmacOSのほか、Linuxの下記のディストリビューションで動作するとのこと。

・Ubuntu
・Debian
・OpenSuse
・CentOS
・SUSE Linux Enterprise Server (SLES)

その他のディストリビューションにおいてもDocker経由で起動することが可能とされていますが、今回はDebianを利用して進めていきます。まずは下記のコードで各パッケージを更新しておきます。

sudo apt update && sudo apt upgrade -y

下記のコマンドでgitをインストール。

sudo apt install git -y

下記のコマンドでSigNozのリポジトリをクローンします。

git clone -b main https://github.com/SigNoz/signoz.git && cd signoz/deploy/

そして下記のコマンドでインストールスクリプトを実行。

./install.sh

SigNozの動作のイメージ画像は下図の通り。インストールスクリプトではドットの枠線内のコンポーネントがインストールされるとのことです。

インストールの途中で確認が入るので、エンターキーを押して続行します。

インストールが完了すると、下図のような表示が出るのでブラウザを起動して「localhost:3301」にアクセスします。

「メールアドレス」「氏名」「組織名」「パスワード」を入力して「Get Started」をクリック。

SigNozには最初からサンプルとしてダミーデータが用意されており、ログインすると下図のようにサービス一覧にさまざまなアプリが表示されます。今回はこのダミーデータを利用してSigNozがどのようにデータを表示するのかを確認していきます。「customer」アプリケーションをクリック。

アプリケーション画面ではレイテンシーや毎秒のオペレーション数、エラー割合を確認可能。具体的に発生したオペレーションの名前も一覧形式で表示されます。

システムの監視・追跡において、システムの作業は「スパン」という単位で管理されます。「Traces」タブではそのスパンごとに詳細な内容を確認できるようになっています。スパンの一覧から、「HTTP GET /dispatch」というオペレーションのスパンをクリック。

そのスパン内でどの作業にどれくらいの時間がかかったのかについての詳細な情報が確認可能です。

スパンの一覧を絞り込むことも可能です。Tracesタブの一番上にある「Click to filter by tags」をクリックし、「Add Tags Filter」をクリック。

Tags欄をクリックするとフィルターする要素の候補が出現するので、絞り込みたい内容を選択します。この部分の書式はオープンテレメトリの仕様に従っているとのこと。今回は「sql.query.(string)」をクリックしました。

続いて比較演算子を選択します。「EQUALS」「NOT EQUALS」「IN」「NOT IN」「EXISTS」「NOT EXISTS」「STARTS WITH」「NOT STARTS WITH」「CONTAINS」「NOT CONTAINS」が選択可能。今回は「EQUALS」をクリック。

右端の空欄をクリックするとSigNozが候補を出してくれるので目的のものをクリックします。

これで「Run Query」をクリックすればOK。

クエリの内容にそったものだけが表示されるようになりました。

「Logs」タブではログの件数と具体的な内容を確認することができます。

ログをフィルターすることも可能です。左下にフィールドの一覧が表示されているので、絞り込みたいフィールドをクリックして「SELECTED FIELDS」に表示された状態にしてから「Search Filter」をクリック。

SUGGESTIONSにフィールドが表示されるのでクリックし、オペレーターを選択して値をペーストします。オペレーターは「IN」「NIN(Not IN)」のほかに「GTE(≥)」「GT(>)」「LTE(≤)」「LT(<)」「CONTAINS」「NCONTAINS」が選択可能。設定できたら「Apply」をクリックします。

選択した内容に合致するログだけが表示されるようになりました。ログデータをダウンロードしたり、最新のログデータを表示するボタンのほか、「Go Live」をクリックすることで画面をリアルタイムで更新することも可能です。

リアルタイム更新中はログが流れ続けることになるので、詳細を確認したいときは「Pause」で止める必要がありそうです。

「Dashboard」タブではダッシュボードを管理できます。「New Dashboard」をクリック。

JSONデータやGrafanaのJSONデータを使ってダッシュボードをインポートすることも可能ですが、今回は「Create Dashboard」をクリックして新規に作成していきます。

「Add Panel」をクリックするとグラフと値のどちらを追加するかを聞かれます。今回はグラフをクリック。

画面の下部でクエリを設定し、「Stage & Run Query」をクリックしてプレビューを表示します。問題無ければ「Save」をクリック。

確認が出るので「OK」をクリックします。

同様の手順を続けることで自分に必要なデータだけを集めたダッシュボードを作成することができます。

「Alerts」タブではアラートの設定が可能です。「New Alert」をクリック。

「Metric」「Log」「Trace」「Exceptions」という4つの要素を元にアラートを設定できます。今回は「Metric based Alert」をクリックします。

アラートの対象にする指標をクエリで指定し、「Run Query」をクリックしてグラフをプレビューします。

下にスクロールし、アラートを発生させるしきい値を設定します。今回は「過去5分間で0.2を超えている瞬間がある場合にアラート発生」としました。

深刻度と名前、説明を記入して「Create Rule」をクリックします。

確認が出るので「OK」をクリック。

「Triggerd Alerts」をクリックするとアラートが発生しているのが分かります。

「Exceptions」タブではアプリで発生した例外の情報が表示されます。ここでスタックトレースの情報なども閲覧可能とのことですが、デモデータでは例外が発生しない模様。

「Service Map」タブではサービスを構成するコンポーネント間の依存関係がグラフで表示されます。

「Usage Explorer」タブでは時間ごと・日ごとの使用量を確認可能。

「Settings」タブでMetrics・Traces・Logsそれぞれの保存期間を設定できます。

また、「Alert Channels」ページでアラートが発生した際の連絡経路を設定可能です。「New Alert Channel」をクリック。

「Slack」「Webhook」「Pagerduty」の3つの方法で通知することが可能です。

「Organization Settings」ではチームメンバーの管理を行えます。

最下部にある「Get Started」では、それぞれの言語で書かれたアプリケーションへOpenTelemetryを導入するためのガイドが用意されています。SigNozインストールガイドの手順に従ってデモデータを削除後、実際に監視したい対象へOpenTelemetryを導入すればOK。

なお、OpenTelemetryのドキュメントではそれぞれの言語への対応状況は下記の通りとなっています。