2024.10.07

#58 Dynatrace APIの活用例

Dynatrace

API

管理

Tips

運用

皆さまこんにちは、IIMサポートチームです。  

このブログではDynatraceのTips等、
気軽に読めて皆さまのお役に立てるようなコンテンツを配信してます。

＊文中、斜体になっている単語はDynatrace画面上/ドキュメント内で使用される用語となります
　例）Service、Host など

＊青色の色掛部分は操作対象のボタンを表しています

今回は Dynatrace API がテーマです。

Dynatrace API を活用することで、Dynatrace上のデータのエクスポートや設定変更が可能です。
今回はDynatrace API の種類とそれぞれの活用例をご紹介します！

Dynatrace API の種類

Dynatrace API の種類は3つです。

• Environment API
  Dynatrace上で参照できるデータにアクセスできます。

  例：Metric データの取得等

• Configuration API

  監視環境の構成管理に有用です。
  例：OneAgent の自動アップデート設定等

• Account management API

  Account management 画面で参照できるユーザーや権限グループの管理に役立ちます。
  例：ユーザー一覧の取得等

Dynatrace API の活用例

実際にどのようにDynatrace API を活用しているのか、それぞれ例を挙げていきます。

Environment API

恐らく最も活用する頻度や幅が広いのがこのEnvironment API です。

Metricデータを取得することができるため、Dynatraceのデータを別ツールに連携する際にも使用されます。

今回は例として、Environment API のProblems API v2 をご紹介します。

Problems API v2 ではProblem 一覧や特定のProblem の詳細の取得、特定のProblem をクローズ等ができます。

簡単に流れをご説明します。

①Problems API v2 - GET problems list で対象のDynatrace environment で発生しているProblem の一覧を取得します。

期間はパラメーターで指定可能です。

②Problems API v2 - GET problems details で特定のProblem の詳細を取得し内容を確認します。

①で取得したProblem のproblemID を使用します。

③Problems API v2 - POST close a problem でProblem をクローズします。

②で確認し、クローズして問題ないと判断した場合、同じproblemID を対象にクローズします。

このように、DynatraceにアクセスしなくてもProblem の確認やクローズが可能になります！

Configuration API

Configuration API ではAnomaly detection （異常検知）等の構成管理が可能です。

管理上重要な項目である、OneAgent のアップデート設定の取得や更新もできます。

Dynatraceの設定はEnvironment 全体に対するGlobal 設定と、Host やService といった個別のEntity 毎の設定があります。

Global 設定よりもEntity 単位の設定が優先されます。

そのため、例えばGlobal 設定ではOneAgent の自動更新がOffになっていても、Host 個別の設定でOneAgent の自動更新がOnになっている場合、そのHost だけは常に最新のOneAgent が展開されることになります。

定期的にOneAgent configuration API でGlobal とHost 毎のアップデート設定を確認すると上記のような状態の防止に繋がります。

Account management API

最後はAccount management API です。

Dynatraceの活用が進むと使用する人数が増え、ユーザーの管理が煩雑になります。

部署異動や退職で不要になったユーザーを消し忘れるといったリスクもあります。

User management API - GET all users ではユーザーの一覧だけではなく、最終アクセス日時も取得できます。

また、User management API - DELETE a user でユーザーの削除もAPI経由で実行可能です。

例えばUser management API - GET all users とUser management API - DELETE a user を使ったスクリプトを作成することで、長期間使用していないユーザーを自動で削除する、といった運用も可能かと思います！

このように、Dynatrace API には様々な種類があります。

「こんなことできるかな？」と思いついた際には、是非お気軽に担当SEまでご連絡くださいませ！

関連リンク：  

Dynatrace API - Dynatrace Docs

Dynatraceサポートページ：API｜アイ・アイ・エム

#05 Entity、Entity IDとは
#22 OneAgentのアップデートの概要

#58 Dynatrace APIの活用例 については、以上となります。 
お読みいただきありがとうございました！ 

※記事執筆時 Dynatrace SaaS Version：1.293

執筆者

E.S.　

営業技術本部 技術サービス統括部 テクニカルアカウントソリューション部