Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-8914

Document the $collStats aggregation source

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Critical - P2 Critical - P2
    • 3.4.0
    • Affects Version/s: None
    • Component/s: Server
    • Labels:
      None

      $collStats is a new aggregation source in MongoDB 3.4. It provides a superset of the information available via the db.collection.stats() shell helper available in 3.2.

      $collStats must be the first stage in a pipeline.

      Synopsis:

      db.collection.aggregate(
          { $collStats: 
              latencyStats: <document>,
              storageStats: {}
          }
      )
      

      Both latencyStats and storageStats are optional.

      storageStats gives you storage-level statistics about a collection. It's exactly the same output as the old db.collection.stats() shell helper. This can only be specified on a collection; attempting it on a view results in the error CommandNotSupportedOnView.

      latencyStats gives information about latencies for reads, writes and commands on a given namespace. It can be run on both views and collections. The latencyStats field must be a document that itself has one field, histograms. If histograms is true, the command returns the full operation latency histograms for that namespace. If false, the full histogram is omitted and only a summary is output.

      *Note from allison.moore@mongodb.com*: We'll need to a reference page for the new $collStats pipeline operator.

            Assignee:
            andrew.aldridge@mongodb.com Andrew Aldridge
            Reporter:
            emily.hall Emily Hall
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved:
              7 years, 26 weeks ago