acos-events local-logging

Configure local logging/persistant storage of FW logs

local-logging Specification

Parameter Value
Type Configuration Resource
Element Name local-logging
Element URI /axapi/v3/acos-events/local-logging
Element Attributes local-logging_attributes
Partition Visibility shared
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

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-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

rate-limit

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

Type: number

Range: 1-60000

Default: 1000

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable

Specification Value
Type list
Block object keys  

counters1

Description ‘all’: all; ‘init-pass’: Local logging Init Successful; ‘init-fail’: Local logging Init Fail; ‘freed’: Local logging Stopped; ‘disk-over-thres’: Number of logs Dropped, Disk reached threshold; ‘rate-limited’: Number of logs Dropped, Rate limited; ‘not-inited’: Number of logs Dropped, Local logging not inited; ‘sent-to-store’: Number of logs sent to be stored; ‘sent-to-store-fail’: Number of Logs sent to be stored Failed; ‘store-fail’: Number of logs failed to be stored; ‘in-logs’: Number of logs successfully stored; ‘in-bytes’: Number of bytes successfully stored; ‘in-logs-backlog’: Number of backlogs loaded from disk; ‘in-bytes-backlog’: Number of backlog bytes loaded from disk; ‘in-store-fail-no-space’: Number of logs Dropped, failed without disk space; ‘in-discard-logs’: Number of old logs discarded to fit in new logs; ‘in-discard-bytes’: Number of old bytes discarded to fit in new logs; ‘out-logs’: Number of logs sent to log servers; ‘out-bytes’: Number of bytes sent to log-servers; ‘out-error’: Number of errors during send; ‘remaining-logs’: Total number of remaining logs yet to be sent; ‘remaining-bytes’: Total number of remaining bytes yet to be sent; ‘moved-to-delq’: Local Logging moved to delq to be deleted; ‘out-retry’: Number of attempted retries to send logs; ‘out-retry-fail’: Number of retries failed with error; ‘curr-total-chunks’: Current Number of blocks; ‘curr-mem-chunks’: Current blocks in memory; ‘curr-fs-chunks’: Current blocks in file system; ‘curr-fs-chunks-up’: Current blocks in file system loaded in memory; ‘curr-fs-chunks-down’: Current blocks in file system not loaded in memory; ‘in-logs-agg’: Total Aggregate, Number of logs successfully stored; ‘in-bytes-agg’: Total Aggregate, Number of bytes successfully stored; ‘in-logs-backlog-agg’: Total Aggregate, Number of backlogs loaded from disk; ‘in-bytes-backlog-agg’: Total Aggregate, Number of backlog bytes loaded from disk; ‘in-store-fail-no-space-agg’: Total Aggregate, Number of logs Dropped, failed without disk space; ‘in-discard-logs-agg’: Total Aggregate, Number of old logs discarded to fit in new logs; ‘in-discard-bytes-agg’: Total Aggregate, Number of old bytes discarded to fit in new logs; ‘out-logs-agg’: Total Aggregate, Number of logs sent to log servers; ‘out-bytes-agg’: Total Aggregate, Number of bytes sent to log-servers; ‘out-error-agg’: Total Aggregate, Number of errors during send; ‘out-retry-agg’: Total Aggregate, Number of attempted retries to send logs; ‘out-retry-fail-agg’: Total Aggregate, Number of retries failed with error; ‘in-logs-curr-agg’: Current Aggregate, Number of logs successfully stored; ‘in-bytes-curr-agg’: Current Aggregate, Number of bytes successfully stored; ‘in-logs-backlog-curr-agg’: Current Aggregate, Number of backlogs loaded from disk; ‘in-bytes-backlog-curr-agg’: Current Aggregate, Number of backlog bytes loaded from disk; ‘in-discard-logs-curr-agg’: Current Aggregate, Number of old logs discarded to fit in new logs; ‘in-discard-bytes-curr-agg’: Current Aggregate, Number of old bytes discarded to fit in new logs; ‘out-logs-curr-agg’: Current Aggregate, Number of logs sent to log servers; ‘out-bytes-curr-agg’: Current Aggregate, Number of bytes sent to log-servers;

Type: string

Supported Values: all, init-pass, init-fail, freed, disk-over-thres, rate-limited, not-inited, sent-to-store, sent-to-store-fail, store-fail, in-logs, in-bytes, in-logs-backlog, in-bytes-backlog, in-store-fail-no-space, in-discard-logs, in-discard-bytes, out-logs, out-bytes, out-error, remaining-logs, remaining-bytes, moved-to-delq, out-retry, out-retry-fail, curr-total-chunks, curr-mem-chunks, curr-fs-chunks, curr-fs-chunks-up, curr-fs-chunks-down, in-logs-agg, in-bytes-agg, in-logs-backlog-agg, in-bytes-backlog-agg, in-store-fail-no-space-agg, in-discard-logs-agg, in-discard-bytes-agg, out-logs-agg, out-bytes-agg, out-error-agg, out-retry-agg, out-retry-fail-agg, in-logs-curr-agg, in-bytes-curr-agg, in-logs-backlog-curr-agg, in-bytes-backlog-curr-agg, in-discard-logs-curr-agg, in-discard-bytes-curr-agg, out-logs-curr-agg, out-bytes-curr-agg