2. ログ一覧¶
本書では Exastro IT Automation の各サービスのログのフォーマットと出力例を以下に記載します。
2.1. ログ一覧¶
以下の一覧の「ログフォーマット」列には使用するログフォーマット名が記載されています。
各サービスのログのフォーマットの詳細はログフォーマット名をもとに次項を参照してください。
サービス
|
ログフォーマット
|
備考
|
|---|---|---|
ita-ag-oase
|
IT Automation標準ログフォーマット
|
|
ita-api-admin
|
IT Automation APIログフォーマット
|
|
ita-api-oase-receiver
|
IT Automation APIログフォーマット
|
|
ita-api-organization
|
IT Automation APIログフォーマット
|
|
ita-by-ansible-agent
|
IT Automation標準ログフォーマット
|
|
ita-by-ansible-execute
|
IT Automation標準ログフォーマット
|
|
ita-by-ansible-legacy-role-vars-listup
|
IT Automation標準ログフォーマット
|
|
ita-by-ansible-legacy-vars-listup
|
IT Automation標準ログフォーマット
|
|
ita-by-ansible-pioneer-vars-listup
|
IT Automation標準ログフォーマット
|
|
ita-by-ansible-towermaster-sync
|
IT Automation標準ログフォーマット
|
|
ita-by-cicd-for-iac
|
IT Automation標準ログフォーマット
|
|
ita-by-collector
|
IT Automation標準ログフォーマット
|
|
ita-by-conductor-regularly
|
IT Automation標準ログフォーマット
|
|
ita-by-conductor-synchronize
|
IT Automation標準ログフォーマット
|
|
ita-by-excel-export-import
|
IT Automation標準ログフォーマット
|
|
ita-by-execinstance-dataautoclean
|
IT Automation標準ログフォーマット
|
|
ita-by-file-autoclean
|
IT Automation標準ログフォーマット
|
|
ita-by-hostgroup-split
|
IT Automation標準ログフォーマット
|
|
ita-by-menu-create
|
IT Automation標準ログフォーマット
|
|
ita-by-menu-export-import
|
IT Automation標準ログフォーマット
|
|
ita-by-oase-conclusion
|
IT Automation標準ログフォーマット
|
|
ita-by-terraform-cli-execute
|
IT Automation標準ログフォーマット
|
|
ita-by-terraform-cli-vars-listup
|
IT Automation標準ログフォーマット
|
|
ita-by-terraform-cloud-ep-execute
|
IT Automation標準ログフォーマット
|
|
ita-by-terraform-cloud-ep-vars-listup
|
IT Automation標準ログフォーマット
|
|
ita-migration
|
IT Automation標準ログフォーマット
|
|
ita-web-server
|
Web標準ログフォーマット
|
|
platform-api
|
Platform APIログフォーマット
|
|
platform-auth
|
Platform Authログフォーマット
|
|
platform-job
|
Platform Jobログフォーマット
|
|
platform-migration
|
Platform標準ログフォーマット
|
|
platform-web
|
Web標準ログフォーマット
|
|
keycloak
|
keycloakログフォーマット
|
|
mariadb
|
ログの詳細は左記URLをご参照ください。
|
|
mongodb
|
ログの詳細は左記URLをご参照ください。
|
|
gitlab
|
ログの詳細は左記URLをご参照ください。
|
2.2. ログフォーマット¶
2.2.1. IT Automation標準ログフォーマット¶
[%(asctime)s][%(levelname)s] %(message)s
[2023-02-06 14:18:05,212][INFO] AppLog instance(stdAppLogger) is created
フォーマット文字列
|
フォーマットの意味
|
ログの例
|
備考
|
|---|---|---|---|
[%(asctime)s]
|
日時
|
[2023-02-06 14:18:05,212]
|
|
[%(levelname)s]
|
ログレベル
|
[INFO]
|
DEBUG, INFO, ERROR のいずれかが出力されます。
|
%(message)s
|
メッセージ
|
AppLog instance(stdAppLogger) is created
|
2.2.2. Platform標準ログフォーマット¶
%(asctime)s %(levelname)s (%(userid)s) %(pathname)s(%(lineno)d) %(message)s
2023/01/11 11:27:05.976995 INFO (None) /app/platform_init.py(88) platform initialize setting start
フォーマット文字列 |
フォーマットの意味 |
ログの例 |
備考 |
|---|---|---|---|
%(asctime)s |
ログ出力日時 |
2023/01/11 11:27:05.976995 |
|
%(levelname)s |
ログレベル |
INFO |
DEBUG, INFO, WARNING, ERROR のいずれかが出力されます。 |
(%(userid)s) |
アクセスユーザー（Noneは指定なし） |
（None） |
|
%(pathname)s |
ログ出力元のソース |
/app/platform_init.py |
|
(%(lineno)d) |
ログ出力元の行 |
(88) |
|
%(message)s |
メッセージ |
platform initialize setting start |
2.2.3. Web標準ログフォーマット¶
デフォルトのApacheログ形式になっています。
設定内容は以下の通りです。
LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined \
LogFormat "%h %l %u %t \"%r\" %>s %b" common \
<IfModule logio_module> \
# You need to enable mod_logio.c to use %I and %O \
LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio \
</IfModule>
commonフォーマットは以下の構成になっています。
ログの保存としてcommonを指定した場合は表の情報が一行で記録されていきます。
XXX.XXX.XXX.X - - [12/Jan/2023:15:38:10 +0900] "GET /favicon.ico/platform/ HTTP/1.1" 200 9817
"http://localhost:8000/org3/platform/roles" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/XXX.XXX.XXX.X Safari/537.36"
フォーマット文字列
|
フォーマットの意味
|
ログの例
|
備考
|
|---|---|---|---|
%h
|
アクセス元のホスト名
|
192.168.128.2
|
|
%l
|
クライアントの識別子
|
-
|
|
&u
|
認証ユーザ名
|
-
|
|
%t
|
リクエストを受け付けた時刻
|
[12/Jan/2023:15:38:10 +0900]
|
|
%r
|
リクエストの最初の行
|
"GET /favicon.ico/platform/ HTTP/1.1"
|
|
%>s
|
最後のレスポンスのステータス
|
200
|
|
%b
|
送信されたバイト数
|
9817
|
combinedフォーマットは、commonフォーマットに以下の項目が追加されています。
フォーマット文字列
|
フォーマットの意味
|
ログの例
|
備考
|
|---|---|---|---|
%{Referer}i
|
リファラー
|
リファラーとは参照元ページのことです。
|
|
%{User-Agent}i
|
User Agent
|
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/XXX.XXX.XXX.X Safari/537.36"
|
User Agent とは使用しているOS・ブラウザなどの情報のことです。
|
combinedioフォーマットは、combinedフォーマットに以下の項目が追加されています。
フォーマット文字列
|
フォーマットの意味
|
ログの例
|
備考
|
|---|---|---|---|
&I
|
受け取ったバイト数
|
-
|
|
%O
|
送信したバイト
|
-
|
2.2.4. IT Automation APIログフォーマット¶
IT Automation APIログフォーマットは、上述のWeb標準ログフォーマットのApacheログとIT Automation標準ログフォーマットが混合されたものが出力されますが、Web標準ログフォーマットとほとんど同じです。
[2023-01-05 18:05:22,875][INFO] - XXX.XXX.XXX.X - - [05/Jan/2023:18:05:22 +0900] "GET /favicon.ico/platform/ HTTP/1.1" 200 9817 "http://localhost:8000/org3/platform/roles" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/XXX.XXX.XXX.X Safari/537.36"
2.2.5. Platform APIログフォーマット¶
Platform APIログフォーマットは、上述のWeb標準ログフォーマットのApacheログとPlatform標準ログフォーマットが混合されたものが出力されますが、Web標準ログフォーマットとほとんど同じです。
2023/01/11 11:27:05.976995 INFO (None) /app/platform_init.py(88) XXX.XXX.XXX.X - - [11/Jan/2023:11:27:05 +0900] "GET /favicon.ico/platform/ HTTP/1.1" 200 9817 "http://localhost:8000/org3/platform/roles" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/XXX.XXX.XXX.X Safari/537.36"
2.2.6. Platform Authログフォーマット¶
Platform Authログフォーマットは、上述のWeb標準ログフォーマットのApacheログとPlatform標準ログフォーマットが混合されたものが出力されますが、Web標準ログフォーマットとほとんど同じです。
[-] - XXX.XXX.XXX.X - - [08/Feb/2023:10:22:20 +0900] "GET /auth/resources/b3h1e/common/keycloak/node_modules/patternfly/dist/fonts/OpenSans-Light-webfont.woff2 HTTP/1.1" 200 63180 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/XXX.XXX.XXX.X Safari/537.36"
2.2.7. Platform Jobログフォーマット¶
[%(asctime)s] [%(process)06d:%(threadName)s] [%(levelname)-5s] %(message)s
[2023-01-05 18:05:22,875] [000000:MainThread] [INFO] Get keycloak service account token. realm_name=master
フォーマット文字列
|
フォーマットの意味
|
ログの例
|
備考
|
|---|---|---|---|
[%(asctime)s]
|
日付
|
[2023-01-05 18:05:22,875]
|
|
[%(process)06d:%(threadName)s]
|
プロセスID:スレッド名
|
[000000:MainThread]
|
|
[%(levelname)s]
|
ログレベル
|
[INFO]
|
DEBUG, INFO, WARNING, ERROR のいずれかが出力されます。
|
%(message)s
|
メッセージ
|
Get keycloak service account token. realm_name=master
|
2.2.8. Keycloakログフォーマット¶
%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n
2023-01-12 09:21:49,040 INFO [org.keycloak.events] (default task-13) type=INTROSPECT_TOKEN, realmId=org3, clientId=system-org3-auth, userId=null, ipAddress=XXX.XXX.XXX.X, client_auth_method=client-secret
フォーマット文字列
|
フォーマットの意味
|
ログの例
|
備考
|
|---|---|---|---|
%d{yyyy-MM-dd HH:mm:ss,SSS}
|
ログ出力日時
|
2023-01-12 09:21:49,040
|
|
%-5p
|
ログレベル
|
INFO
|
DEBUG, INFO, WARN, ERROR, FATAL のいずれかが出力されます。
|
[%c]
|
ログ カテゴリ名
|
[org.keycloak.events]
|
|
(%t)
|
スレッド名
|
(default task-13)
|
|
%s
|
簡単なメッセージ
|
-
|
|
%e
|
例外
|
-
|
|
%n
|
改行
|
-
|
Keycloakのログの詳細は下記URLをご参照ください。