Splunk CloudのAppエクスポート機能のご紹介

Splunkは、コミュニティの多くのメンバーから期待を寄せられていたSplunk Cloud Platformの新機能として、クラウド管理者がAppをエクスポートできる機能の追加を発表しました。この機能は、Splunk Ideaに届いたリクエストのトップ10にランクインしており、この活気あるユーザーコミュニティに7,000件以上のアイデアが寄せられていることを考えると、その期待の高さがうかがえます。Appエクスポート機能を利用すれば、Appコンポーネントの再利用、設定の問題のトラブルシューティング、Splunk Cloud Platform内の既存のAppの理解とサポートがより容易になります。

クラウド管理者は、この新しいエクスポート機能を利用して、Appファイルと、関連するユーザーがクラウドで行った変更、具体的にはapp/default、app/local、user/app/localのファイルをエクスポートできます。この機能は、Victoria Experienceで展開されたSplunk Cloud Platformバージョン9.2.2403以降で利用できます。この機能にアクセスするには、ACS CLIを介して、またはAPIコールから直接Admin Config Service (ACS)を呼び出すだけです。

この機能が重要である理由

クラウド管理者は、Appの管理についていくつかの課題に直面しています。これまで、Appデータをエクスポートしたいときは専用のサポートチケットを発行する必要があり、返答までに数日かかることもありました。プロセスが煩雑で時間がかかるうえ、追加の手続きが必要になってさらに作業が遅れる場合もありました。

新しいAppエクスポート機能を使えば、クラウド管理者やApp開発者がAppのデータに直接アクセスして、Splunk Cloud Platform内のすべてのAppを簡単に管理、トラブルシューティング、拡張できるため、こうした課題を解決できます。このセルフサービスのツールは、Victoria Experienceで日常業務を行うクラウド管理者をサポートするように設計されており、Appの管理性と可視性を向上させます。

仕組み

この機能は、スタックの任意のクラウド管理者がACS APIまたはCLIを介してAdmin Config Service (ACS)にアクセスすることで利用できます。この機能では、単一のAppをエクスポートできますが、今後、ACS CLIを使って複数のAppをまとめてエクスポートできるようになる予定です。

ACSでは、Appデータのエクスポート元となるサーチヘッドグループとディレクトリ(app/default、app/local、またはuser/<<app>>/local)を指定できます。Appは.tarファイル形式で返されます。

サーチAppやプレミアムAppなど、Splunkの一部のデフォルトAppでは、app/defaultのデータをエクスポートできないことに注意してください。ただし、これらのAppのUIでユーザーが行った変更はほぼすべて、app/localとuser/<<app>>/localのファイルからエクスポート可能です。このような柔軟性があるため、クラウド管理者は環境を効果的に管理できます。

主要なメリット

Appデータを把握できる：管理者は、Appと関連するAppデータのローカルコピーやエクスポートしたスナップショットを保持できます。これにより、クラウドで管理しているAppとユーザー設定を包括的に把握できます。

トラブルシューティングが容易になる：Appとユーザー設定を明確に可視化することで、問題や設定変更をより効果的にトラブルシューティングできます。Appに行われた変更について貴重なインサイトを獲得したり、UIでの変更を簡単に特定して元に戻したりできます。 

変更管理を効率化できる：UIで行われた変更を保存して、デフォルト設定に手動で統合できます。これにより、Appの開発とデプロイのプロセスが円滑になり、ユーザーによるカスタマイズを他のAppのデフォルトファイルに簡単に組み込むことができます。

注意点

エクスポート機能の割り当て：クラウド管理者がAppエクスポート機能をリクエストして受理されたあと、その機能を組織内の他のロールに割り当てることができます。Appエクスポート機能をリクエストする必要があるのは、各スタックにつき1人の承認済みクラウド管理者のみです。Appエクスポート機能はそのスタックのすべてのsc_adminユーザーに割り当てられることに注意してください。

UI統合：今後のSplunkアップデートで、App ManagerのAppリストのUIページに、個々のAppのエクスポート機能が統合される予定です。その前に、ACS Helper AppにAppエクスポート機能が組み込まれる予定です。

ローカルファイルのサポート：Appをインストールまたはアップグレードする場合、デフォルトファイルはサポートされますが、ローカルファイルはサポートされません。ローカル設定でエクスポートされたAppは、ローカルファイルが含まれている場合、そのままではSplunk Cloud Platformにアップロードできません。

一部の情報の削除：Appエクスポート機能では、passwords.confの内容など、App内の一部の情報がネイティブで削除されます。

サーチヘッドの指定：ACSではサーチヘッドの指定(Search Head Targeting)がネイティブでサポートされます。特定のサーチヘッドグループを指定して、そのローカルファイルだけをエクスポートできます。同じAppが複数のサーチヘッドグループ上にある場合、すべてのローカルデータをエクスポートするには、ACSを2回呼び出す必要があります。詳しくは、こちらをご覧ください。

サポートされるApp：Appエクスポート機能は、Splunkbase Appとお客様が開発した(プライベート)Appに対して使用できます。サーチAppなど、Splunkの一部のデフォルトAppでは、app/localとuser/app/localのデータはエクスポートできますが、Appのデフォルトファイルはエクスポートできません。また、現時点では、ESやITSIなどのプレミアムAppからのデータのエクスポートはサポートされていません。

次のステップ

Appエクスポート機能は現在、バージョン9.2.2403のVictoriaスタックでのみ、リクエストに応じてご利用いただけます。この機能を利用すれば、クラウド管理者にとって利便性が向上し、Appの管理とデプロイがより容易になります。 

詳細については、こちらのドキュメントをご覧ください。

ぜひこの新機能を活用して運用を効率化し、Splunk Cloud Platformでの成果の向上にお役立てください。

更新情報：サポートへの連絡が不要になりました

このブログ記事の公開後、Appエクスポート機能を初めて使用するときにサポートに連絡するという要件が除外されました。今後は、有効化の手順なしでACSを直接使用して、よりすばやく簡単にこの機能をご利用いただけます。この変更は、2024年9月から、バージョン9.2.2403以降を実行しているVictoria環境のAppエクスポートが有効なすべてのスタックに適用されます。クラウド管理者であれば、この効率化された機能をすぐにお使いいただけます。

このブログはこちらの英語ブログの翻訳、山村 悟史によるレビューです。