Skip to content

Linux Service (systemd)

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

  • Linux host with systemd
  • Root privileges (sudo)
  • Valid collector config file
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

A reference such as ${env:GRAPH_CLIENT_SECRET} in the configuration is resolved from the environment of the collector process. For a systemd service, provide the secrets with a drop-in that reads a root-owned file, instead of writing them in the installed YAML:

Terminal window
sudo install -d -m 0755 /etc/systemd/system/ms-teams-observability-agent@default.service.d
sudo tee /etc/systemd/system/ms-teams-observability-agent@default.service.d/secrets.conf >/dev/null <<'EOF'
[Service]
EnvironmentFile=/etc/ms-teams-observability-agent/secrets.env
EOF
# root:ms-teams-observability-agent 0640 — one KEY=value per line
sudo install -m 0640 -o root -g ms-teams-observability-agent \
./secrets.env /etc/ms-teams-observability-agent/secrets.env
sudo systemctl daemon-reload
sudo systemctl restart ms-teams-observability-agent@default.service
/etc/ms-teams-observability-agent/secrets.env
GRAPH_CLIENT_SECRET=...
SPLUNK_HEC_TOKEN=...
Terminal window
sudo ms-teams-agent service enable-service --config /absolute/path/config.yaml
sudo ms-teams-agent service status
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
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
  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.

Terminal window
sudo ms-teams-agent service disable-service --instance default