OMS Linux Agent Log Collector

February 12, 2024 · View on GitHub

Supported Linux OS

Log Collector Pre-requisites:

Make sure the target Linux server has the following software installed:

  • Python 2.6 and above
  • OMS Linux Agent (From GitHub / Azure VM Extension / Linux Containers)

You can use OMS Log collector to collect logs for both failed and successful installations of the OMS Linux Agent.

Log Collector Download:

The Log Collector is automatically installed with the OMS Agent via the OMS Troubleshooting Tool. It can be found by running the Troubleshooting Tool:

sudo /opt/microsoft/omsagent/bin/troubleshooter

And choosing Option L after startup.

However, if for some reason the Troubleshooting Tool is not installed or working, the Log Collector can be downloaded manually:

  • Download the tool and copy to any directory of your choice: 
    wget https://github.com/Microsoft/OMS-Agent-for-Linux/raw/master/tools/LogCollector/download/v7/omslinux_agentlog.tgz
    Recommendation is to copy the tool to the user’s home directory (/home/user)
  • Untar the archive file to extract OMS Log Collector source files: 
    tar -xvf omslinux_agentlog.tgz

You are now ready to run the tool to collect logs.

Log Collector Execution Syntax:

Both -o and -s are required. Ensure that the output directory has appropriate ownership and permissions set.

cd <directory in which you extracted omslinux_agentlog.tgz>
sudo sh omslinux_agentlog.sh [-h] -o <Path to Output Directory> -s <SR Number> [-c <Company Name>]

Examples:

sudo sh omslinux_agentlog.sh -o /home/user/omslogs -s SR1234567890 -c Contoso
# or
sudo sh omslinux_agentlog.sh -o /home/user/omslogs -s SR1234567890

Note: The tool can optionally be run directly using the python script (you may need to use python2 or python3 if your python command is unaliased):

sudo python omslinux_agentlog.py [-h] -o <Path to Output Directory> -s <SR Number> [-c <Company Name>]

Examples:

sudo python omslinux_agentlog.py -o /home/user/omslogs -s SR1234567890 -c Contoso
# or
sudo python omslinux_agentlog.py -o /home/user/omslogs -s SR1234567890

Log Collector Source File Manifest:

  • omslinux_agentlog.sh: A shell script to ensure log collector pre-requisites are installed then call omslinux_agentlog.py to collect logs and command line output
  • omslinux_agentlog.py: A python script to collect logs and command line output for further troubleshooting

Log Collector Output Files and Directories:

  • All logs are saved under the path provided via the -o flag. If the path does not exist, the script will fail.
  • The output is archived with the following file format: omslinuxagentlog-<SR Number>-<UTCDateTime>.tgz Example: omslinuxagentlog-SR1234567890-2017-06-14T11:57:01.599947.tgz
  • Copy the above file and send it to Microsoft Support for further troubleshooting

Files / Directories Collected:

$output_dir is the directory supplied via the -o flag.

  • OMS Linux Agent Type:
    • Installed using omsagent*.universal*.sh bundle directly
      • $output_dir
        • messages
        • omsagent.log
        • omsconfig.log
        • omslinux.out
        • scx*.log
        • omi*.log
        • WSData/
    • Addtional logs if OMS is installed through Azure VM extension
      • $output_dir
        • extension/
        • vmagent/
        • messages
        • omsagent.log
        • omsconfig.log
        • omslinux.out
      • $output_dir/extension/
        • config/
        • status/
        • lib/
        • log/
      • $output_dir/vmagent/
        • waagent.log
    • Linux Containers
      • $output_dir
        • container/
        • omslinux.out
      • $output_dir/container/
        • omsagent.log
        • omsconfig.log
        • syslog

References:

Appendix:

How to publish new version of Log collector

  • After your code review is merged, create a tgz file by navigating to /home/your_working_directory/OMS-Agent-for-Linux/tools/LogCollector/source and run: 
    tar -cvzf omslinux_agentlog.tgz ./*
  • Create a new folder with the version number under download folder. Example https://github.com/Microsoft/OMS-Agent-for-Linux/tree/master/tools/LogCollector/download/v2
  • Update documentation with the new changes: https://github.com/Microsoft/OMS-Agent-for-Linux/blob/master/tools/LogCollector/OMS_Linux_Agent_Log_Collector.md
  • Publish new version of omslinux_agent.tgz to download folder.

Sample output for GitHub OMS Linux Agent:

ExampleLogCollectorScriptOutputGitHub

Sample output for OmsAgentForLinux Azure VM Extension:

ExampleLogCollectorScriptOutputExtension

Sample output for OMS Linux Container:

ExampleLogCollectorScriptOutputContainer