Skip to navigation

Gst-nvdslogger

View as Markdown

The Gst-nvdslogger plugin is a pass-through element that logs performance and metadata information for the buffers flowing through it, without modifying the data. It is typically inserted into a pipeline to measure per-stream FPS and frame-level latency, and to dump inference metadata for debugging. The performance data collected by this plugin is also used by the nvds_rest_metrics library to export pipeline metrics to OpenTelemetry collectors; see DeepStream OpenTelemetry Support for details.

Inputs and Outputs

  • Inputs

    • GStreamer buffer containing NvDsBatchMeta and any format
  • Control parameters

    • gpu-id is not applicable; the plugin does not process buffer content, only metadata
  • Output

    • GStreamer buffer, unmodified, passed through to the next element

Features

The following table summarizes the features of the plugin.

Gst-nvdslogger plugin features

FeatureDescriptionRelease
Per-stream FPS measurementMeasures and prints per-stream frames-per-second at a configurable intervalDS 9.2
Frame-level latency measurementMeasures and prints per-frame latency when latency tracking is enabled on the pipelineDS 9.2

Gst Properties

The following table describes the Gst properties of the Gst-nvdslogger plugin.

Gst-nvdslogger plugin gst properties

PropertyMeaningType and RangeExample Notes
silentSuppresses console output when setBooleansilent=0
fps_measurement_interval_secInterval in seconds over which buffers are counted for FPS calculationInteger,
0 to 4,294,967,295
fps_measurement_interval_sec=5
show-fpsEnables or disables FPS display printsBooleanshow-fps=1
show-latencyEnables or disables frame-level latency display printsBooleanshow-latency=1
latencyMicroseconds to delay the initial packetInteger,
0 to 4,294,967,295
latency=0