docs: Add specification of ndn::CsTracer output format
Change-Id: Iec18266c835f28dece1eac08c2dc4322bf67ff83
diff --git a/docs/source/metric.rst b/docs/source/metric.rst
index 167b622..510cc3d 100644
--- a/docs/source/metric.rst
+++ b/docs/source/metric.rst
@@ -264,6 +264,27 @@
...
+ Output file format is tab-separated values, with first row specifying names of the columns. Refer to the following table for the description of the columns:
+
+ +------------------+----------------------------------------------------------------------+
+ | Column | Description |
+ +==================+======================================================================+
+ | ``Time`` | simulation time |
+ +------------------+----------------------------------------------------------------------+
+ | ``Node`` | node id, globally unique |
+ +------------------+----------------------------------------------------------------------+
+ | ``Type`` | Type of counter for the time period. Possible values are: |
+ | | |
+ | | - ``CacheHits``: the ``Packets`` column specifies the number of |
+ | | Interests that were satisfied from the cache |
+ | | - ``CacheMisses``: the ``Packets`` column specifies the number of |
+ | | Interests that were not satisfied from the cache |
+ +------------------+----------------------------------------------------------------------+
+ | ``Packets`` | The number of packets for the time period, meaning depends on |
+ | | ``Type`` column |
+ +------------------+----------------------------------------------------------------------+
+
+
.. - Tracing lifetime of content store entries
.. Evaluate lifetime of the content store entries can be accomplished using modified version of the content stores.