Alteryx Serverのバックアップを作成する – Alteryx Serverアドベントカレンダー2022

Alteryx Serverアドベントカレンダー17日目
2022.12.17

こんにちは、スズです。

本記事はAlteryx Serverアドベントカレンダーの17日目の記事です。

17日目は、Alteryx Serverのバックアップについてご紹介します。

利用環境

本記事の執筆に使用しているAlteryx Serverの環境は以下の通りです。

  • Windows Server 2022 (Amazon EC2)
  • Alteryx Server 2022.1
    • セットアップタイプ:Complete Alteryx Server
    • データベースタイプ:MongoDB
    • 認証タイプ:Built-in

バックアップの取得

概要

Alteryx Serverのバックアップについては、Alteryx Communityに記事が用意されています。

日本語サイトのAlteryx Communityにもバックアップの記事が用意されていますが、今回は英語サイトの記事のコメントの内容も参考に、本記事を執筆しています。

MongoDBのバックアップは以下の手順にて行います。

  1. Alteryx Serviceのサービスの停止
  2. MongoDBのバックアップを作成
  3. Alteryx Serviceのサービスの開始

MongoDBのバックアップの作成にはemongodumpのオプションを使用します。バックアップデータには以下の項目が含まれています。

  • admin database
  • AlteryxGallery database
  • AlteryxGallery_Lucene database
  • AlteryxService database
  • ASCredentials.bin file
  • ASMongoDBVersion.bin file
  • mongocontroller.log file
  • mongoDump.log file

MongoDBのバックアップのほかに、以下の設定ファイルのバックアップについても推奨されています。Alteryx Serverはこれらのファイルがない場合も復元できますが、復元の迅速化と、データベース内の機密データを確実に複合化するために、バックアップを推奨しています。
以下の設定ファイルについては、ファイルの保存場所はデフォルトでのパスとなっています。実際に保存されているファイルの場所は、お使いの環境によって異なる場合があります。また、お使いの環境によっては、SystemAlias.xmlとSystemConnections.xmlが存在しないこともあります。

  • C:\ProgramData\Alteryx\RuntimeSettings.xml
  • C:\ProgramData\Alteryx\Engine\SystemAlias.xml
  • C:\ProgramData\Alteryx\Engine\SystemConnections.xml

MongoDBのバックアップ

ここではMongoDBのバックアップを手動で行ってみます。まずはAlteryx Serviceのサービスを停止します。Windowsのサービスの一覧を表示すると、Alteryx Serviceというサービスがあります。Alteryx Serviceを「サービスの停止」で停止します。

Alteryx Serviceが停止しましたら、以下のコマンドでMongoDBのバックアップを行います。

alteryxservice emongodump=

上記のalteryxserviceは、Alteryx Serverをインストールした場所に作成されるAlteryxService.exeで実行できます。今回使用している環境では、デフォルトのパスを指定してAlteryx Serverをインストールしていますので、C:\Program Files\Alteryx\bin配下にAlteryxService.exeがあることを確認できました。なお、構築した環境によってAlteryxService.exeが存在する場所が異なりますのでご注意ください。

コマンドプロンプトでパスを指定して実行してみます。

"C:\Program Files\Alteryx\bin\AlteryxService" emongodump=<バックアップファイルの出力先のフォルダ>

実行に成功すると以下のメッセージが出力されます。

"C:\Program Files\Alteryx\bin\AlteryxService_MongoController.exe" MongoRoot="C:\Program Files\Alteryx\bin\" DBName=AlteryxService DBRoot="C:\ProgramData\Alteryx\Service\Persistence\MongoDB" Port=27100 IPV6=False DumpPath="<バックアップファイルの出力先のフォルダ>" EMongoDump running..finished.

出力先として指定したフォルダを確認すると、バックアップファイルが作成されています。

設定ファイルのバックアップ

Alteryx Serverのデータフォルダに以下の設定ファイルが用意されています。概要でも記載していますが、お使いの環境によってファイルの保存場所は異なる場合がございます。

  • C:\ProgramData\Alteryx\RuntimeSettings.xml
  • C:\ProgramData\Alteryx\Engine\SystemAlias.xml
  • C:\ProgramData\Alteryx\Engine\SystemConnections.xml

今回使用している環境を確認してみると、RuntimeSettings.xmlのみ存在しています。このように、お使いの環境によってはSystemAlias.xmlとSystemConnections.xmlについては存在しない場合があります。

設定ファイルについては、コピーして外部のストレージなどに保存することでバックアップすることとなります。

最後に

Alteryx Serverアドベントカレンダー17日目、バックアップについてお届けしました。

今回の記事ではバックアップの作成についてお届けしましたが、バックアップは一度作成して完了というものではありません。定期的なバックアップの作成や、保存場所の検討、バックアップファイルの検証など、Alteryx Serverの運用の一環として検討が必要になるかと思います。バックアップのベストプラクティスについて、Alteryx Communityに記事が用意されていますので、こちらを参考にしていただければと思います。

参考