Try it free

Configure Cluster node capabilities

  • How-to guide
  • 2-min read

To configure OneAgent traffic or web UI traffic on a Cluster node, follow the steps for the Cluster Management Console or the Cluster REST API.

Certain deployments may require that specific nodes only serve UI traffic and not process OneAgent data. Or the opposite, where nodes only process OneAgent data and don't serve UI traffic. By configuring one or the other of these options, you can achieve higher stability, better cache behavior, and faster UI response times.

Web UI traffic

To improve DNS load-balancing performance, starting with Dynatrace Managed 1.214, web UI traffic is by default turned off when installing the thirteenth and subsequent nodes (or the seventh and subsequent nodes in a data center for Premium High Availability). You can enable or disable web UI traffic for a node via the Cluster REST API.

Configure traffic with the Cluster Management Console

Use the Cluster Management Console to configure OneAgent traffic and web UI traffic for a Cluster node.

Configure OneAgent traffic

To disable OneAgent traffic (that is, to set a Cluster node to idle mode), follow these steps.

  1. Go to Deployment status.
  2. Expand the Cluster node you want to disable and select Configure.
  3. Open the menu (three dots).
  4. Select Disable OneAgent traffic to stop monitoring data processing on the node.

To enable OneAgent traffic on a node, repeat steps 1 through 3, then select Enable OneAgent traffic to start monitoring data processing on the node.

After the change, the node menu shows the opposite option, for example Enable OneAgent traffic after you disable the traffic.

Configure web UI traffic

To disable web UI traffic (that is, to set a Cluster node to idle mode), follow these steps.

  1. Go to Deployment status.
  2. Expand the Cluster node you want to disable and select Configure.
  3. Open the menu (three dots).
  4. Select Disable Web UI traffic to stop the node from serving web UI traffic.

To enable web UI traffic on a node, repeat steps 1 through 3, then select Enable Web UI traffic to start serving web UI traffic on the node.

After the change, the node menu shows the opposite option, for example Enable Web UI traffic after you disable the traffic.

Configure traffic with the Cluster REST API

Use the Cluster REST API to configure OneAgent or web UI traffic for a Cluster node.

Configure node traffic settings

You can configure this option using an API call. See POST /cluster/configuration.

Authentication

To run this request, you need the Cluster token management permission assigned to your API token. If you don't have the API token, you can generate one.

  1. Go to Access Tokens.

  2. Select Generate token and enter a name for your token.

  3. Select the Service Provider API permissions and select Generate.

Use the generated API token to run the API calls.

Endpoint

You can POST to the /api/v1.0/onpremise/cluster/configuration endpoint with the following parameters:

ParameterTypeDescriptionInRequired

id

integer

ID of the node

body

Yes

webUI

boolean

Whether this node serves web UI requests (true or false)

body

Yes

agent

boolean

Whether this node receives OneAgent traffic (true or false)

body

Yes

datacenter

string

Not in use

body

No

An example of a JSON payload for the API call:

{
"clusterNodes": [
{
"id": 1,
"webUI": true,
"agent": true,
"datacenter": "dc-1"
},
{
"id": 2,
"webUI": true,
"agent": true,
"datacenter": "dc-1"
}
]
}

The API responds with "lockAcquired": true when it accepts the change. To follow the change, call GET /cluster/configuration/status. The change is complete when state is SUCCESS.