Automation Suite - 監視スタックを使用する

automation-suite

2023.4

false

Linux の Automation Suite のインストールガイド

重要 :

このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。

監視スタックを使用する

Automation Suite クラスターの監視スタックには、Prometheus、Grafana、および Alertmanager が含まれ、これらは Rancher Cluster Explorer UI 内で連携されます。

注:

ノードに障害が発生すると Kubernetes がシャットダウンし、Prometheus のアラートが中断される可能性があります。これを防ぐには、RKE2 サーバー上に別個のアラートを設定することをお勧めします。

このページでは、一連の監視シナリオについて説明します。詳細については、Rancher Monitoring の使用に関する公式の Rancher ドキュメントをご覧ください。

重要:

コレクターを使用してサードパーティツールにメトリックをエクスポートする場合、アプリケーションの監視を有効化すると、Automation Suite の機能が中断される可能性があります。

監視ツールにアクセスする

概要

Automation Suite クラスターの監視スタックには、Prometheus、Grafana、Alert Manager、Longhorn ダッシュボードが含まれます。

このページでは、一連の監視シナリオについて説明します。

詳細については、Rancher Monitoring の使用に関する公式の Rancher ドキュメントをご覧ください。

Automation Suite 監視ツールには、次の URL を使用して個別にアクセスできます。

アプリケーション	ツール	URL	例
メトリック	Prometheus	`https://monitoring.fqdn/metrics`	`https://monitoring.automationsuite.mycompany.com/metrics`
ダッシュボード	Grafana	`https://monitoring.fqdn/dashboard`	`https://monitoring.automationsuite.mycompany.com/dashboard`
アラート管理	Alertmanager	`https://monitoring.fqdn/alertmanager`	`https://monitoring.automationsuite.mycompany.com/alertmanager`
永続ブロックストレージ	Longhorn ダッシュボード	`https://monitoring.fqdn`	`https://monitoring.automationsutie.mycompany.com`

監視ツールの認証

監視ツールに初めてアクセスする場合、管理者として次の既定の資格情報でログインします。

ユーザー名: admin
パスワード: パスワードを取得するには、次のコマンドを実行します。
```
kubectl get secrets/dex-static-credential -n uipath-auth -o "jsonpath={.data['password']}" | base64 -dkubectl get secrets/dex-static-credential -n uipath-auth -o "jsonpath={.data['password']}" | base64 -d
```

Dex 認証

監視ツールへのアクセス時に Dex 認証に使用する既定のパスワードを更新するには、次の手順を実行します。

注:

Dex は、監視ツールに階層化された基本的な認証方法です。したがって、Dex パスワードを更新しても、監視ツールのパスワードには影響しません。このシナリオでは、監視ツールのパスワードは以前と同じままです。

newpassword を新しいパスワードに置き換えて、次のコマンドを実行します。

password="newpassword"
password=$(echo -n $password | base64)
kubectl patch secret dex-static-credential -n uipath-auth --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]"password="newpassword"
password=$(echo -n $password | base64)
kubectl patch secret dex-static-credential -n uipath-auth --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]"

<cluster_config.json> を構成ファイルのパスに置き換えて、次のコマンドを実行します。

/opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement/opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement

現在発生しているアラートを確認する

アラートを表示するには、https://monitoring.fqdn/metrics を使用して Prometheus に移動し、[Alerts] タブを選択します。ここでは、Automation Suite で設定されたすべてのアラートを確認できます。

アクティブなアラートを表示するには、上部の [Firing ] チェックボックスと [Show annotations] チェックボックスをオンにして、アラートのステータスをフィルター処理します。ここでは、現在発生しているすべてのアラートと、対応するメッセージを確認できます。

アラートを抑制する

アラートが多すぎる場合は、これらを抑制できます。そのためには、以下の手順に従ってください。

[監視] ダッシュボードの左上隅にある[Alertmanager] タイルを選択します。次の画面が表示されます。
該当のアラートを見つけ、[Silence] を選択します。
[Creator] と [Comment] の詳細を入力し、[Create] を選択します。アラートが [Monitoring] ダッシュボードに表示されたり、設定した受信者にレポートされることはなくなります。

アラートを設定する

注: アラートの構成を開始する前に、 kubectl を有効化してください。

新しいメール設定を追加する

インストール後に新しいメール設定を追加するには、次のコマンドを実行します。

./uipathctl config alerts add-email \
  --name test \
  --to "admin@example.com" \
  --from "admin@example.com" \
  --smtp server.mycompany.com \
  --username admin \
  --password somesecret \
  --require-tls \
  --ca-file <path_to_ca_file> \
  --cert-file <path_to_cert_file> \
  --key-file <path_to_key_file> \
  --send-resolved./uipathctl config alerts add-email \
  --name test \
  --to "admin@example.com" \
  --from "admin@example.com" \
  --smtp server.mycompany.com \
  --username admin \
  --password somesecret \
  --require-tls \
  --ca-file <path_to_ca_file> \
  --cert-file <path_to_cert_file> \
  --key-file <path_to_key_file> \
  --send-resolved

フラグ	説明	例
`name`	メール設定の名前	`testconfig`
`to`	受信者のメールアドレス	`admin@example.com`
`from`	送信者のメールアドレスです。	`admin@example.com`
`SMTP`	SMTP サーバーの URL または IP アドレスとポート番号	`server.mycompany.com:567`
`username`	認証ユーザー名	`admin`
`password`	認証パスワード	`securepassword`
`require-tls`	SMTP サーバーで TLS が有効化されることを示す Boolean フラグ。	N/A
`ca-file`	SMTP サーバーの CA 証明書を含むファイルパス。CA がプライベートの場合、これは任意です。	`./ca-file.crt`
`cert-file`	SMTP サーバーの証明書を含むファイルパス。証明書がプライベートの場合、これは任意です。	`./cert-file.crt`
`key-file`	SMTP サーバーの証明書の秘密キーを含むファイルパスです。証明書がプライベートの場合、これは必須です。	`./key-file.crt`
`send-resolved`	アラートの解決後にメールを送信する Boolean フラグ。	N/A

メール設定を削除する

メール設定を削除するには、次のコマンドを実行する必要があります。必ず、削除するメール設定の名前を渡してください。

./uipathctl config alerts remove-email --name test ./uipathctl config alerts remove-email --name test

メール設定を更新する

メール設定を更新するには、次のコマンドを実行する必要があります。必ず、更新するメール設定の名前と、編集する追加の任意パラメーターを渡してください。これらのパラメーターは、新しいメール設定を追加するためのパラメーターと同じです。1 つ以上のフラグを同時に渡すことができます。

./uipathctl config alerts update-email --name test [additional_flags]./uipathctl config alerts update-email --name test [additional_flags]

Grafana ダッシュボードにアクセスする

Grafana ダッシュボードにアクセスするには、資格情報を取得し、その資格情報を使用してログインする必要があります。

ユーザー名:

kubectl -n cattle-monitoring-system get secrets/rancher-monitoring-grafana -o "jsonpath={.data.admin-user}" | base64 -d; echokubectl -n cattle-monitoring-system get secrets/rancher-monitoring-grafana -o "jsonpath={.data.admin-user}" | base64 -d; echo

パスワード:

kubectl -n cattle-monitoring-system get secrets/rancher-monitoring-grafana -o "jsonpath={.data.admin-password}" | base64 -d; echokubectl -n cattle-monitoring-system get secrets/rancher-monitoring-grafana -o "jsonpath={.data.admin-password}" | base64 -d; echo

サービスメッシュを監視する

[Istio Mesh] と [Istio Workload] の Grafana ダッシュボードから、Istio サービスメッシュを監視できます。

Istio Mesh ダッシュボード

このダッシュボードには、選択した期間での全体的な要求量と、サービスメッシュ全体の 400 と 500 のエラー率が表示されます。このデータはウィンドウの右上に表示されます。この情報については、上部の 4 つのグラフをご覧ください。

ここには、個々のサービスの過去 1 分間における即時成功率も表示されます。NaN という成功率は、そのサービスで現在トラフィックがないことを示しています。

Istio Workload ダッシュボード

このダッシュボードでは、ウィンドウの右上で選択した時間範囲におけるトラフィックメトリックが表示されます。

ダッシュボードの上部にあるセレクターを使用して、特定のワークロードにドリルダウンします。特に注目するのは、uipath 名前空間です。

上部セクションには全体的なメトリックが示されます。[Inbound Workloads] セクションは送信元に基づいてトラフィックを分離し、[Outbound Services] セクションは宛先に基づいてトラフィックを分離しています。

永続ボリュームを監視する

[Kubernetes / Persistent Volumes] ダッシュボードでは、永続ボリュームを監視できます。各ボリュームについて、空き領域と使用されている領域を追跡できます。

また、 Cluster Explorer の [ Storage] メニュー内の[PersistentVolumes] 項目を選択して、各ボリュームのステータスを確認することもできます。

ハードウェアの使用状況を監視する

ノードごとのハードウェア使用状況を確認するには、[Nodes] ダッシュボードを使用できます。CPU 上のデータ、メモリ、ディスク、およびネットワークについて表示できます。

[Kubernetes / Compute Resources / Namespace (Workloads)] ダッシュボードを使用して、特定のワークロードのハードウェア使用状況を監視できます。uipath 名前空間を選択して必要なデータを取得します。

Grafana のグラフの共有可能な視覚的スナップショットを作成する

グラフのタイトルの横にある下向き矢印を選択し、[ 共有] を選択します。
[ スナップショット ] タブを選択し、[ スナップショット名]、[有効期限]、[ タイムアウト] を設定します。
[snapshot.raintank.io に パブリッシュ ] を選択します。

詳細については、ダッシュボードの共有に関する Grafana のドキュメントをご覧ください。

注: このスナップショットは、このリンクを持つ誰もがパブリックインターネット上で表示できます。

カスタムの永続 Grafana ダッシュボードを作成する

カスタムの永続 Grafana ダッシュボードを作成する方法について詳しくは、Rancher のドキュメントをご覧ください。

Grafana への管理アクセス

ダッシュボードは既定で匿名ユーザーに対して読み取りアクセスが可能になっているため、Automation Suite クラスターでは通常、Grafana への管理者アクセスは必要ありません。また、カスタムの永続的なダッシュボードを作成するには、このドキュメントで前述した Kubernetes ネイティブの手順を使用して作成する必要があります。

それにもかかわらず、Grafana への管理者アクセスは、次の手順で可能です。

Grafana 管理アクセスの既定のユーザー名とパスワードは、次のようにして取得できます。

kubectl get secret -n cattle-monitoring-system rancher-monitoring-grafana -o jsonpath='{.data.admin-user}' | base64 -d && echo
kubectl get secret -n cattle-monitoring-system rancher-monitoring-grafana -o jsonpath='{.data.admin-password}' | base64 -d && echokubectl get secret -n cattle-monitoring-system rancher-monitoring-grafana -o jsonpath='{.data.admin-user}' | base64 -d && echo
kubectl get secret -n cattle-monitoring-system rancher-monitoring-grafana -o jsonpath='{.data.admin-password}' | base64 -d && echo

高可用性 Automation Suite クラスターでは、ノードに障害が発生した場合に中断のない読み取りアクセスと、大量の読み取りクエリを可能にするために、複数の Grafana ポッドが存在することに注意してください。これは、ポッドがセッション状態を共有せず、ログインに必要になるため、管理者アクセスと互換性がありません。この問題を回避するには、管理者アクセスが必要な状態で、Grafana レプリカの数を一時的に 1 に増やす必要があります。 Grafana レプリカの数をスケーリングする方法については、以下の手順をご覧ください。

# scale down
kubectl scale -n cattle-monitoring-system deployment/rancher-monitoring-grafana --replicas=1
# scale up
kubectl scale -n cattle-monitoring-system deployment/rancher-monitoring-grafana --replicas=2# scale down
kubectl scale -n cattle-monitoring-system deployment/rancher-monitoring-grafana --replicas=1
# scale up
kubectl scale -n cattle-monitoring-system deployment/rancher-monitoring-grafana --replicas=2

Prometheus にクエリを実行する

[ Monitoring] ダッシュボードで、 [Prometheus Graph]を選択します。新しいウィンドウが表示されます。

使用可能なメトリックについてのドキュメントを以下に示します。

カスタムアラートを作成する

ブール式による Prometheus クエリを使用して、カスタムアラートを作成できます。

これを行うには、[ 監視] ダッシュボード の [ 詳細] メニューで [ Prometheus ルール] を選択します。
ウィンドウの右上にある [Create] を選択して新しいアラートを作成し、Rancher のドキュメント「PrometheusRules」に従います。
アラートが発生すると、これが [Monitoring] ダッシュボードに表示されます。また、設定した受信者に通知されます。

Kubernetes リソースステータスを監視する

ポッド、デプロイ、ステートフルセットなどのステータスを表示するには、Cluster Explorer UI を使用できます。これは、Rancher サーバーエンドポイントにログインした後に表示されるページと同じページです。このホームページには、概要が表示され、左側で各リソースタイプに固有の詳細にドリルダウンできます。ページの上部には、名前空間セレクターがあります。このダッシュボードをレンズツールと置き換えることもできます。

Prometheus メトリックを外部システムにエクスポートする

Prometheus は、Prometheus リモート書き込み機能を使用して、Prometheus メトリックを収集し、外部システムにエクスポートします。

注: UiPath® では、リモート書き込みエンドポイント連携のサポートまたは保守を行いません。ただし、エンドポイントは、Automation Suite 内で提供される Prometheus インスタンスと互換性があります。

Automation Suite クラスターで remote_write を設定するには、以下の手順を実行します。

ArgoCD に接続します。
[ アプリケーション] を選択します。
fabric-installer に移動します。
[APP DETAILS] パネルを開き、self-heal を無効化します。
Rancher 監視アプリケーションに移動します。
[APP DETAILS] パネル > [MANIFEST] タブを開きます。
[ EDIT] を選択し、 prometheus > prometheusSpec セクション> 値に移動します。
必要な remoteWrite 設定を追加します。

リモート書き込み機能で使用できる設定を見つけます。
新しい設定を保存します。新しい設定が適用されるまで、Rancher の監視アプリケーションには OutOfSync が表示されます。

注: Prometheus は、新しいリモート書き込み設定を適用するために再起動する必要はありません。
必要なリモート書き込み連携をテストします。手順 8 に戻り、新しい設定を追加します。