PingAuthorize

Configuring the Periodic Stats Logger

After enabling the Periodic Stats Logger plugin or creating a new logger, you can configure the logging interval, enable or disable specific metric categories, or adjust log file format, rotation, and retention policies. This is useful when tuning performance, refining which metrics you capture, or aligning the logger with your operational requirements.

Before you begin

Enable the existing Periodic Stats Logger plugin or create a new logger.

To configure a Periodic Stats Logger non-interactively:

Steps

  • Run the dsconfig set-plugin-prop command with the following arguments:

    Argument Required Description

    plugin-name <name>

    Required

    Specifies the name of the plugin to configure.

    --set decription:<description>

    Optional

    Specifies a description for the plugin.

    --set enabled:true

    Required

    Specifies whether the plugin is enabled.

    Allowed values are true and false. The plugin is disabled by default.

    --set log-interval:<interval>

    Required

    Specifies the duration, in seconds, between statistics collection and logging.

    The default value is 5 seconds.

    Setting this value to less than 1 second can negatively impact server performance.

    --set suppress-if-idle:true

    Required

    If set to true, the server doesn’t log metrics during idle periods.

    --set included-http-servlet-stat:<servlet>

    Optional

    Specifies the HTTP servlet extensions from which the logger should collect performance data.

    Allowed values are:

    • sideband-api: Collects metrics for the Sideband API.

    • gateway: Collects metrics for the API security gateway.

    • scim2: Collects metrics for the SCIM 2 API.

    For each extension, the logger records two statistics:

    • The average latency, in microseconds, introduced by PingAuthorize during the logging interval. This is calculated as the total request processing time minus the time spent waiting for the upstream service.

    • The request count for the logging interval.

    --set include-http-metrics: true

    Optional

    Specifies whether to log moving averages for HTTP socket, connection, queue, request, and response durations.

    Learn more in Enabling HTTP metrics in the Periodic Stats Logger.

    --set log-file-format:<format>

    Optional

    Specifies the format to use when logging server statistics.

    Allowed values are:

    • csv: Logs statistics as comma-separated values.

    • json: Logs statistics in JSON format.

    --set log-file:<file-name>

    Required

    Specifies the file name to use for logs generated by the plugin.

    --set log-file-permissions:<UNIX-string>

    Required

    Specifies the UNIX permissions of the log files generated by the plugin.

    --set rotation-policy:<policy>

    Required

    Specifies the log rotation policy for the plugin. When multiple policies are specified, log files are rotated when any of the policies' conditions are met.

    --set retention-policy:<policy>

    Required

    Specifies the log retention policy for the plugin. When multiple policies are used, log files are cleared when any of the policies' conditions are met.

    --set logging-error-behavior:<behavior>

    Optional

    Specifies the server behavior when an error occurs during log processing.

    Allowed values are:

    • standard-error: Writes a message to standard error.

    • lockdown-mode: Places the server in lockdown mode.