MackerelのAPI Keyを入れ替えてみた

今回はMackerelのAPIキーの入れ替えをする手順についてブログを書いていきたいと思います。
2022.07.15

こんにちは、こんばんは、きだぱんです。
今回はMackerelのAPIキーを入れ替えする手順についてブログを書いていきたいと思います。

Mackerelとは、クラウド時代に最適な監視モデルと誰でも簡単に使えるUIによって、システムの運用・監視にチームで取り組み文化を育むSaaS型サーバー監視サービスです。
詳しくはMackerel公式サイトをご覧ください。↓

今回のAPIキーの入れ替えについては、

  1. 新規APIキーの作成
  2. Mackerel-Agentとの連携
  3. 既存APIキーの削除

の順に御説明致します。

前提

Mackerel Organizationsの作成、Mackerel Agentをインストールして監視済みのインスタンスがある状態でのAPI Keyの変更を行っていきます。

APIキー作成

まずは現在設定されているAPIキーを確認していきましょう。
オーガニゼーション設定画面から、APIキーを選択することですべてのAPIキーを確認することが出来ます。
先に、新しく設定するAPIキーを作成します。
右上の新しいAPIキーを追加を選択します。

新規APIキーに名前と必要であればメモを入力します。

  • 名前 ※必須
    今回は、新規のAPIキーの名前をnew_testとします。
    (名前は後からでも変更可能です)
  • メモ
    メモに新規に作成したAPIキーと分かるよう記述しておきます。
  • 権限 ※重要
    ReadWriteの両方にチェックを入れます。
    読み取り権限と書き込み権限の両方が必須になりますので、確認しましょう。

作成を選択します。
APIキーの一覧画面に表示されたら、新規APIキーの作成は完了です。

Mackerel-agent上での操作

バージョンの確認

念のため、Mackerel-agentのバージョンをアップデートし最新のものにしておきましょう。

# アップデートコマンド
$ sudo yum update mackerel-agent
# 結果
Dependencies Resolved
================================================================================
 Package              Arch         Version                 Repository      Size
================================================================================
Updating:
 mackerel-agent       x86_64       0.72.14-1.amzn2         mackerel       2.1 M
.
.
.
Complete!

Complete!となれば、完了です。
Mackerelのホスト画面を確認するとバージョンが最新になっているはずです。

新規APIキーへの書き換え

APIキーを書き換えていきます。
お使いの環境で、/etc/mackerel-agent/mackerel-agent.confを書き換えていきます。
詳しくは、こちらをご覧ください。 私は、Linux環境なので下記のようになります。

# mackerel-agent.conf内へ
$ sudo vim /etc/mackerel-agent/mackerel-agent.conf

# mackerel-agent.conf内の
apikey = "APIKEY" # ここを書き換えます。
pidfile = "/path/to/pidfile"
root = "/var/lib/mackerel-agent"
.
.
.

apikey =~~~を先ほど作成した新規APIキーへ書き換えます。

mackerel-agent.conf 書き換えたら再起動操作は必須なので、再起動をかけていきます。
起動方法はこちらをご覧ください。 

# Linux環境
$ sudo systemctl start mackerel-agent

新規APIキーへの書き換えは以上です。

既存APIキーの削除

新規APIキーへの書き換えが完了したら、既存のAPIキーを削除します。
オーガニゼーション設定画面から、APIキーの一覧を開きます。最初と比べて画面に変化はありません。
現時点では、どのホストにどのAPIキーが適応されているかは、一覧から確認することができません。
一個前のAPIキーの書き換えが正確に行われていれば問題はありませんが、
※数日経てば、APIキーの下に「n日(か月)以上使われていません」と表示されるはずです。
念のため、表示を確認してから削除する方が良いでしょう

削除方法は簡単です。
既存のAPIキーを選択します。

編集から削除を選択し、OKを選びます。
APIキーの一覧には、新規APIキーだけが残ります。
ホストを確認してみると削除後も正常に動作していることが確認できます。

おわりに

MackerelのAPIキーの入れ替えをする手順についてまとめてみました。
Mackerelに関するブログは他にも沢山展開されていますので、是非こちらもご覧ください。
Mackerel の記事一覧 | DevelopersIO

この記事がどなたかのお役に立てば幸いです。