In order to use this document, you must have the Write LogManagement permission assigned to your account.

Overview

You can use the Log Relay add-on product to securely store file-based application logs with Armor for 30 days or 13 months, based on your log retention plan. 


Log Relay

At a high-level, to use Log Relay, you must: 

In some cases, the terms Log Depot, Host Log Collector, or Log Relay may be used interchangeably.

For pricing information, please contact your account manager.

Review pricing information

Host Log Collector's prices are based on a subscription (base) charge and an overage (tiered) charge. 

The monthly subscription charge includes up to 25GB of storage. Additional storage above 25GB will be charged on a tiered level. 

Review the following table to understand the pricing structure:

SKU$/Month£/Month
LD Base Subscription$200£155

$ per GB£ per GBTier Discount
0GB - 25GB (Included in Base Subscription)Included (is $8/GB)Included (is £6.20)-
26GB - 50GB$7.2£5.5810%
51GB - 100GB$6.56£5.0818%
101GB - 250GB$6.08£4.7124%
251GB - 500GB$5.60£4.3430%
501GB - 1000GB$5.28£4.0934%
1001GB+$5.12£3.9736%

Order Log Relay for Host Log Collection


Step 1: Add Log Relay

Use the Post Host Log Collector (Activate) API to add Host Log Collector to your account. 

Method / TypePOST
API call / URL/log-management/log-depot/activate
ParametersThere are no parameters for this API call.
Full API call / URL
POST https://api.armor.com/log-management/log-depot/activate
Sample 200 return
{
  "accountId": 0,
  "modifiedByUserId": 0,
  "modifiedDate": "2017-10-23T16:35:13.540Z",
  "isEnabled": true
}
To learn more about this API call, see Post Host Log Collector (Activate)


Step 2: Send Logs to Armor

  1. Contact Armor Support to add a custom file path via a host log collector.

Option 1: For Windows users

To use these instructions, you must have powershell admin access.

  1. Log into the server instance that contains the Armor agent.
  2. Stop the agent with the following command: 
    • spsv armor-agent
  3. Run the agent policy command to add log policies. You can use the following commands as an example: 
    • For filelog type, run C:\.armor\opt\armor policy filelog add --path C:\inetpub\logs\web1.log --category web --tags web1,iis

    • For eventlog type, run C:\.armor\opt\armor policy eventlog add --name Application --category app --tags app
    • Category is required. You must label your logs based on one of the following categories: app, db, machine-data, platform, user, or web. 
    • Tags are optional. 
  4. Sync the agent's policy to the API with the following command:
    • C:\.armor\opt\armor policy filelog sync
  5. Restart the agent with the following command: 
    • sasv armor-agent
  6. (Optional) To review any collected host log files:
    1. In the Armor Management Portal (AMP), on the left-side navigation, click Security
    2. Click Log & Data Management
    3. Click Search
    4. Use the filter function to select Log Relay

Option 2: For Linux users

To use these instructions, you must have sudo access. 

Review the following example to understand how to send logs to Armor: /opt/armor/armor policy filelog add --path /var/log/dpkg.log --category platform --tags Ubuntu

TextDescription
/opt/armor/armor policy filelog addBase script
--path /var/log/dpkg.logThe location of the files.
--category platform

The type (category) of logs.

You must label your logs based on one of the following categories: app, db, machine-data, platform, user, or web. 

--tags Ubuntu

In the Search screen, you can search by tags.

Tags are optional.

  1. Log into a server instance that contains the Armor agent. 
  2. Stop the agent with the following command: 
    • service armor-agent stop
  3. Run the agent policy command to add log policies. You can use the following command as example: 
    • /opt/armor/armor policy filelog add --path /var/log/app.log --category app --tags app,app1
      • Category is required. You must label your logs based on one of the following categories: app, db, machine-data, platform, user, or web. 
      • Tags are optional.
  4. Sync the agent's policy to the API with the following command: 
    • /opt/armor/armor policy filelog sync
  5. Restart the agent with the following command: 
    • service armor-agent start
  6. (Optional) To review any collected host log files::
    1. In the Armor Management Portal (AMP), on the left-side navigation, click Security
    2. Click Log & Data Management
    3. Click Search
    4. Use the filter function to select Log Relay

Review Additional Agent-related Commands

Review the following table to better understand how to interact with the agent via the command line: 

CommandDescription
armor -hDisplays the agent's help dialog
armor policy -hDisplays the agent's policy help dialog
armor policy filelog -hDisplays the agent's policy filelog help dialog
armor policy filelog add -hDisplays the agent's policy filelog add help dialog
armor policy filelog --add [path]Adds a filebeat logging policy with the user-defined path, category, and tag(s).
armor policy add eventlog [name]Adds a (Windows) eventlog logging policy with the user-defined path, category, and tag(s).
armor policy showDisplays command functionality and syntax available at the command line. "show" can be added to any level of command to help drive user input
armor policy syncSynchronizes the local Armor CORE Agent with API services to pull down the latest policy version

Troubleshooting

If you do not see any data in the Search section of the Log & Data Management screen, consider that