OSコマンド・コレクションの設定

OSコマンド出力の収集を設定するための前提条件

ログ収集を設定する前に、次の前提条件タスクを完了します。

• Oracle Log Analyticsでログとして収集できるOSコマンドで構成されるカスタム・スクリプトを作成します。スクリプトのSTDOUTの出力は、エージェントによってペイロードとしてクラウドに送信されます。STDOUTペイロードは、単一のログ・エントリまたは複数のログ・エントリです。Oracle Log Analyticsソースで使用されているパーサーが解析できることを確認します。また、スクリプトでエラー条件を処理し、前提条件を確認できる必要があります。

  カスタム・スクリプトは、エージェント・インストール・フォルダのagent_inst/state/laStorage/os_cmd/scriptsフォルダに格納します。したがって、スクリプトを格納するための絶対パスは次のとおりです。

  • Oracle Management Agentの場合: /opt/oracle/mgmt_agent/agent_inst/state/laStorage/os_cmd/scripts
  • Oracle Cloud Agent- Management Agentプラグインの場合: /var/lib/oracle-cloud-agent/plugins/oci-managementagent/polaris/agent_inst/state/laStorage/os_cmd/scripts

• スクリプト内の特定のコマンドを実行するには、特殊なファイルアクセス権が必要になる場合があります。このような権限をエージェント・ホストに手動で構成します。スクリプトおよびスクリプトが実行するその他のコマンド/スクリプトには、管理エージェント・ユーザーに対する実行権限が必要です。

OSコマンド・ログを収集するための全体的なフロー

OSコマンド・スクリプトの出力を収集するための大まかなタスクを次に示します。

• OSコマンド・スクリプトを実行するホストに管理エージェントをインストールし、Oracle Log Analyticsで収集する必要がある出力を生成します。管理エージェントを使用した連続ログ収集の設定を参照してください。

• Oracle Log Analyticsでエージェント・ホストを識別するエンティティを作成します。エンティティは、スクリプトが実行される管理エージェントと同じホスト上にある必要があります。リモートOSコマンドの実行はサポートされていません。通常、エンティティは管理エージェントのインストール時に自動的に作成されます。「ログ出力リソースを表すエンティティの作成」を参照してください。

• スクリプトの出力を解析できるパーサーを作成します。このパーサーは、次のステップで識別されるソースで使用する必要があります。パーサーの作成を参照してください。
• 既存のソースを識別するか、OSコマンド・タイプのログ・ソースを作成します。OSコマンド・ソースの作成を参照してください。
• OSコマンド収集の収集間隔を設定するようにエージェント収集プロパティcustomized_scheduleを構成するかどうかを確認します。デフォルト値は30 secondsです。エージェント・コレクション・プロパティを使用して、エージェント・レベル、ソース・レベル、エンティティ・レベルまたは関連レベルでスケジュールを更新できます。「変更できるエージェント・プロパティ」および「エージェント・プロパティの変更」を参照してください。

• 以前に作成したソースにエンティティを関連付けます。新しいソースとエンティティのアソシエーションの構成を参照してください。

  関連付けが完了すると、エージェントはOSコマンドの実行を定期的に開始し、コマンドのSTDOUTがログ・データとして収集され、そのログ・データはOracle Log Analyticsへのフローを開始します。

• 前に作成したOSコマンド・ソースを選択して、ログ・エクスプローラでログ・データを表示します。ソース属性によるログのフィルタを参照してください。

設定の完了後にログ・データがログ・エクスプローラに表示されない場合は、エージェント収集の警告に問題がないかチェックできます。次の警告は、特にOSコマンドの出力収集に関連しています。

• 外部アプリケーション実行の失敗: スクリプトの実行中にエラーが発生しました。または、OSコマンドはサポートされていません。

• 外部アプリケーションが見つかりません: スクリプトが見つかりません。スクリプトに対する読取り/実行権限がありません。

「エージェント収集警告の表示」を参照してください。

OSコマンド・コレクションの設定時に考慮する重要な要素

• スクリプトでコマンドの完全なパスを使用します。たとえば、sudoのかわりに/bin/sudoを使用します。

• スクリプトは、管理エージェントが実行しているのと同じユーザーとして実行されます。これは、スクリプト内のファイルの読取りまたは書込み中に重要です。

• 標準出力(STDOUT)および標準エラー(STDERR)でスクリプトによって生成された出力は、ログ・エントリを抽出するためのテキストとして収集されます。

• 次の単語または接頭辞は、OSコマンドまたはスクリプト名ではサポートされていません: sh、bash、csh、zsh、ksh、dash、cmd

• OSコマンドまたはスクリプト名では、次の文字はサポートされていません: |、&、;、>、<

• 次の親ディレクトリ・トラバーサル順序は、OSコマンドまたはスクリプト名(/../または\..\)ではサポートされていません。また、OSコマンドは/..または\..で終了できません。

• 次の環境変数がエージェントからスクリプトに渡されます。この変数は、スクリプトで使用できます。

  • LA_SOURCE_COMMAND_ID: これは、ログ・ソース内のコマンドの内部生成されたパターンIDです。同じスクリプトが複数のコマンドで指定されている場合は、スクリプト・インスタンスを区別するために使用できます。