Configuration

After installing the agent, two configuration steps are required:

Configure the xrelia API key
Configure the agent settings file

Configuring the API key

The agent authenticates using the same API client used by custom integrations.

Before starting the agent, export your API key as the XRELIA_API_KEY environment variable:

export XRELIA_API_KEY="<YOUR_API_KEY>"

The agent automatically reads this value and uses it to authenticate all requests sent to xrelia.

For production deployments, we recommend configuring the environment variable through your systemd service configuration or environment management solution.

Configuring the agent

The agent configuration file determines:

Which platform and instance receive incoming data
Which metrics are collected
Whether synthetic request reporting is enabled
How collected data maps to xrelia resources

The configuration requires both a platformId and an instanceId, which can be obtained from the xrelia Console.

Individual metric collectors can be enabled or disabled independently.

When a metric collector is enabled, the corresponding metric ID from the xrelia console must also be provided. See the System setup section in the Console guide.

Example configuration:

{
  "platformId": "PLATFORM_ID",
  "instanceId": "INSTANCE_ID",
  "userJourney": {
    "enabled": false
  },
  "metrics": {
    "cpu": {
      "enabled": true,
      "metricId": "CPU_METRIC_ID"
    },
    "ram": {
      "enabled": false,
      "metricId": "RAM_METRIC_ID"
    },
    "load": {
      "enabled": false,
      "metricId": "LOAD_METRIC_ID"
    },
    "net": {
      "enabled": false,
      "iface": "en0",
      "metricId": "NETWORK_METRIC_ID"
    }
  }
}

Supported metrics

The agent currently supports the following built-in system metrics:

CPU utilization
Memory utilization
System load
Network throughput

Each metric can be enabled or disabled independently through the configuration file.

This allows you to collect only the metrics relevant to your environment while maintaining complete control over what data is sent to xrelia.

User Journey monitoring

The agent can also report synthetic request and user journey results.

Unlike system metrics, user journey monitoring requires additional scripting and integration with your applications or automation workflows.

This functionality is covered in the next section of the documentation.

Next steps

After installing and configuring the agent:

Enable synthetic request monitoring
Verify incoming data in the xrelia console

The agent will begin sending data to xrelia as soon as it is started and successfully authenticated.