Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Integrator for Business Analytics

Configure log scopes

  • Last UpdatedJun 25, 2025
  • 2 minute read

A log scope defines a set of configurable parameters that control logging behavior. It supports setting log levels, adjusting verbosity, and limiting message length.

There are three types of log scopes:

  • Default: Logging configuration is applied to all logs

  • NameSpace: Logging configuration is applied to the specified namespace

  • View: Logging configuration is applied to the selected view

    Note: It is strongly recommended to consult the Technical Support team before configuring log scopes. Incorrect settings may lead to loss of important log data or excessive logging, which can impact system performance and consume disk space.

To set log scopes to customize and filter logging behavior from the Logs tab of the Administration page:

  1. Click the Log Scope Configuration button on the left side pane.

  2. Navigate to the Configuration pane.

  3. Click Add Log Scope.

    • If you are creating a NameSpace type log scope, type in the NameSpace to apply the configuration.

    • If you are creating a View type log scope, select the desired View from the dropdown list.

To remove log scopes from the Logs tab of the Administration page:

  1. Select the log scope listed under Log Scopes.

  2. Select Remove Log Scope.

    • All (Default) log scope cannot be removed.

    Refer to the following table to configure a log scope with the following parameters:

    Parameter

    Description

    Level

    Info, Warn, Debug, or Error. Default level is set to Info.

    Verbosity

    Low: Log the top level exception message

    Aggregate: Log the top level and all the nested exception messages

    Trace: Log the top level exception and the trace

    Full: Log the top level exception and all the nested exception messages and traces up to 10 levels deep. Default is Low.

    Message Length

    Limits the message length. Must be greater than 100. Default is unlimited.

    TitleResults for “How to create a CRG?”Also Available in