HG-CLIエージェント導入ツールの使い方：ステップ別ガイド

Great systems are not just built. They are monitored.

MetricFire runs Graphite and Grafana as a fully managed service for small engineering teams, taking care of storage, scaling, and version updates so your team doesn't have to. Plans start at $19/month, billed per metric namespace rather than per host, and include engineer-staffed support. Integrations work natively with Heroku, AWS, Azure, and GCP, and data is stored with 3× redundancy in SOC2- and ISO:27001-certified data centres.

はじめに

MetricFireの最新プロジェクトとして、まったく新しいCLIツールをリリースしました。このツールを使えば、どのOSでもエージェントのインストールが簡単に行えるようになり、非常に完成度が高いと自負しています。

本記事では、HG-CLIの概要と、ターミナルユーザーインターフェース（TUI）モードおよびコマンドラインインターフェース（CLI）モードでの使用方法を解説します。さらに、収集されたメトリクスをHosted Graphiteアカウントに転送した後の活用方法もご紹介します。これにより、わずか数分で包括的なサーバー監視環境を構築できます！MetricFireのHosted Graphiteアカウントをお持ちでない場合は、こちらから14日間の無料トライアルにお申し込みください。

HG-CLIツールでエージェントをスムーズに導入・設定

MetricFireでは、これまでエージェントをインストールしたことがないユーザーでも、導入を可能な限りスムーズに行えるようにしたいと考えました。HG-CLIの目的は、エージェントのインストール、意味のあるメトリクスの収集開始、そしてダッシュボードでのデータ確認を数分以内に実現する、迅速かつ簡単な方法を提供することです。これにより、自社で監視ソリューションをホストする負担が軽減され、コア業務に注力する時間と自由度が増します！

エージェントのインストール自体はそれほど難しくはありませんが、複数の手順を踏む必要があり、設定ファイルを扱う必要があります。これらの設定ファイルは多くの場合YAML形式で、インデントや空白の扱いに非常に厳格なため、編集時に苛立ちを覚えることも少なくありません。ユーザーは設定を掘り下げ、適切なオプションを探し、手動でファイルをフォーマットする必要があります。これを簡素化するため、監視と可観測性コミュニティの面倒な作業を代行するワンステップソリューションの構築に着手しました。言うまでもなく、オープンソース技術に基づいて構築されています！

HG-CLIツールを使用したエージェントの設定とインストール手順は以下の通りです。

• HG-CLIツールを任意のOSにインストール：

curl -s "https://www.hostedgraphite.com/scripts/hg-cli/installer/" | sudo sh

• TUIモードで実行：

hg-cli tui

• 「Agents」から「Agent」を選び、「Install」を選択：

• Hosted Graphite APIキーを追加し、「Default」または「Custom」設定を選択（カスタムインストールの場合、Xキーを使用してメトリックタイプを選択）：

• Enterキーを押してインストール/設定を実行します。表示される出力に注意してください。
  • ローカルマシン上の設定ファイルの場所
  • ローカルマシンでエージェントを起動するコマンド
• エージェントを起動すると、メトリクスが収集され、ホステッドGraphiteアカウントに転送されます。
  
  • 例：brew services start telegraf または sudo systemctl start telegraf

カスタムダッシュボードとアラートの作成

新しいエージェントメトリクスを使用して、無制限の可視化とアラートを作成できます。これがこの機能の醍醐味です！

• HGアカウントにログインし、メトリクス検索UIでエージェントメトリクス（接頭辞がtelegraf.*）を確認：

• 「Dashboards」から「Telegraf」に移動すると、メトリクスが自動生成されたダッシュボードに表示されます！

• 「Alerts」→「Graphite Alerts」の順に選択し、任意のメトリクスに対して新しいアラートを追加：

• ドキュメントを参照し、インフラストラクチャの他のレイヤーを監視する方法をご確認ください。
• お疲れ様でした。これでエンドツーエンドの監視環境が構築完了です。チームの新たなるDevOpsマスターとなりました！

追加のHG-CLIコマンド

HG-CLIツールをCLIモードで実行すると、エージェントのプログラムによるインストール（デフォルト/カスタムプラグイン付き）、APIキーの更新、設定の微調整をわずか数個のフラグで実行できます。ツールは現在も進化中ですが、サーバー群でエージェントを迅速に稼働させる簡単な方法として既にその有用性が実証されています。

• デフォルト設定でCLIモードを使用してTelegrafをインストールする方法：

hg-cli agent install telegraf --apikey <HG-API-KEY> --install default

• カスタムインストールの場合、必要なプラグインを指定：

hg-cli agent install telegraf --apikey <HG-API-KEY> --install custom --plugins cpu,disk,mem,system

• 既存のTelegraf設定でAPIキーを更新する方法：

hg-cli agent update-apikey telegraf --apikey <HG-API-KEY> --config <config path>

• エージェントをアンインストールする方法：

hg-cli agent uninstall telegraf 

最新の更新情報やプラグインを入手するには、LinkedInとXのフォローをお忘れなく！

今後の目標と新機能

ツール（OpenTelemetry）に追加エージェントを組み込み、ユーザーにさらなる監視オプションを提供する予定です。また、NGINX、MySQL、PostgreSQL、GitHub、Dockerなど、人気のTelegraf Input プラグインを設定する機能も実装いたします！

将来的には、当社のHosted Graphite APIとの連携機能も追加予定です。これにより注釈、アラート、集計ルールなどの作成が可能になります！プラットフォームの仕組みを学ぶ初心者ユーザーや、日常的な監視ワークフローで活用したいユーザーにとって有益な機能となるでしょう。

まとめ

MetricFireでは、インフラ監視を可能な限りシームレスでアクセスしやすいものにすることに注力しています。新しいCLIツールはインストールプロセスを簡素化し、手間や推測作業なしに数秒で強力な監視環境を構築できるように設計されています。このツールが開発者の皆様に、優れた製品開発に専念する環境を築くきっかけとなれば幸いです。ベータ版への参加やフィードバックをお寄せいただける場合は、ぜひご連絡ください。皆様と共に更なる進化を遂げてまいる所存です。

HG-CLIツールについてのご意見がございましたら、ぜひお聞かせください。機能リクエストやご提案は、サポートチームまでお問い合わせいただけますと幸いです。皆様のニーズに最適な監視ソリューションを提供するため、あらゆる可能性を模索してまいります。