You can use this document to learn about the specific, high-level steps needed to obtain Log Relay, and send additional log types to Armor's Security Information & Event Management (SIEM).
Before you begin:
For Armor's private cloud users, you must already have a virtual machine in your account
- To learn how to create a virtual machine, see Virtual Machines.
For Armor Anywhere users, you must already have downloaded and installed the Armor Agent.
- To learn how to download the Armor Agent, see Install the Armor Anywhere Agent - Linux.
For introductory information on Log Relay, see Introduction to Log Relay.
Review Requirements
Obtain Log Relay
When you convert a virtual machine into a Log Relay device, your virtual machine / device will still contain the default Armor Agent components, such as FIM, Malware, Patching, etc.
- In the Armor Management Portal (AMP), in the left-side navigation, click Infrastructure.
- Click Virtual Machines.
- Locate and hover over the desired virtual machine.
- Click the vertical ellipses.
- Click Convert to Log Relay.
- Review pricing information, and then click Convert VM to Log Relay.
- You will be redirected to the Virtual Machines screen.
- You will be redirected to the Virtual Machines screen.
- Under Type, the virtual machine will be labeled as Log Relay. (By default, the Armor agent will update the virtual machine within 15 minutes.)
Use the PUT Assign Log Collector API call to add Log Relay to your account.
In some cases, the terms Log Depot, Host Log Collector, or Log Relay may be used interchangeably.
Method / Type PUT API Call / URL /vms/core/{coreInstanceId}/profile
Parameters You must enter your virtual machine's coreInstanceId.
To locate this ID, in AMP, access the Virtual Machine screen, click the desired virtual machine to expand, and then copy the Agent ID. The Agent ID is a combination of numbers and letters.
Full API Call / URL PUT https://api.armor.com//vms/core/1gfh39d-hdd78-dhd73-434/profile
- Contact Armor Support to add a custom file path via a host log collector.
After you have converted your virtual machine into a Log Relay device, see Create and Configure Remote Log Sources to learn how to create and configure a remote log source.
Troubleshooting
In general, if you are having issues adding Log Relay to a remote log device, consider that:
You need to update your permissions in AMP.
- In AMP, you must have the following permissions added to your account:
- Write Virtual Machine
- Delete Log Management
- Read Log Endpoints
- Read Log Relays
- Write Log Relays
Delete Log Relays
To add the above-mentioned AMP permissions to your account, see Roles and Permissions.