🗂

Grafana API keysからService accountsへの移行

2022/11/10に公開

PDF

gurafana

tech

GrafanaのService accountsを利用する。

概要

API keysが非推奨という事で、Service accountsを利用に切り換え。

API keysを表示すると、Service accountsへ切り換えるようにメッセージが表示されている。

API Keyの移行

既存のAPI Keyは、Migrate to service accountボタンを押下。

Service accountsへ移行される。

移行の場合はこれで完了。

Service accountsの登録

新規で登録する場合はAdd service accountボタンを押下。

アカウント設定

Display nameとRoleを入力しCreateボタンを押下。

アカウントが作成される

Token追加

作成したアカウント画面でAdd service account tokenボタンを押下。

Display nameとExpirationを入力しGenerate tokenボタンを押下。

Tokenが発行されるのでコピー。

アカウントにTokenが登録される。

新しくなったキーのフォーマットについては公式ブログに書かれている。

Tokenの利用

Linksの設定の<上記でコピーしたAPIKey>の部分を、新しく発行したTokenに置換えてみたら

エラーになってPDF出力が行えなくなった。

API Keyを設定していた時のURL

http://localhost:8686/api/v5/report/AAA?apitoken=<APIKey>==&from=now-24h&to=now

API Keyの部分をTokenに置換えて設定したURL

http://localhost:8686/api/v5/report/AAA?apitoken=<Token>==&from=now-24h&to=now

ブラウザに表示されたエラー。

error fetching dashboard AAA: error obtaining dashboard from http://localhost:3000/api/dashboards/uid/AAA. Got Status 401 Unauthorized, message: {"message":"invalid API key","traceID":""}

grafana-reporter.exeのコンソールを確認してみたら==の部分がTokenの一部として渡っていた。

Called with api Token: <Token>==

Tokenを利用したURL

==の部分を削除して再設定、PDF出力が行える状態になった。

http://localhost:8686/api/v5/report/AAA?apitoken=<Token>&from=now-24h&to=now