Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
mongosh Methods
/
Atlas Stream Processing

sp.processor.stats()

On this page

  • Definition
  • Syntax
  • Command Fields
  • Behavior
  • Access Control
  • Example
  • Learn More

Definition

sp.processor.stats()

Returns a document containing statistics of a currently running Stream Processor on the current Stream Processing Instance.

You can only invoke this command while connected to a stream processing instance.

This command requires mongosh version ≥ 2.0.

Syntax

The sp.processor.stats() method has the following syntax:

sp.processor.stats()

Command Fields

sp.processor.stats() takes these fields:

Field
Type
Necessity
Description
options
object
Optional
Object defining various optional settings for your statistics report.
options.scale
integer
Optional
Unit to use for the size of items described in the output. If set to 1024, the output document shows sizes in kibibytes. Defaults to bytes.
verbose
boolean
Optional
Flag that specifies the verbosity level of the output document. If set to true, the output document contains a subdocument that reports the statistics of each individual operator in your pipeline. Defaults to false.

Behavior

sp.processor.stats() returns a document containing statistics about the specified stream processor to STDOUT. These statistics include but are not limited to:

  • The number of messages ingested and processed

  • The total size of all input and output

  • The amount of memory used to store processor state

You can only invoke sp.processor.stats() on a currently running stream processor. If you try to invoke this command on a stopped stream processor, mongosh will return an error.

Access Control

The user running sp.processor.stats() must have the atlasAdmin role.

Example

The following example shows an expected response from calling sp.solarDemo.stats() to get the statistics of a stream processor called solarDemo:

sp.solarDemo.stats()
{
  ok: 1,
  ns: '6500aa277fdbdb6e443a992e.63c1928d768e39423386aa16.solarDemo',
  stats: {
    name: 'solarDemo',
    processorId: '65f9fea5c5154385174af71e',
    status: 'running',
    scaleFactor: Long('1'),
    inputMessageCount: Long('926'),
    inputMessageSize: 410310,
    outputMessageCount: Long('383'),
    outputMessageSize: 425513,
    dlqMessageCount: Long('0'),
    dlqMessageSize: Long('0'),
    stateSize: Long('4504'),
    watermark: ISODate('2024-03-19T22:16:49.523Z'),
    ok: 1
  },
  pipeline: [
    {
      '$source': {
        connectionName: 'sample_stream_solar',
        timeField: { '$dateFromString': { dateString: '$timestamp' } }
      }
    },
    {
      '$match': { '$expr': { '$ne': [ '$device_id', 'device_8' ] } }
    },
    {
      '$tumblingWindow': {
        interval: { size: 10, unit: 'second' },
        pipeline: [
          {
            '$group': {
              _id: [Object],
              max_temp: [Object],
              max_watts: [Object],
              min_watts: [Object],
              avg_watts: [Object],
              median_watts: [Object]
            }
          }
        ]
      }
    },
    {
      '$merge': {
        into: {
          connectionName: 'mongodb1',
          db: 'solar_db',
          coll: 'solar_coll'
        },
        on: [ '_id' ]
      }
    }
  ]
}

Learn More

Back

sp.processor.start

Next

sp.processor.stop