Skip to content
MS Teams Observability

Service Management

Use this page to run the collector as a background service on Linux.

Prerequisites

Section titled “Prerequisites”
  • Linux host with systemd
  • Root privileges (sudo)
  • Valid collector config file
Section titled “Recommended License Path”
Terminal window
sudo install -d -m 0750 /etc/ms-teams-observability-agent
sudo install -m 0640 -o root -g ms-teams-observability-agent \
  ./license.json /etc/ms-teams-observability-agent/license.json
license:
  filepath: /etc/ms-teams-observability-agent/license.json

Enable the Service

Section titled “Enable the Service”
Terminal window
sudo ms-teams-agent service enable-service --config /absolute/path/config.yaml
sudo ms-teams-agent service status

Enable a Named Service (Optional)

Section titled “Enable a Named Service (Optional)”
Terminal window
sudo ms-teams-agent service enable-service \
  --config /etc/ms-teams-observability-agent/prod.yaml \
  --instance prod


sudo ms-teams-agent service status --instance prod

Common Operations

Section titled “Common Operations”
Terminal window
sudo ms-teams-agent service status --instance default
sudo ms-teams-agent service restart --instance default
sudo systemctl status ms-teams-observability-agent@default.service
sudo journalctl -u ms-teams-observability-agent@default.service -f

Update Configuration Safely

Section titled “Update Configuration Safely”

  1. Back up your config file.

  2. Install updated config:

    Terminal window
    sudo ms-teams-agent service install-config \
      --config /etc/ms-teams-observability-agent/prod.yaml \
      --instance prod \
      --service-restart-if-active

  3. Verify status and logs.

Disable the Service

Section titled “Disable the Service”
Terminal window
sudo ms-teams-agent service disable-service --instance default