acos-events local-logging

Configure local logging/persistant storage of FW logs

local-logging Specification

Type

Configuration Resource

Element Name

local-logging

Element URI

/axapi/v3/acos-events/local-logging

Element Attributes

local-logging_attributes

Statistics Data URI

/axapi/v3/acos-events/local-logging/stats

Schema

local-logging schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/acos-events/local-logging

local-logging attributes

Get Object

GET

/axapi/v3/acos-events/local-logging

local-logging attributes

Modify Object

POST

/axapi/v3/acos-events/local-logging

local-logging attributes

Replace Object

PUT

/axapi/v3/acos-events/local-logging

local-logging attributes

Delete Object

DELETE

/axapi/v3/acos-events/local-logging

local-logging attributes

local-logging attributes

debug-logs

Description Enable debug logs in var log

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

delete-old-logs-in-disk

Description Operational command to delete the old logs stored in disk

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable

Description Enable local-logging when FW log servers are down (Default: Not enabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-backlog-memory

Description Configure Max memory in MB to be used for processing backlogs (Default: 10MB)

Type: number

Range: 5-500

Default: 10

max-disk-space

Description Configure Max disk space in MB to be used for storing the logs (Default: 100MB)

Type: number

Range: 50-20000

Default: 100

max-memory

Description Configure Max memory in MB to be used for processing the logs (Default: 30MB)

Type: number

Range: 5-500

Default: 30

queue-limit

Description Configure Max number of blocks that can be busy being scheduled (Default: 10, 0 to disable)

Type: number

Range: 0-100

Default: 10

rate-limit

Description Configure number of logs per second to be stored in disk (Default: 1000)

Type: number

Range: 1-60000

Default: 1000

send-if-all-servers-up

Description Start sending the stored logs only when all log servers are up

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

string-decode-special-char

Description Enable processing special characters before storing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

stats data

Counter

Size

Description

out-logs

8

Number of logs sent to log servers

out-error

8

Number of errors during send

store-fail

8

Number of logs failed to be stored

in-discard-logs

8

Number of old logs discarded to fit in new logs

in-discard-bytes

8

Number of old bytes discarded to fit in new logs

in-logs-backlog

8

Number of backlogs loaded from disk

in-bytes

8

Number of bytes successfully stored

init-pass

8

Local logging Init Successful

sent-to-store-fail

8

Number of Logs sent to be stored Failed

out-bytes

8

Number of bytes sent to log-servers

remaining-bytes

8

Total number of remaining bytes yet to be sent

remaining-logs

8

Total number of remaining logs yet to be sent

in-store-fail-no-space

8

Number of logs Dropped, failed without disk space

in-logs

8

Number of logs successfully stored

rate-limited

8

Number of logs Dropped, Rate limited

sent-to-store

8

Number of logs sent to be stored

not-inited

8

Number of logs Dropped, Local logging not inited

disk-over-thres

8

Number of logs Dropped, Disk reached threshold

in-bytes-backlog

8

Number of backlog bytes loaded from disk

init-fail

8

Local logging Init Fail

freed

8

Local logging Stopped