Skip to content

R6. Settings Reference

Diátaxis: Reference (a dictionary to look things up in) · Audience: administrators -- apart from Guide & Downloads, the submenus under Settings are visible only to accounts with administrator permission ← Back to contents

This sets out what each screen under the left menu Settings covers. For the screens with a great many items (Monitoring Settings), only the tab and group structure is described, with a link to a separate reference for the detail of each key.

The Settings menu at a glance (left menu ▸ Settings) -- only Guide & Downloads is visible to every user; the rest are visible only to accounts with administrator permission.

Menu pathPurpose
Settings ▸ Agent StatusAgent connections and versions → H20
Settings ▸ Monitoring SettingsThe collection, threshold, alert channel, and other environment settings
Settings ▸ APM ServerThe state of the APM server and cluster
Settings ▸ Data ManagementData retention and cleanup
Settings ▸ Transaction IndexChecking the state of the query index
Settings ▸ LicensesRegistering licence keys and their position
Settings ▸ Guide & DownloadsDownloading agents and documents

Users, groups, and application groups (Access Management) are covered in H18 and H19.

Monitoring Settings (Settings ▸ Monitoring Settings)​

This configures server alerts and monitoring behaviour generally. There are a great many items, so they are split into tabs → groups.

Monitoring settings
TabGroups (examples)
GeneralMetric options · monitoring extensions (plugins) · data storage options · Excel report options · control options · dashboard options · general options
Sign-in IntegrationLDAP · OIDC
Cogent AIWhether AI diagnosis is used, and so on (the on/off for the H14 features)
Event ChannelsDefault settings · Mail · Slack · SMS · Synology Chat · MS Teams
  • The Event Channels tab is where the routes for sending alerts (email, Slack, and so on) are registered -- the "channel" in an alert policy points at a channel configured here (H15).
  • Excel report options decides things such as the display language of automatically generated reports (R5).

Note The detailed meaning, format, and default of each of the 170 or so individual settings keys are gathered in the internal reference docs-plan/data/settings/MONITORING_SETTINGS_REFERENCE.md. This manual covers only the tab and group structure.

APM Server (Settings ▸ APM Server)​

This shows the state of the APM server itself and the cluster configuration. (Not a monitored target -- the server of the APM product.)

Server status
  • When running as a cluster, the node composition and state are visible at a glance.

Data Management (Settings ▸ Data Management)​

This manages the retention and cleanup of the collected monitoring data.

  • Old data is cleaned up according to the retention period and cleanup policy.
  • Export data: downloads the data for the chosen items as a JSON file, for moving to another APM server or for backup.

Transaction Index Health (Settings ▸ Transaction Index)​

This checks whether the index that governs transaction query performance is healthy.

  • It shows the index state (last 7 days) and whether any index is missing.
  • A missing index can make transaction queries slow, and the system attempts to repair it automatically (the related event: R3 -- Transaction and Database Problems).

Licenses (Settings ▸ Licenses)​

This registers and manages the product licence keys and shows their position.

StateMeaning
ValidThe licence is in order
Expiring soonExpiry is close (renewal needed)
ExpiredThe validity period has passed
Unverified / invalidA key or target mismatch, and so on
Licenses

For the related events (expiry, imminent expiry, errors), see R3 -- Licences, Policies, Security, and Other.

Guide & Downloads (Settings ▸ Guide & Downloads)​

The screen for downloading the agent installation files and documents (the user manual and so on).

  • Get them here when installing an agent anew or bringing versions into line (when H20 reveals a version mismatch).