GitLab Flavored Markdownにメトリクスチャートを埋め込む

GitLabが管理するKubernetesメトリクスの組み込み

GitLab 12.2で導入されました

GitLab Flavored Markdownフィールド(イシューやマージリクエストの説明など)にメトリクスチャートを表示することができます。 GitLab Flavored Markdownフィールドに埋め込むことができるチャートの最大数は100です。

これは、アプリケーション・インシデントやパフォーマンス・メトリクスを他の人と共有し、関連する情報を直接入手したい場合に便利です。

注:Kubernetesメトリクスが必要です。

メトリクス・チャートを表示するには、https://<root_url>/<project>/-/environments/<environment_id>/metrics

Embedded Metrics Markdown

GitLabはリンクを埋め込みメトリクスパネルとして展開します:

Embedded Metrics Rendered

チャートへのリンクを取得するには、この例のように、チャートの右上にある その他のアクションメニューをクリックし、チャートへのリンクをコピーを選択します:

Copy Link To Chart

メトリクスを展開するには、以下の条件を満たす必要があります:

  • <environment_id> は実際の環境に対応していなければなりません。
  • プロメテウスは環境を監視しているのでしょう。
  • GitLabインスタンスは環境からデータを受け取るように設定する必要があります。
  • ユーザーは、環境のモニタリングダッシュボードレポーター以上)へのアクセスが許可されている必要があります。
  • ダッシュボードは過去8時間以内のデータでなければなりません。

上記のすべてが当てはまる場合、メトリクスは以下のように展開されます:

Embedded Metrics

メトリクスチャートは非表示にすることもできます:

Show Hide

ブラウザで直接リンクを開くと、データの詳細が表示されます。

イシュー・テンプレートへのメトリクスの埋め込み

また、イシュー・テンプレートにデフォルトのダッシュボード・メトリクスまたは個々のメトリクスのいずれかを埋め込むこともできます。 チャートを並べて表示するには、メトリクス・ダッシュボード全体または個々のメトリクスへのリンクを、カンマまたはスペースで区切ってください。

Embedded Metrics in issue templates

インシデント・イシューへのアラートに基づくメトリクスの組み込み

GitLabが管理するアラートルールの場合、イシューにはアラートに対応するクエリのチャートが埋め込まれます。 チャートには、インシデントの開始時点から前後30分の1時間のデータが表示されます。

手動で設定されたPrometheusインスタンスの場合、これらの要件を満たしていれば、クエリに対応するChartを含めることができます:

  • このアラートは GitLab で管理されている環境に対応しています。
  • アラートはレンジクエリに対応しています。
  • アラートには、以下のChartに記載されている必須属性が含まれています。
属性 必須 説明
annotations/gitlab_environment_name はい アラートに対応するGitLab管理環境名
annotations/title,annotations/summaryの一つ、labels/alertname はい チャートのタイトルとして使用されます。
annotations/gitlab_y_label いいえ チャートのY軸ラベルとして使用されます。

クラスター健康図の埋め込み

GitLab Ultimate12.9で導入されました

クラスター健全性メトリクスはGitLab風味のMarkdownに埋め込むこともできます。

メトリクスチャートを埋め込むには、GitLab風味のMarkdownがサポートされている場所であればどこでも、https://<root_url>/<project>/-/cluster/<cluster_id>?<query_params> 。 チャートへのリンクを生成してコピーするには、Cluster Health Metricドキュメントの指示に従ってください。

メトリクスを展開するには、以下の条件を満たす必要があります:

  • <cluster_id> は実際のクラスターに対応している必要があります。
  • Prometheusがクラスターを監視している必要があります。
  • ユーザーは、プロジェクト・クラスターのメトリクスへのアクセスが許可されている必要があります。
  • ダッシュボードは、クラスターのヘルスページでデータを報告している必要があります。

上記の条件を満たせば、メトリクスは以下のように展開されます。

Embedded Cluster Metric in issue descriptions