本記事では、ユーザーアクションログ(Action logs and system monitoring)の構成方法や利用手順について情報を整理しています。
動作検証環境
本記事は以下の環境に対して、Windows上て動作確認を行っています。
- Spotfire Server 14.0 LTS
本記事記載の内容はSpotfire 10.10 LTS以降にて利用できます。
※ 14.0 LTSより前のバージョンの場合、一部のログカテゴリやログアクションが対応されていない可能性があります。
仕組み
ユーザーアクションログを利用することで、以下の情報をログ収集できます。
- システムの負荷状況
- Spotfire Server、Web Player、Automation Services、TERR / Python / R サービスのCPU / メモリ使用状況など
- ユーザーが実施した操作
- クライアント別で分析を開く、Automation Servicesジョブの実行、データ関数の実行など
※「Configuration Tool (uiconfig.bat / config.bat)」利用時にはSpotfire Serverを経由せず直接リポジトリDBを参照しているため、処理内容がユーザーアクションログとして出力されません。
ユーザーアクションログを専用データベース、またはファイルにログ出力できますが、通常、専用データベースへのログ出力が推奨です。
ファイルに出力させる場合:
- ログファイルはSpotfire Server端末内で以下のパスに出力されます。
- C:\spotfire\spotfireserver\14.0.X\tomcat\logs\actionlogs\actionlog.log
- 14.0 LTSより前のバージョンの場合:C:\tibco\tss\X.Y.Z\tomcat\logs\actionlogs\actionlog.log
- ログファイルは日単位でローテーションされます。例、
- C:\spotfire\spotfireserver\14.0.X\tomcat\logs\actionlogs\actionlog-2024-08-17.log
- C:\spotfire\spotfireserver\14.0.X\tomcat\logs\actionlogs\actionlog-2024-08-18.log
- ログファイルの出力設定やローテーション設定は以下のファイル内で指定されています。(参考資料)
- C:\spotfire\spotfireserver\14.0.X\tomcat\spotfire-config\log4j2.xml
- 14.0 LTSより前のバージョンの場合:C:\tibco\tss\X.Y.Z\tomcat\spotfire-config\log4j2.xml
専用データベースに出力させる場合:
- 格納先データベースを事前に作成しておく必要があります。
- 格納先データベースにはMS SQL Server、Oracle、PostgresSQLが利用可能です。
- サポート対象バージョンについてSpotfire Server リポジトリDB サポート対象データベースをご参照下さい。
- ログデータの保持期間を設定できます。
- 設定の保持期間よりも古いログが自動的に削除されます。
構成方法
ユーザーアクションログはデフォルト設定では無効になっているため、利用前には有効化する必要があります。有効化の設定はSpotfire Serverに対して行います。
1.ログ格納先DBの作成
ログ格納先DBは以下のいずれかの方法で作成できます。
本記事では格納先DBにPostgreSQLを使用する場合を例に説明します。MS SQL ServerやOracleの場合は「補足」の部分を参照ください。
方法①、DB作成用スクリプトを使用
Spotfire Serverのインストーラ(SPOT_sfire_server_14.0.X_win.zip)内に含まれるDB作成用スクリプト(create_actionlog_db.bat)を実行してログ格納先DBを作成します。
1.Spotfire Serverのインストーラ内に含まれるDB作成用スクリプトの一式(「scripts\postgres_install\actionlog」フォルダ)をデータベースサーバー端末にコピーして、スクリプトファイル(create_actionlog_db.bat)をテキストエディタで開いて編集します。
2.下記の青い字の部分を編集して、データベースサーバーの情報や、作成対象の格納先DBの情報などを指定します。
※動作端末内にインストールされている「psql.exe」を使用してDB接続を行います。
※DBサーバーのホスト名、ポート番号、ユーザー名やパスワードなどは実際の環境に合わせて指定してください。
\SPOT_sfire_server_14.0.4_win\scripts\postgres_install\actionlog\create_actionlog_db.bat
例:
rem Uncomment to set variables:
set PGHOST=servername データベースサーバーのホスト名やIPアドレス
set PGPORT=5432 データベースの動作ポート番号
set DBSERVER_ADMIN_USERNAME=postgres データベース管理者のユーザー名
set DBSERVER_ADMIN_PASSWORD=password データベース管理者のパスワード
set PGDATABASE=postgres 接続先データベース名(PostgreSQL専用)
set ACTIONDB_DBNAME=spotfire_actionlog 作成対象ユーザーアクションログ格納先DBのデータベース名
set ACTIONDB_USERNAME=spotfire_actionlog_user 作成対象データベースのユーザー名
set ACTIONDB_PASSWORD=spotfire_actionlog_password 作成対象データベースユーザーのパスワード
rem Set this variable to the bin directory of the PostgreSQL installation
set PSQL_PATH="D:\pgsql\bin\" 「psql.exe」の格納先フォルダのフルパス(PostgreSQL専用)
3.コマンドプロンプトを起動して、上記のスクリプト(create_actionlog_db.bat)を実行してください。
コマンドの実行例:
4.スクリプト実行後に、コンソール出力(上記3.の画面コピー)にエラーがないこと、およびスクリプトと同じフォルダの下に出力された実行ログファイル(actionlog.txt)内にエラーがないことを確認してください。
実行ログファイル(actionlog.txt)の例:
方法②、「config.bat」コマンドを使用
12.0 LTS以降のバージョン場合、Spotfire Server端末内で「config.bat」コマンドを使用して格納先DBを作成することもできます。
1.Spotfire Server端末内で、OS管理者権限でコマンドプロンプトを起動し、Spotfire Serverのインストール先に遷移します。
C:\spotfire\spotfireserver\14.0.X\tomcat\spotfire-bin
14.0 LTSより前のバージョンの場合:
C:\tibco\tss\X.Y.Z\tomcat\spotfire-bin
2.データベースサーバーの情報や、作成対象の格納先DBの情報などを引数に指定し、コマンド「config.bat create-actionlogdb」を実行して格納先DBを作成します。
※Spotfire Server端末からJDBC経由でDB接続を行います。
※DBサーバーのホスト名、ポート番号、ユーザー名やパスワードなどは実際の環境に合わせて指定してください。
config.bat create-actionlogdb --driver-class="org.postgresql.Driver" ^
--database-url="jdbc:postgresql://servername:5432/" ^
--admin-username="postgres" --admin-password="password" ^
--actiondb-dbname="spotfire_actionlog" ^
--actiondb-username="spotfire_actionlog_user" --actiondb-password="spotfire_actionlog_password"
コマンドの実行例(正常終了):
2.ユーザーアクションログ機能の有効化
Spotfire Server端末内で、スタートメニューから「Spotfire Server 14.0.X LTS」⇒「Configure Spotfire Server 14.0.X LTS」を実行して、「Spotfire Server Configuration Tool」を起動して「Configuration」タブの「User Action Log」ページにて、ユーザーアクションログ機能を有効化します。
※格納先DBにOracleを使用する場合、「Spotfire Server Configuration Tool」を起動する前にOracle接続用JDBCドライバーをSpotfire Server端末内に格納しておいてください。(「補足」の部分を参照ください。)
設定後に「Save configuration」を押して「Database」へ保存してから、コントロールパネル⇒サービスからSpotfire Server サービスを再起動してください。
・Spotfire Server 14.0.X LTS
設定項目は下表のとおりです。(参考資料)
青い字の部分の設定は推奨です。
※ログの保持期間を無制限にする場合は格納先DBのサイズが増え続けますので、DBデータの格納先ディスクに空き容量が十分足りていることを確保しておいてください。
設定項目 | 設定値 | 説明 |
Action logger configuration | ||
Enable database logger |
Yes ※推奨 |
DB出力を有効化する ※推奨 |
Enable file logger | No |
ファイル出力は無効のままにする ※推奨 |
Enable web services |
Yes ※推奨 |
Yesの場合はSpotfire Serverのほかに、AnalystやWP/ASなどのサービスからのログも収集する Noの場合はSpotfire Serverのログのみを収集する |
Enable categories | All(すべて)、または必要なカテゴリのみを選択 |
ログ収集対象のカテゴリを指定する |
Database logger configuration ※「Enable database logger」がTrueの場合のみ設定可能 | ||
Driver template | PostgreSQL(本例) | ログ格納先DB接続用のドライバーテンプレートを選択する |
Hostname | PostgreSQLサーバーのホスト名またはIPアドレス |
ログ格納先DBサーバーのホスト名またはIPアドレスを指定する ※ログ格納先DB作成時に指定した情報に一致すること、以下同 ※Spotfire Server端末からアクセスできるアドレスを指定すること |
Port | 5432(本例) |
ログ格納先DBの動作ポート番号を指定する ※Spotfire Server端末からのアクセスが許可されていること |
Identifier(SID/database/service) | spotfire_actionlog(本例) |
ログ格納先DBのデータベース名(MS SQL Server / PostgreSQLの場合)、SIDやサービス名(Oracleの場合)のいずれかを指定する |
Username | ログ格納先DBのユーザー名 | ログ格納先DBのユーザー名を指定する |
Password | ログ格納先DBユーザーのパスワード | ログ格納先DBユーザーのパスワードを指定する |
URL |
※自動的に生成される |
ログ格納先DBへのJDBC接続文字列 |
Driver class | ※自動的に生成される | ログ格納先DB接続用のJDBCドライバーのクラス名 |
Log in local time |
True ※推奨 |
Spotfire Server端末の現地時間をログ出力するかどうかのフラグ Falseの場合はUTC時間でログ出力する |
Block on full queue | No |
キューがいっぱいの場合にログ処理をブロックするかどうかのフラグ ※Spotfire Serverがユーザーアクションログを一旦キュー(メモリ)に蓄積してからDBやファイルに出力する |
Queue size | 8000 | キューの最大サイズ(メモリ内で蓄積できるログの件数の最大値) |
Wait on full queue time (ms) | 1000(ミリ秒) | キューがいっぱいになった後に新しいログをキューに入れるまでの待ち時間 |
Wait on empty queue time (ms) | 1000(ミリ秒) |
キューが空の場合、ログをキューから格納先DBへ書き込む処理を試行するまでの待ち時間 |
Thread pool size | 4 | DB書き込みバッチが使用できるスレッドの数 |
Workers | 4 | DB書き込み処理を行うワーカーの最大数 |
Commit period | 60(秒) | キューがいっぱいでない場合、ログをキューから格納先DBへ書き込む処理の実施間隔 |
Batch size | 100 | DB書き込み処理のバッチサイズ(一回の処理DBへ挿入するログの件数の最大値) |
Grace period | 30(秒) | Spotfire Serverサービス停止時にキュー内のログをDBへ書き込む処理の実施時間の最大値 |
Pruning period (hrs) |
48(時間) ※デフォルト値 ※必要に応じて調整すること |
ログの保持期間 設定の保持期間よりも古いログが自動的に格納先DBから削除される ※「0」の場合は無制限 |
Monitoring period(s) | 300(秒) | 監視ログが出力される時間間隔 |
Monitoring retention span (hrs) | 1(時間) | 監視ログを平均値に書き換えるまでの保持期間 |
Monitoring average period (s) | 3600(秒) | 監視ログ内の平均値の時間間隔 |
Web service configuration ※「Enable web services」がTrueの場合のみ設定可能 | ||
Allowed host (regex) | * | ログ出力が許可されている端末(AnalystやWP/ASなどのサービスの動作端末) |
Allowed categories | All(すべて)、または必要なカテゴリのみを選択 | AnalystやWP/ASなどのサービスからのログのうち収集対象とするカテゴリを指定する |
3.分析テンプレートのインポート
Spotfire Serverのインストーラ(SPOT_sfire_server_14.0.X_win.zip)内にはDBに出力されたユーザーアクションログを解析するための分析テンプレートが含まれています。該当分析テンプレートをライブラリにインポートして利用することが可能です。
また、ログ格納先DBにMS SQL ServerやOracleを使用する場合の分析テンプレートが提供されていますが、PostgreSQLの場合は提供されていません。PostgreSQLに対応した分析テンプレートが必要な場合はこちらのお問い合わせフォームからお問い合わせください。
MS SQL Serverの場合の分析テンプレートの例:
1.ファイル「logged_user_actions_mssql.part0.zip」(MS SQL Serverの場合の例)をSpotfire Server端末にコピーして、以下のフォルダの下に格納してください。
C:\spotfire\spotfireserver\14.0.X\tomcat\application-data\library\
14.0 LTSより前のバージョンの場合:
C:\tibco\tss\X.Y.Z\tomcat\application-data\library\
2.Analystの「ツール」⇒「ライブラリーの管理」画面を開いて、「インポート」ボタンを押して上記のファイルをライブラリにインポートしてください。(詳細手順は省略)
インポートを実施するとフォルダ「Logged User Actions」が作成されますが、格納先DBからログデータを取り込むためのインフォメーションリンクや分析テンプレートなどが含まれています。また、該当フォルダへのアクセス権限設定は以下の通りで、管理者以外のユーザーは閲覧・編集できません。必要に応じてアクセス権限を利用ユーザーに付与してください。
- Administrator フルコントロール
3.Analystの「データ」⇒「インフォメーションデザイナー」画面を開いて、「データソース」タブからデータソース「logged_user_actions_datasource」を編集して、「接続URL」や「ユーザー名」、「パスワード」などを編集し、格納先DB作成時に指定した情報に合わせるように設定して保存してください。
データソースの保存を実施する際にはDB接続テストが行われ、保存ができればDB接続が成功したことになります。
また、ログ格納先DB作成時にデータベース名(MS SQL Server / PostgreSQLの場合)や、スキーマ名(ユーザー名、Oracleの場合)にデフォルトの名前「spotfire_actionlog」以外を指定した場合、データソース「logged_user_actions_datasource」の編集画面にてリダイレクトを実施してください。
MS SQL Server / PostgreSQLの場合:
- 送り元(データベースカタログ):spotfire_actionlog ※小文字
- 送り先(データベースカタログ):実際のデータベース名
「保存」を実施する前に「リダイレクトのテスト」を実施し、変更対象の要素を確認してください。
ここでは変更対象が0件でなければリダイレクトの設定が正しいことになります。
その後に「保存」ボタンを押すとリダイレクトが実施され、ライブラリ内の要素が更新されます。
Oracleの場合:
- 送り元(スキーマ):SPOTFIRE_ACTIONLOG ※大文字
- 送り先(スキーマ):実際のスキーマ名 ※大文字
- 対象のデータベースカタログ(スキーマ):空白
4.AnalystやConsumerにてライブラリから分析テンプレートを開いて、ユーザーアクションログを解析します。
/Logged User Actions/user_actions
分析テンプレート「user_actions」の画面表示の例:
利用手順
ユーザーアクションログは、以下の方法で利用できます。
1.(前節「構成方法」で設定した)製品同梱の分析テンプレートを利用してログを解析します。
2.Analystからインフォメーションリンクまたはデータ接続を経由して直接ユーザーアクションログの格納先DBからデータを読み込んで解析します。
格納先DBにはログ情報を格納するテーブルのほかに、ログカテゴリやログアクションごとのビューも作成されています。これらのビューを利用して各処理の履歴を確認することも可能です。
例(一部抜粋):
ログ内容一覧
ユーザーアクションログは以下のカラム構造として、1つのDBテーブルに出力されます。(参考資料)
PostgreSQLの場合の例:
カラム名 | データ型 | 説明 |
logged_time | timestamp | ログが格納先DBに書き込まれた日時 |
machine | varchar(100) |
ログが記録した処理が発生した端末の情報(ホストな、IPアドレス、FQDNなど) |
user_name | varchar(402) | ログが記録した処理を実施したSpotfireアカウントの名前 |
original_time | timestamp | ログが記録した処理の発生日時 |
original_ip | varchar(100) | ログが記録した処理を実施した端末 |
log_category | varchar(30) | ログカテゴリ |
log_action | varchar(30) | ログアクション(実際に実施された処理) |
success | boolean | 処理が成功・失敗したフラグ |
session_id | char(36) | ログが記録した処理を実施したセッションのID(GUID) |
id1 |
varchar(400) ※共通 |
ログカテゴリやログアクションによって異なる内容を出力 ※本記事では省略。詳細については製品マニュアル(参考資料)を参照ください。 |
id2 | ||
arg1 | ||
arg2 | ||
arg3 | ||
arg4 | ||
arg5 | ||
arg6 |
ユーザーアクションログは製品機能やクライアントごとにカテゴリ(参考資料)に分類されています。
- xxx_pro:Analystにて実施された処理のログ
- 例:analysis_pro、library_pro
- xxx_wp:Web Playerにて実施された処理のログ
- 例:analysis_wp、library_wp
- xxx_as:Automation Servicesにて実施された処理のログ
- 例:analysis_as、library_as
- xxx:Spotfire Serverにて実施された処理のログ
- 例:auth、library
- TERR:TERRサービスにて実施された処理のログ
- 例:session_open、session_close
- PYTHON:Pythonサービスにて実施された処理のログ
- 例:session_open、session_close
- R:Rサービスにて実施された処理のログ
- 例:session_open、session_close
ログカテゴリ(参考資料)とログアクション(参考資料)の一覧は下表の通りです。
カテゴリ | 説明 | アクション | 説明 |
admin | 管理作業 | change_passwd | ユーザーのパスワードを設定 |
create_group | グループを新規作成 | ||
create_user | ユーザーを新規作成 | ||
exclude_license | グループからライセンス小項目を外す | ||
group_add_member | グループにメンバーを追加 | ||
group_remove_member | グループからメンバーを外す | ||
remove_license | グループからライセンス大項目を外す | ||
remove_principal | ユーザーやグループを削除 | ||
rename_principal | ユーザーやグループを名前変更 | ||
set_license | グループにライセンス大項目を付与 | ||
set_preference | ユーザーやグループにプレファレンスを設定 | ||
analysis_as | Automation Servicesで分析を閲覧 | apply_bookmark | ブックマークを適用 |
analysis_pro | Analystで分析を閲覧・編集 | apply_bookmark | ブックマークを適用 |
arrange_visualizations | ビジュアライゼーションの配置(均等、並列、積み重ね)を変更 | ||
canvas_size | キャンパスエリアのサイズを設定 | ||
change_column_or_aggregation | ビジュアライゼーションの軸に指定されたカラムや集計方法を変更 | ||
change_max_values_legend | レジェンド項目ごとの値の最大数を変更 | ||
change_nr_shown | 「ファイルとデータ」フライアウトで、表示される項目の最大数を変更 | ||
create_annotation | 注釈を作成 | ||
create_comment | 「コラボレーション」でコメントを作成 | ||
create_details_visualization | ビジュアライゼーションの詳細を作成 | ||
create_page | ページを新規作成 | ||
create_visualization | ビジュアライゼーションを新規作成 | ||
create_vis_recommendations | 推奨事項からビジュアライゼーションを作成 | ||
delete_page | ページを削除 | ||
duplicate_page | ページを複製 | ||
duplicate_visualization | ビジュアライゼーションを複製 | ||
enter_full_screen_mode | F11キーを押して全画面表示を開始 | ||
incl_col_from_recommendations | 「分析内のデータ」フライアウトにてカラムに対して「推奨事項に含める」(既定、はい、いいえ)を変更 | ||
export | PDF/PPT/画像をエクスポート | ||
hide_page | ページを非表示 | ||
horiz_legend_values_alignment | 水平方向に表示したレジェンドの表示位置(左、中央、右)を設定 | ||
horiz_legend_values_position | 水平方向に表示したレジェンドの表示位置(上位、下位)を設定 | ||
initiate_analyze_for_marking | データをマークして「マークされたデータを分析」を実施(推奨事項機能) | ||
legend_values_orientation | レジェンド項目に対して「値を水平方向に表示する」を変更 | ||
maximize_canvas | キャンパスを最大化 | ||
modify_filter | フィルターを変更 | ||
opened_from_recommended | 「ファイルとデータ」フライアウト:「推奨」からデータや分析を開く | ||
page_navigation | ページナビゲーション:「最上部にページナビゲーションを表示する」を変更 | ||
page_navigation_mode | ページナビゲーション(タイトル付きタブ、ステップバイステップ、履歴の矢印、オフなど)を変更 | ||
rename_page | ページの名前(タイトル)を変更 | ||
reset_all_filters | すべてのフィルターをリセット | ||
reset_all_visible_filters | 表示フィルターをリセット | ||
reset_filter | 個別のフィルターをリセット | ||
run_external_action | 外部アクションを実行 | ||
set_custom_expression | ビジュアライゼーションの軸にカスタム演算式を設定 | ||
set_page | ページをアクティブにする | ||
set_preferred_aggregation |
「分析内のデータ」フライアウト:推奨された集計方法を設定 |
||
show_page | 「ページを非表示」を解除 | ||
status_bar | ページナビゲーション:「最上部にステータスバーを表示する」を変更 | ||
switch_visualization | ビジュアライゼーションの切り替えを実施 | ||
visualization_area_layout_mode |
ページレイアウトの切り替え(標準、モバイル) ※ページの横幅を狭くして閾値(デフォルト:600px)に達するとモバイルに切り替わる |
||
y_axis_number_of_scales | Y軸のスケールオプション(単一、デュアル、色ごと、トレリスパネルごと)を変更 | ||
analysis_wp | Web Playerで分析を閲覧・編集 | apply_bookmark | ブックマークを適用 |
arrange_visualizations | ビジュアライゼーションの配置(均等、並列、積み重ね)を変更 | ||
change_column_or_aggregation | ビジュアライゼーションの軸に指定されたカラムや集計方法を変更 | ||
change_max_values_legend | レジェンド項目ごとの値の最大数を変更 | ||
change_nr_shown | 「ファイルとデータ」フライアウトで、表示される項目の最大数を変更 | ||
create_annotation | 注釈を作成 | ||
create_comment | 「コラボレーション」でコメントを作成 | ||
create_details_visualization | ビジュアライゼーションの詳細を作成 | ||
create_page | ページを新規作成 | ||
create_visualization | ビジュアライゼーションを新規作成 | ||
create_vis_recommendations | 推奨事項からビジュアライゼーションを作成 | ||
delete_page | ページを削除 | ||
duplicate_page | ページを複製 | ||
duplicate_visualization | ビジュアライゼーションを複製 | ||
export | PDF/PPT/画像をエクスポート | ||
hide_page | ページを非表示 | ||
horiz_legend_values_alignment | 水平方向に表示したレジェンドの表示位置(左、中央、右)を設定 | ||
horiz_legend_values_position | 水平方向に表示したレジェンドの表示位置(上位、下位)を設定 | ||
legend_values_orientation | レジェンド項目に対して「値を水平方向に表示する」を変更 | ||
maximize_canvas | キャンパスを最大化 | ||
modify_filter | フィルターを変更 | ||
opened_from_recommended | 「ファイルとデータ」フライアウト:「推奨」からデータや分析を開く | ||
page_navigation | ページナビゲーション:「最上部にページナビゲーションを表示する」を変更 | ||
page_navigation_mode | ページナビゲーション(タイトル付きタブ、ステップバイステップ、履歴の矢印、オフなど)を変更 | ||
rename_page | ページの名前(タイトル)を変更 | ||
reset_all_filters | すべてのフィルターをリセット | ||
reset_all_visible_filters | 表示フィルターをリセット | ||
reset_filter | 個別のフィルターをリセット | ||
run_external_action | 外部アクションを実行 | ||
set_custom_expression | ビジュアライゼーションの軸にカスタム演算式を設定 | ||
set_page | ページをアクティブにする | ||
set_preferred_aggregation |
「分析内のデータ」フライアウト:推奨された集計方法を設定 |
||
show_page | 「ページを非表示」を解除 | ||
status_bar | ページナビゲーション:「最上部にステータスバーを表示する」を変更 | ||
switch_visualization | ビジュアライゼーションの切り替えを実施 | ||
visualization_area_layout_mode |
ページレイアウトの切り替え(標準、モバイル) ※ページの横幅を狭くして閾値(デフォルト:600px)に達するとモバイルに切り替わる |
||
y_axis_number_of_scales | Y軸のスケールオプション(単一、デュアル、色ごと、トレリスパネルごと)を変更 | ||
auth | Spotfire Server認証 | impersonate | impersonation認証 |
login | Spotfire Serverへログイン | ||
logout | Spotfire Serverからログアウト | ||
auth_as | Automation Services認証 | login |
Automation Servicesへログイン |
logout |
Automation Servicesからログアウト |
||
auth_pro | Analyst認証 | login | Analystへログイン |
logout |
Analystからログアウト ※Analystアプリケーションを閉じる際 |
||
auth_wp | Web Player認証 | login |
Web Playerへログイン ※ブラウザから「Analytics」画面を開く際 |
logout | Web Playerからログアウト | ||
automation_job_as | Automation Servicesジョブ実行 | job_finished | ジョブ実行終了 |
job_started | ジョブ実行開始 | ||
queued | ジョブが実行キューに入った時 | ||
rule_schedule |
ジョブの定期実行(スケジューリング)を開始 ※ASサービス起動後、スケジュール作成後など |
||
schedule_change | ジョブの実行スケジュールを変更 | ||
automation_task_as | Automation Servicesタスク実行 | task_finished | タスク実行終了 |
task_started | タスク実行開始 | ||
codetrust | コード信頼(Modsの信頼など) | create_cert |
Spotfireユーザーのコードサイニング証明書が発行れた ※ユーザーが初回Modを開発する際に発行される |
revoke_cert | Spotfireユーザーのコードサイニング証明書は有効期限が過ぎて取り消された | ||
add_extcert |
管理者がグループに対して外部コードサイニング証明書を信頼させた、またはユーザーが外部コードサイニング証明書を信頼した |
||
remove_extcert | 管理者がグループに信頼させた外部コードサイニング証明書を取り消した、またはユーザーが外部コードサイニング証明書への信頼を取り消した | ||
upload_extcert |
外部コードサイニング証明書がアップロードされた ※「add_extcert」の前に実施 |
||
add_hash | ユーザーが個別のModを信頼した | ||
remove_hash | 個別のModへの信頼を取り消した | ||
upload_hash |
Modの署名のハッシュがアップロードされた ※「add_hash」の前に実施 |
||
add_user | Modの開発者であるSpotfireユーザーを信頼した | ||
remove_user | Modの開発者であるSpotfireユーザーへの信頼を取り消した | ||
data_connector_as | Automation Servicesでのコネクターの利用 | get_data | データを取得 |
load_connection | データ接続を取得 | ||
load_source | データソースを取得 | ||
data_connector_pro | Analystでのコネクターの利用 | create_connection | データ接続を作成 |
create_source | データソースを作成 | ||
get_data | データを取得 | ||
load_connection | データ接続を取得 | ||
load_source | データソースを取得 | ||
synchronize_connection |
データ接続を同期 ※データ接続のプロパティ画面で「同期」ボタンを押下 |
||
update_connection | データ接続を更新 | ||
update_source | データソースを更新 | ||
data_connector_wp | Web Playerでのコネクターの利用 | create_connection | データ接続を作成 |
create_source | データソースを作成 | ||
get_data | データを取得 | ||
load_connection | データ接続を取得 | ||
load_source | データソースを取得 | ||
synchronize_connection |
データ接続を同期 |
||
update_connection | データ接続を更新 | ||
update_source | データソースを更新 | ||
datafunction_as | Automation Servicesでのデータ関数の利用 | execute | データ関数を実行 |
datafunction_pro | Analystでのデータ関数の利用 | add_instance | 分析内にデータ関数の実行を構成 |
execute | データ関数を実行 | ||
explicit_execute |
ユーザー操作(ボタン押下など)によってデータ関数を実行 ※上記の「execute」も一緒にログ出力される |
||
pin_definition | 「f(x) - 分析ツール」フライアウトにデータ関数を固定 | ||
remove_input | データ関数実行のパラメータ編集で入力パラメータをなしに設定 | ||
remove_instance | 分析からデータ関数を削除 | ||
remove_output | データ関数実行のパラメータ編集で出力パラメータをなしに設定 | ||
set_input | データ関数実行のパラメータ編集で入力パラメータを設定 | ||
set_output | データ関数実行のパラメータ編集で出力パラメータを設定 | ||
unpin_definition | 「f(x) - 分析ツール」フライアウトからデータ関数の固定を解除 | ||
datafunction_wp | Web Playerでのデータ関数の利用 | add_instance | 分析内にデータ関数の実行を構成 |
execute | データ関数を実行 | ||
explicit_execute |
ユーザー操作(ボタン押下など)によってデータ関数を実行 上※記の「execute」も一緒にログ出力される |
||
pin_definition | 「f(x) - 分析ツール」フライアウトにデータ関数を固定 | ||
remove_input | データ関数実行のパラメータ編集で入力パラメータをなしに設定 | ||
remove_instance | 分析からデータ関数を削除 | ||
remove_output | データ関数実行のパラメータ編集で出力パラメータをなしに設定 | ||
set_input | データ関数実行のパラメータ編集で入力パラメータを設定 | ||
set_output | データ関数実行のパラメータ編集で出力パラメータを設定 | ||
unpin_definition | 「f(x) - 分析ツール」フライアウトからデータ関数の固定を解除 | ||
datasource_as | Automation Servicesでのデータの取り込み | execute |
インフォメーションリンク、ファイル、ライブラリ内のSBDFからデータを取り込み ※分析に埋め込んでいるデータ、コネクタからのデータ取り込みはログ記録されない |
datasource_pro | Analystでのデータの取り込み | execute |
インフォメーションリンク、ファイル、ライブラリ内のSBDFからデータを取り込み ※分析に埋め込んでいるデータ、コネクタからのデータ取り込みはログ記録されない |
datasource_wp | Web Playerでのデータの取り込み | execute |
インフォメーションリンク、ファイル、ライブラリ内のSBDFからデータを取り込み ※分析に埋め込んでいるデータ、コネクタからのデータ取り込みはログ記録されない |
dblogging | ユーザーアクションログがDBに格納される場合の動作 | pruned | 保持期間よりも古いログが格納先DBから削除された |
startup |
ユーザーアクションログ機能が起動 ※Spotfire Serverサービス起動時 |
||
shutdown |
ユーザーアクションログ機能が停止 ※Spotfire Serverサービス停止時 |
||
ems | EMS動作 | create_connection | TIBCO Enterprise Message Service (EMS)からの接続を確立 |
file_pro | Analystでのローカル分析ファイルの操作 | close | ローカル分析ファイルを閉じる |
load | ローカル分析ファイルを開く | ||
file_wp | Web Playerでのローカル分析ファイルの操作 | load | ローカル分析ファイルを開く |
find_pro | Analystでの検索 | search | ツール⇒検索で検索を実施 |
find_wp | Web Playerでの検索 | search | ツール⇒検索で検索を実施 |
info_link | インフォメーションリンク関連の操作 | create_il | インフォメーションリンクを新規作成 |
get_data | インフォメーションリンクを実行してデータを取り込み | ||
load_il | インフォメーションリンクを取得 | ||
update_il | インフォメーションリンクを更新 | ||
library | clear_perm |
アクセス権限をクリア ※「親フォルダからのアクセス権限の継承」を有効化 |
|
copy | ライブラリ内のフォルダやファイルをほかのフォルダにコピー | ||
create |
ライブラリ内でフォルダやファイルを新規作成 |
||
delete | ライブラリ内のフォルダやファイルを削除 | ||
delete_ver | ライブラリファイルのバージョン履歴を削除 | ||
export | ライブラリのエクスポートを実施 | ||
import | ライブラリへのインポートを実施 | ||
load_content | ライブラリファイルのデータを取得 | ||
move | ライブラリ内でフォルダやファイルをほかのフィルダーに移動 | ||
remove_perm |
ライブラリフォルダへのアクセス権限を解除 ※現行バージョンではログ出力できない(改善予定) |
||
restore_ver |
ライブラリファイルを履歴のバージョンへ復元 |
||
save_content | ライブラリファイルを上書き保存 | ||
save_copy_ver | ライブラリファイルの履歴バージョンを新しいファイルとして保存 | ||
set_group_perm |
ライブラリフォルダへのアクセス権限をグループに付与 ※アクセス権限解除実施時には残りのグループへの権限付与を実施したログが出力される |
||
set_user_perm |
ライブラリフォルダへのアクセス権限をユーザーに付与 ※アクセス権限解除実施時には残りのユーザーへの権限付与を実施したログが出力される |
||
library_as | close | ライブラリファイル(分析)を閉じる | |
load_start |
ライブラリファイル(下記参照)を開く処理を開始 ※「load」の前にログ出力される |
||
load | ライブラリファイル(分析、SBDF、データ接続、データ接続用データソース)を開く | ||
library_pro | close | ライブラリファイル(分析)を閉じる | |
load | ライブラリファイル(分析、SBDF、データ関数、データ接続、データ接続用データソース)を開く | ||
library_wp | clone |
既存キャッシュからライブラリファイル(分析)を開く ※すでに開かれている分析、Scheduled Updatesによってロードされている分析がキャッシュされている |
|
close | ライブラリファイル(分析)を閉じる | ||
load_start |
ライブラリファイル(下記参照)を開く処理を開始 ※「load」の前にログ出力される |
||
load | ライブラリファイル(分析、SBDF、データ関数、データ接続、データ接続用データソース)を開く | ||
update_start |
Scheduled Updatesによるリロードを開始 ※「update」の前にログ出力される |
||
update | Scheduled Updatesによるリロードを実施 | ||
monitoring | measurement | Spotfire Serverの稼働状況(CPU使用率、ヒープメモリ使用量、HTTPセッション数など) | |
monitoring_as | counter | Automation Servicesインスタンスの稼働状況 | |
notification | 通知 | ||
start_instance | Automation Servicesインスタンスを起動 | ||
stop_instance | Automation Servicesインスタンスを停止 | ||
monitoring_wp | counter | Web Playerインスタンスの稼働状況 | |
notification | 通知 | ||
start_instance | Web Playerインスタンスを起動 | ||
stop_instance | Web Playerインスタンスを停止 | ||
routing_rules | create |
ルールを新規作成 ※「ルール」にはWeb Playerルーティングルール(ユーザー、グループ、分析)、Scheduled Updates、Automation Services実行スケジュールが含まれている、以下同 |
|
create_schedule |
スケジュールを新規作成 ※スケジュールには名前を付けて保存されたスケジュール、ルールに紐づく匿名のスケジュール、Automation Servicesジョブの実行スケジュールが含まれている |
||
delete | ルールを削除 | ||
disable | ルールを無効化 | ||
enable | ルールを有効化 | ||
update | 既存ルールを変更 | ||
scheduled_updates | adjust_ratio |
Scheduled Updatesによる分析ロードがどのWeb Playerサーバーにて処理されるかの振り分け情報を更新 通常、Scheduled Updatesによる分析ロード(リロード)の処理順番は以下の通りになっている: 1. adjust_ratio 2. load 3. su_request 4. queued 5. routing 6. job_execution |
|
analysis_update |
前回のスケジュールアップデートが失敗した後に分析が更新された場合 ※ログ出力を再現できていない |
||
cancel_update | Scheduled Updates実行をキャンセル | ||
evaluation |
WPサービスの状態変更によりスケジュールルールの評価を実施 ※ログ出力を再現できていない |
||
external_update | 外部(例えばWeb Services SOAP APIを経由)からのリクエストにより分析をロードする | ||
job_cancel_load |
ジョブ実行をキャンセルしようとする際に処理が失敗 |
||
job_execution | Scheduled Updatesジョブを実行(開始IN_PROGRESS、終了COMPLETED) | ||
job_load |
分析のロードが失敗やキャンセルされた ※ログ出力を再現できていない |
||
job_unload |
分析のアンロードが失敗した ※ログ出力を再現できていない |
||
load |
分析のロードを開始 |
||
no_retry |
前回の実行が失敗したためリトライを実施しない ※ログ出力を再現できていない |
||
no_update |
前回の実行が進行中のため今回は実行しない ※例えばロード所要時間がリロード間隔よりも長い場合 |
||
queued | Scheduled Updates実行がキューに入ってから処理されるまでの待ち時間 | ||
reload |
Web管理画面で分析のリロードを実施 |
||
reschedule |
Web Playerサーバーのタイムゾーン変更などによりリスケジューリングを実施 ※ログ出力を再現できていない |
||
retry | 前回実行失敗したScheduled Udpatesをリトライ | ||
retry_exhausted |
前にEXHAUSTED状態となっていたWeb Playerインスタンス上でリトライを実施 ※ログ出力を再現できていない |
||
routing | Scheduled Updatesによる分析ロードをWeb Playerに振り分ける | ||
rule_schedule |
Scheduled Updatesの定期実行(スケジューリング)を開始 ※Web Playerサービス起動後、ルール作成後など |
||
schedule_change |
Scheduled Updatesのスケジュール設定を変更 |
||
su_evaluation | Scheduled Udpatesルールの再評価を実施 | ||
su_execution | Scheduled Updatesの実行状況(異常時) | ||
su_request | Scheduled Updates実行を開始 | ||
task_execution |
タスクの実行状況(異常時) ※例えばリトライの実施が最大回数(10回)に達した場合 |
||
unload |
分析をアンロード ※スケジュールの終了時間が過ぎた場合 |
||
update |
Scheduled Updatesルールを更新 ※ログ出力を再現できていない |
||
TERR | TERRサービス | session_close |
TERRデータ関数の実行セッションを終了 ※セッションとはエンジンプロセスに相当する、以下同 |
session_open | TERRデータ関数の実行セッションを開始 | ||
PYTHON | Pythonサービス | session_close |
Pythonデータ関数の実行セッションを終了 ※セッションとはエンジンプロセスに相当する、以下同 |
session_open | Pythonデータ関数の実行セッションを開始 | ||
R | Rサービス | session_close |
Rデータ関数の実行セッションを終了 ※セッションとはエンジンプロセスに相当する、以下同 |
session_open | Rデータ関数の実行セッションを開始 |
補足
1.ログ格納先DBにMS SQL ServerやOracleを使用する場合にDB作成方法は以下の通りです。
ログ格納先DBにMS SQL Serverを使用する場合:
スクリプト(create_actionlog_db.bat)を実行して格納先DBを作成する場合は以下のように編集してください。
※動作端末内にインストールされている「sqlcmd.exe」を使用してDB接続を行います。
※DBサーバーのホスト名、ポート番号、ユーザー名やパスワードなどは実際の環境に合わせて指定してください。
\SPOT_sfire_server_14.0.4_win\scripts\mssql_install\actionlog\create_actionlog_db.bat
例:
rem Uncomment to set variables:
set DBSERVER_CONNECTIDENTIFIER=servername データベースサーバーのホスト名やIPアドレス
set DBSERVER_ADMIN_USERNAME=sa データベース管理者のユーザー名
set DBSERVER_ADMIN_PASSWORD=password データベース管理者のパスワード
set ACTIONDB_DBNAME=spotfire_actionlog 作成対象ユーザーアクションログ格納先DBのデータベース名
set ACTIONDB_USERNAME=spotfire_actionlog 作成対象データベースのユーザー名
set ACTIONDB_PASSWORD=spotfire_actionlog_password 作成対象データベースユーザーのパスワード
コマンド(JDBC経由)を実行して格納先DBを作成する場合のコマンド例は以下です。
※Spotfire Server端末からJDBC経由でDB接続を行います。
config.bat create-actionlogdb --driver-class="com.microsoft.sqlserver.jdbc.SQLServerDriver" ^
--database-url="jdbc:sqlserver://servername:1433;trustServerCertificate=true" ^
--admin-username="sa" --admin-password="password" ^
--actiondb-dbname="spotfire_actionlog" ^
--actiondb-username="spotfire_actionlog" --actiondb-password="spotfire_actionlog_password"
ログ格納先DBにOracleを使用する場合:
スクリプト(create_actionlog_db.bat)を実行して格納先DBを作成する場合は以下のように編集してください。
※動作端末内にインストールされている「sqlplus.exe」を使用してDB接続を行います。
※DBサーバーのホスト名、ポート番号、ユーザー名やパスワードなどは実際の環境に合わせて指定してください。
\SPOT_sfire_server_14.0.4_win\scripts\oracle_install\actionlog\create_actionlog_db.bat
例:
rem Uncomment to set variables:
set ACTIONDB_ROOTFOLDER=C:\app\test\product\19c\oradata\ORCLPDB1 データファイルの格納先フォルダ
set DBSERVER_CONNECTIDENTIFIER=//localhost/orclpdb1 データベースサーバーへの接続文字列
set DBSERVER_ADMIN_USERNAME=system データベース管理者のユーザー名
set DBSERVER_ADMIN_PASSWORD=password データベース管理者のパスワード
set ACTIONDB_USERNAME=spotfire_actionlog 作成対象データベースのユーザー名(スキーマ名)
set ACTIONDB_PASSWORD=spotfire_actionlog_password 作成対象データベースユーザーのパスワード
rem The Spotfire tablespaces. Alter to run multiple instances in
rem the same database:
set ACTIONDB_DATA_TABLESPACE=SPOTFIRE_DATA_ACTION_LOG データ表領域の名前
set ACTIONDB_TEMP_TABLESPACE=SPOTFIRE_TEMP_ACTION_LOG 一時表領域の名前
コマンド(JDBC経由)を実行して格納先DBを作成する場合のコマンド例は以下です。
※Spotfire Server端末からJDBC経由でDB接続を行います。
※事前にOracle接続用JDBCドライバー(ojdbc11.jar、ダウンロードリンク)をSpotfire Server端末にコピーして以下のフォルダに格納しておいてください。
C:\spotfire\spotfireserver\14.0.X\tomcat\custom-ext-informationservices
14.0 LTSより前のバージョンの場合:
C:\tibco\tss\X.Y.Z\tomcat\custom-ext
コマンドの例:
config.bat create-actionlogdb --driver-class="oracle.jdbc.OracleDriver" ^
--database-url="jdbc:oracle:thin:@//servername:1521/orclpdb1" ^
--admin-username="system" --admin-password="password" ^
--oracle-tablespace-prefix="spotfire_actionlog" ^
--oracle-rootfolder="C:\app\test\product\19c\oradata\ORCLPDB1" ^
--actiondb-username="spotfire_actionlog" --actiondb-password="spotfire_actionlog_password"
参考資料