Agent Configuration

Agent Configuration via UI

The agent configuration in the UI can be performed by modifying the JSON in the UI or by editing individual form fields.

Agent Configuration via JSON

Augtera support team will provide you with the REST API endpoint to use for posting JSON configuration. Alternatively you can also use the UI for modifying the JSON.

Configuration Properties

The following table explains the attributes of the JSON configuration and provides a description for each one of them. Global configuration is applied on all agents while per-agent configuration is used to either augment the global configuration or over-ride the global configuration.

Num	Attribute	Type/Level	Description
	Global Configuration
	global Required		Begins global configuration stanza. This is used for configuring properties that are automatically applied to all new agents when they are installed.
	collectorAddress Required	String	The IP address of the Augtera collector
	Capabiities Configuration
	capabilities Required	Object	Begin capabilities configuration stanza. This is used to enable to disable various agent capabilities
	netsonar Required	String	Enables netsonar synthetic tests between agents when set to "on".
	urlMonitoring	String	Enables synthetic tests to URLs when set to "on".
	metadata Configuration
	metadata	Object	Begins metadata configuration stanza. Configures metadata that is associated by probes generated by the agent
	netsonar Configuration
	netsonar	Object	Begins netsonar configuration stanza. This is used to configure the properties of agent-to-agent probes.
	receivers Configuration
	receivers	Object	Begins receivers configuration stanza. This is used to configure each individual receiver to which probes are generated as well as the metadata associated with the receiver.

Netsonar Agent to Agent Sample JSON

Following is a sample JSON configuration for enabling a full mesh between two agents on device1 and device2. This example does not show a partial mesh which is supported and requires per-agent receivers

{
  "global": {
    "collectorAddress": "<setup name>.console.augtera.com",
    "capabilities": {
      "netsonar": "on"
    },
    "metadata": {
      "GroupName": "us"
    },
    "netsonar": {
      "count": 3,
      "period": 15,
      "tosList": "EF, BE",
      "receivers": {
        "10.1.1.1": {
          "metadata": {
            "EgressDeviceName": "device1",
            "ReceiverGroupPod": "pod1"
          }
        },
        "20.2.2.2": {
          "metadata": {
            "EgressDeviceName": "device2",
            "ReceiverGroupPod": "pod2"
          }
        }
      }
    }
  },
  "peragent": {
    "global": {
      "device1": {
        "metadata": {
          "GroupAz": "east-1",
          "GroupPod": "pod1"
        }
      },
      "device2": {
        "metadata": {
          "GroupAz": "west-1",
          "GroupPod": "pod2"
        }
      }
    }
  }
}

URL Monitoring Sample JSON

Following is a sample JSON configuration for enabling synthetic tests to two different URLs from all agents.

{
  "global": {
    "collectorAddress": "<setup name>.console.augtera.com",
    "capabilities": {
      "urlMonitoring": "on"
    },
    "metadata": {
      "GroupName": "us"
    },
    "urlMonitoring": {
      "endpoints": {
        "Example Domain": {
          "interval": "1m",
          "timeout": "5s",
          "url": "http://www.example.com"
        },
        "Google Domain": {
          "metadata": {
            "Description": "Agent URL monitoring for Google main page"
          },
          "url": "http://www.google.com"
        }
      }
    }
  },
  "peragent": {
    "global": {
      "device1": {
        "metadata": {
          "GroupAz": "east-1",
          "GroupPod": "pod1"
        }
      }
    }
  }
}

Host Metrics Sample JSON

Following is a sample JSON configuration for enabling host metrics.

{
  "global": {
    "collectorAddress": "<setup name>.console.augtera.com",
    "capabilities": {
      "hostMetrics": {
        "cpu": "on",
        "memory": "on",
        "disk": "on",
        "perProcessCpu": "on",
        "perProcessMemory": "on"
      }
    },
    "metadata": {
      "GroupName": "us"
    },
    "hostMetrics": {
      "interval": 30
    }
  },
  "peragent": {
    "global": {
      "device1": {
        "metadata": {
          "GroupAz": "east-1",
          "GroupPod": "pod1"
        }
      }
    }
  }
}