Skip to main content
Version: 9.0.2

trace

Plugin Name: trace (-otrace,...) / Shared Library: libgre-plugin-trace

Note

These options can also be specified using -ologger, for backward compatibility

perf

This option enables the logging of performance data to the standard output (or file if perf_file is used). If a value of 0 is specified to the perf option then performance logging is enabled, but the capture of data is not immediately started and can be toggled using the gra.perf_state action. If the value is set to 1 or is not specified, then performance data will be immediately captured.

For example -ologger,perf=1 will enable performance logging with the immediate capture of performance metrics.

If performance logging is enabled then the output is a set of comma separated values (CSV) with the following fields: PERF, application time, type, operation, name, duration.

application time

This is the time that the performance event was finished relative to the start time of the application in milliseconds.

type

This is the type of performance operation that was recorded as a broad classifier.

operation

This is a sub-classification of the type used for additional tracing granularity.

name

This is an identifier that can be used, along with the type and operation fields, to identify the context of the performance operation being performed.

duration

This is the duration of the operation in milliseconds.

perf_buffer=[bytes]

This option will buffer all performance logging output to an allocated in-memory buffer and only flush the output when the buffer content is full. The number of bytes allocated for the buffer are provided by the option to the argument. If the buffer size is 0 or invalid, then 4K will be allocated for the buffer.

perf_event_prefix=[prefix]

This option specifies the prefix to use in the perf event names. This defaults to perf.

perf_file=[filename]

This option specifies a path in the file system to direct the performance data output to. The directory path to the file must already exist and the contents of the file will be overwritten on each invocation of sbengine.

perf_filter=[keyword]

This option enables filtering of perf types based on the keyword provided. The sb_Event type cannot be filtered out. This is because Storyboard engine is event based, and everything that happens is tied back to the event that kicked things off. Multiple keywords can be specified. Filtered types are delimited by a ':'. -otrace,perf,perf_filter=sb_RenderExtension Each keyword can also be negated by the '^' symbol. Therefore we could ignore all render extension types by passing in the following command: -otrace,perf,perf_filter=^sb_RenderExtension Filtering applies to the perf option.