Note |
---|
In order to use this document, you must have the Write LogManagement permission assigned to your account. |
...
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.
...
At a high-level, to use Log Relay, you must:
...
Note |
---|
In some cases, the terms Log Depot, Host Log Collector, or Log Relay may be used interchangeably. |
Note |
---|
For pricing information, please contact your account manager. |
...
hidden | true |
---|
...
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:
...
Use the Post Host Log Collector (Activate) API to add Host Log Collector to your account.
...
Code Block | ||
---|---|---|
| ||
POST https://api.armor.com/log-management/log-depot/activate |
...
Code Block | ||
---|---|---|
| ||
{
"accountId": 0,
"modifiedByUserId": 0,
"modifiedDate": "2017-10-23T16:35:13.540Z",
"isEnabled": true
} |
Note |
---|
To learn more about this API call, see Post Host Log Collector (Activate). |
...
hidden | true |
---|
...
Contact Armor Support to add a custom file path via a host log collector.
...
hidden | true |
---|
Option 1: For Windows users
To use these instructions, you must have powershell admin access.
- Log into the server instance that contains the Armor agent.
- Stop the agent with the following command:
- spsv armor-agent
- 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.
- Sync the agent's policy to the API with the following command:
- C:\.armor\opt\armor policy filelog sync
- C:\.armor\opt\armor policy filelog sync
- Restart the agent with the following command:
- sasv armor-agent
- (Optional) To review any collected host log files:
- In the Armor Management Portal (AMP), on the left-side navigation, click Security.
- Click Log & Data Management.
- Click Search.
- 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
...
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.
...
In the Search screen, you can search by tags.
Tags are optional.
- Log into a server instance that contains the Armor agent.
- Stop the agent with the following command:
- service armor-agent stop
- service armor-agent stop
- 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.
- /opt/armor/armor policy filelog add --path /var/log/app.log --category app --tags app,app1
- Sync the agent's policy to the API with the following command:
- /opt/armor/armor policy filelog sync
- /opt/armor/armor policy filelog sync
- Restart the agent with the following command:
- service armor-agent start
- service armor-agent start
- (Optional) To review any collected host log files::
- In the Armor Management Portal (AMP), on the left-side navigation, click Security.
- Click Log & Data Management.
- Click Search.
- Use the filter function to select Log Relay.
...
Review the following table to better understand how to interact with the agent via the command line:
...
Info |
---|
TroubleshootingIf you do not see any data in the Search section of the Log & Data Management screen, consider that
|
...