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

Document the $collStats aggregation source

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Critical - P2
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.4.0
    • Component/s: Server
    • Labels:
      None
    • # Replies:
      1
    • Last comment by Customer:
      true
    • Story Points:
      2
    • Epic Link:
    • Sprint:
      KANBAN BUCKET

      Description

      $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.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              andrew.aldridge Andrew Aldridge
              Reporter:
              emily.hall Emily Hall
              Participants:
              Last commenter:
              Jonathan Dahl
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Days since reply:
                4 years, 5 weeks, 1 day ago
                Date of 1st Reply: