clean up explaination in the documentation

Author: jayz22

docs/metrics.md

@@ -78,7 +78,7 @@ loadgen.soroban.setup_invoke              | meter     | loadgenerator: soroban s
 loadgen.soroban.setup_upgrade             | meter     | loadgenerator: soroban setup upgrades TXs submitted
 loadgen.soroban.upload                    | meter     | loadgenerator: soroban upload TXs submitted
 loadgen.step.count                        | meter     | loadgenerator: generated some transactions
-loadgen.step.submit                       | timer     | loadgenerator: time spent submiting transactions per step
+loadgen.step.submit                       | timer     | loadgenerator: time spent submitting transactions per step
 loadgen.txn.attempted                     | meter     | loadgenerator: transaction submitted
 loadgen.txn.bytes                         | meter     | loadgenerator: size of transactions submitted
 loadgen.txn.rejected                      | meter     | loadgenerator: transaction rejected
@@ -162,40 +162,40 @@ state-archival.eviction.bytes-scanned     | counter   | number of bytes that evi
 state-archival.eviction.entries-evicted   | counter   | number of entries that have been evicted
 state-archival.eviction.incomplete-scan   | counter   | number of buckets that were too large to be fully scanned for eviction
 state-archival.eviction.period            | counter   | number of ledgers to complete an eviction scan
-soroban.host-fn-op.read-entry                | meter     | number of entries read
-soroban.host-fn-op.write-entry               | meter     | number of entries written
-soroban.host-fn-op.read-key-byte             | meter     | number of key bytes in read entries
-soroban.host-fn-op.write-key-byte            | meter     | number of key bytes in written entries
-soroban.host-fn-op.read-ledger-byte          | meter     | number of entry (data + code) bytes in read entries
-soroban.host-fn-op.read-data-byte            | meter     | number of data bytes in read entries
-soroban.host-fn-op.read-code-byte            | meter     | number of code bytes in read entries
-soroban.host-fn-op.write-ledger-byte         | meter     | number of entry (data + code) bytes in written entries
-soroban.host-fn-op.write-data-byte           | meter     | number of data bytes in written entries
-soroban.host-fn-op.write-code-byte           | meter     | number of code bytes in written entries
-soroban.host-fn-op.emit-event                | meter     | number of events emitted
-soroban.host-fn-op.emit-event-byte           | meter     | number of event bytes emitted
-soroban.host-fn-op.cpu-insn                  | meter     | metered cpu instructions
-soroban.host-fn-op.mem-byte                  | meter     | metered memory bytes
-soroban.host-fn-op.invoke-time-nsecs         | timer     | time spent in `invoke_host_function`
-soroban.host-fn-op.cpu-insn-excl-vm          | meter     | metered cpu instructions excluding VM instantation
-soroban.host-fn-op.invoke-time-nsecs-excl-vm | timer     | time spent in `invoke_host_function` excluding VM instantation
-soroban.host-fn-op.invoke-time-fsecs-cpu-insn-ratio         | histogram | ratio between invoke_time (femto-seconds) and cpu instructions
-soroban.host-fn-op.invoke-time-fsecs-cpu-insn-ratio-excl-vm | histogram | ratio between invoke_time (femto-seconds) and cpu instructions excluding VM instantation
-soroban.host-fn-op.max-rw-key-byte           | meter     | bytes of the largest key in entries read/written
-soroban.host-fn-op.max-rw-data-byte          | meter     | bytes of the largest data entry read/written
-soroban.host-fn-op.max-rw-code-byte          | meter     | bytes of the largest code entry read/written
-soroban.host-fn-op.max-emit-event-byte       | meter     | bytes of the largest event emitted
-soroban.host-fn-op.success                   | meter     | if `InvokeHostFunctionOp` results in a success
-soroban.host-fn-op.failure                   | meter     | if `InvokeHostFunctionOp` results in a failure
-soroban.host-fn-op.exec                      | timer     | time spent in `InvokeHostFunctionOp`
-soroban.restore-fprint-op.read-ledger-byte   | meter     | number of entry bytes in read entries
-soroban.restore-fprint-op.write-ledger-byte  | meter     | number of entry bytes in written entries
-soroban.ext-fprint-ttl-op.read-ledger-byte   | meter     | number of entry bytes in read entries
+soroban.host-fn-op.read-entry                | meter     | number of entries accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.write-entry               | meter     | number of entries modified during the `InvokeHostFunctionOp`
+soroban.host-fn-op.read-key-byte             | meter     | number of `LedgerKey` bytes in entries accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.write-key-byte            | meter     | number of `LedgerKey` bytes in entries modified during the `InvokeHostFunctionOp`
+soroban.host-fn-op.read-ledger-byte          | meter     | number of `LedgerEntry` bytes accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.read-data-byte            | meter     | number of `ContractDataEntry` bytes accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.read-code-byte            | meter     | number of `ContractCodeEntry` bytes accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.write-ledger-byte         | meter     | number of `LedgerEntry` bytes modified during the `InvokeHostFunctionOp`
+soroban.host-fn-op.write-data-byte           | meter     | number of `ContractDataEntry` bytes modified during the `InvokeHostFunctionOp`
+soroban.host-fn-op.write-code-byte           | meter     | number of `ContractCodeEntry` bytes modified during the `InvokeHostFunctionOp`
+soroban.host-fn-op.emit-event                | meter     | number of events emitted during the `InvokeHostFunctionOp`
+soroban.host-fn-op.emit-event-byte           | meter     | number of event bytes emitted during the `InvokeHostFunctionOp`
+soroban.host-fn-op.cpu-insn                  | meter     | number of metered cpu instructions during the `InvokeHostFunctionOp`
+soroban.host-fn-op.mem-byte                  | meter     | number of metered memory bytes during the `InvokeHostFunctionOp`
+soroban.host-fn-op.invoke-time-nsecs         | timer     | time spent on the soroban host invocation. Note: this is **not** the total time of the operation, which is tracked under "soroban.host-fn-op.exec".
+soroban.host-fn-op.cpu-insn-excl-vm          | meter     | number of metered cpu instructions excluding VM instantiation during the `InvokeHostFunctionOp`
+soroban.host-fn-op.invoke-time-nsecs-excl-vm | timer     | time spent in soroban host invocation excluding VM instantiation
+soroban.host-fn-op.invoke-time-fsecs-cpu-insn-ratio         | histogram | ratio between soroban host invocation time (femto-seconds) and metered cpu instructions
+soroban.host-fn-op.invoke-time-fsecs-cpu-insn-ratio-excl-vm | histogram | ratio between soroban host invocation time (femto-seconds) and metered cpu instructions, excluding VM instantiation
+soroban.host-fn-op.max-rw-key-byte           | meter     | size of the largest `LedgerKey` (in bytes) among all entires accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.max-rw-data-byte          | meter     | size of the largest `ContractDataEntry` (in bytes) among all entires accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.max-rw-code-byte          | meter     | size of the largest `ContractCodeEntry` (in bytes) among all entires accessed (read or modified) during the `InvokeHostFunctionOp`
+soroban.host-fn-op.max-emit-event-byte       | meter     | size of the largest event emitted during the `InvokeHostFunctionOp`
+soroban.host-fn-op.success                   | meter     | number of successful `InvokeHostFunctionOp` operations
+soroban.host-fn-op.failure                   | meter     | number of failed `InvokeHostFunctionOp` operations
+soroban.host-fn-op.exec                      | timer     | total time spent during the `InvokeHostFunctionOp`
+soroban.restore-fprint-op.read-ledger-byte   | meter     | number of `LedgerEntry` bytes accessed (read or modified) during the `RestoreFootprintOp`
+soroban.restore-fprint-op.write-ledger-byte  | meter     | number of `LedgerEntry` bytes modified during the `RestoreFootprintOp`
+soroban.ext-fprint-ttl-op.read-ledger-byte   | meter     | number of `LedgerEntry` bytes accessed (read or modified) during the `ExtendFootprintTTLOp`
 soroban.ledger.cpu-insn                      | histogram | metered cpu instructions per ledger
-soroban.ledger.read-entry                    | histogram | number of entries read per ledger
-soroban.ledger.read-byte                     | histogram | number of entry bytes in read entries per ledger
-soroban.ledger.write-entry                   | histogram | number of entries written per ledger
-soroban.ledger.write-byte                    | histogram | number of entry bytes in written entries per ledger
+soroban.ledger.read-entry                    | histogram | number of entries accessed (read or modified) per ledger
+soroban.ledger.read-ledger-byte              | histogram | number of `LedgerEntry` bytes accessed (read or modified) per ledger
+soroban.ledger.write-entry                   | histogram | number of entries modified per ledger
+soroban.ledger.write-ledger-byte             | histogram | number of `LedgerEntry` bytes modified per ledger
 soroban.config.contract-max-rw-key-byte      | counter   | soroban config setting `contract_data_key_size_bytes`
 soroban.config.contract-max-rw-data-byte     | counter   | soroban config setting `contract_data_entry_size_bytes`
 soroban.config.contract-max-rw-code-byte     | counter   | soroban config setting `contract_max_size_bytes`

src/ledger/LedgerManagerImpl.cpp

@@ -127,11 +127,11 @@ SorobanLedgerMetrics::publishAndResetMetrics()
         .Update(mLedgerCpuInsn);
     mMetrics.NewHistogram({"soroban", "ledger", "read-entry"})
         .Update(mLedgerReadEntry);
-    mMetrics.NewHistogram({"soroban", "ledger", "read-byte"})
+    mMetrics.NewHistogram({"soroban", "ledger", "read-ledger-byte"})
         .Update(mLedgerReadByte);
     mMetrics.NewHistogram({"soroban", "ledger", "write-entry"})
         .Update(mLedgerWriteEntry);
-    mMetrics.NewHistogram({"soroban", "ledger", "write-byte"})
+    mMetrics.NewHistogram({"soroban", "ledger", "write-ledger-byte"})
         .Update(mLedgerWriteByte);
     mLedgerCpuInsn = 0;
     mLedgerReadEntry = 0;