Skip to content

Commit

Permalink
Merge pull request #2923 from oasislabs/matevz/bug/remove-metrics-fil…
Browse files Browse the repository at this point in the history
…e-line

metrics: Remove #L line number from file URL
  • Loading branch information
matevz authored May 19, 2020
2 parents ae51f4d + 0c6f282 commit 2341d2b
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 50 deletions.
Empty file added .changelog/2923.doc.md
Empty file.
96 changes: 48 additions & 48 deletions docs/oasis-node/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,54 +54,54 @@ The following metrics are currently reported:

Name | Type | Description | Package
-----|------|-------------|--------
oasis_abci_db_size | Gauge | Total size of the ABCI database (MiB). | [consensus/tendermint/abci](../../go/consensus/tendermint/abci/mux.go#L48)
oasis_codec_size | Summary | CBOR codec message size (bytes). | [common/cbor](../../go/common/cbor/codec.go#L19)
oasis_consensus_proposed_blocks | Counter | Number of blocks proposed by the node. | [consensus/metrics](../../go/consensus/metrics/metrics.go#L17)
oasis_consensus_signed_blocks | Counter | Number of blocks signed by the node. | [consensus/metrics](../../go/consensus/metrics/metrics.go#L10)
oasis_finalized_rounds | Counter | Number of finalized rounds. | [roothash](../../go/roothash/metrics.go#L15)
oasis_grpc_calls | Counter | Number of gRPC calls. | [common/grpc](../../go/common/grpc/grpc.go#L46)
oasis_grpc_latency | Summary | gRPC call latency (seconds). | [common/grpc](../../go/common/grpc/grpc.go#L53)
oasis_grpc_stream_writes | Counter | Number of gRPC stream writes. | [common/grpc](../../go/common/grpc/grpc.go#L60)
oasis_node_cpu_stime_seconds | Gauge | CPU system time spent by worker as reported by /proc/<PID>/stat (seconds). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/cpu.go#L28)
oasis_node_cpu_utime_seconds | Gauge | CPU user time spent by worker as reported by /proc/<PID>/stat (seconds). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/cpu.go#L21)
oasis_node_disk_read_bytes | Gauge | Read data from block storage by the worker as reported by /proc/<PID>/io (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/disk.go#L29)
oasis_node_disk_usage_bytes | Gauge | Size of datadir of the worker (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/disk.go#L22)
oasis_node_disk_written_bytes | Gauge | Written data from block storage by the worker as reported by /proc/<PID>/io (bytes) | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/disk.go#L36)
oasis_node_mem_rss_anon_bytes | Gauge | Size of resident anonymous memory of worker as reported by /proc/<PID>/status (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go#L27)
oasis_node_mem_rss_file_bytes | Gauge | Size of resident file mappings of worker as reported by /proc/<PID>/status (bytes) | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go#L34)
oasis_node_mem_rss_shmem_bytes | Gauge | Size of resident shared memory of worker. | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go#L41)
oasis_node_mem_vm_size_bytes | Gauge | Virtual memory size of worker (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go#L20)
oasis_node_net_receive_bytes_total | Gauge | Received data for each network device as reported by /proc/net/dev (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go#L19)
oasis_node_net_receive_packets_total | Gauge | Received data for each network device as reported by /proc/net/dev (packets). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go#L29)
oasis_node_net_transmit_bytes_total | Gauge | Transmitted data for each network device as reported by /proc/net/dev (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go#L39)
oasis_node_net_transmit_packets_total | Gauge | Transmitted data for each network device as reported by /proc/net/dev (packets). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go#L49)
oasis_registry_entities | Gauge | Number of registry entities. | [registry](../../go/registry/metrics.go#L24)
oasis_registry_nodes | Gauge | Number of registry nodes. | [registry](../../go/registry/metrics.go#L18)
oasis_registry_runtimes | Gauge | Number of registry runtimes. | [registry](../../go/registry/metrics.go#L30)
oasis_roothash_block_interval | Summary | Time between roothash blocks (seconds). | [roothash](../../go/roothash/metrics.go#L21)
oasis_storage_failures | Counter | Number of storage failures. | [storage](../../go/storage/metrics.go#L16)
oasis_storage_latency | Summary | Storage call latency (seconds). | [storage](../../go/storage/metrics.go#L30)
oasis_storage_successes | Counter | Number of storage successes. | [storage](../../go/storage/metrics.go#L23)
oasis_storage_value_size | Summary | Storage call value size (bytes). | [storage](../../go/storage/metrics.go#L37)
oasis_up | Gauge | Is oasis-test-runner active for specific test. | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/metrics.go#L50)
oasis_worker_aborted_batch_count | Counter | Number of aborted batches. | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L57)
oasis_worker_aborted_merge_count | Counter | Number of aborted merges. | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go#L53)
oasis_worker_batch_processing_time | Summary | Time it takes for a batch to finalize (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L78)
oasis_worker_batch_read_time | Summary | Time it takes to read a batch from storage (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L71)
oasis_worker_batch_runtime_processing_time | Summary | Time it takes for a batch to be processed by the runtime (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L85)
oasis_worker_batch_size | Summary | Number of transactions in a batch. | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L92)
oasis_worker_epoch_number | Gauge | Current epoch number as seen by the worker. | [worker/common/committee](../../go/worker/common/committee/node.go#L52)
oasis_worker_epoch_transition_count | Counter | Number of epoch transitions. | [worker/common/committee](../../go/worker/common/committee/node.go#L45)
oasis_worker_execution_discrepancy_detected_count | Counter | Number of detected execute discrepancies. | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L50)
oasis_worker_failed_round_count | Counter | Number of failed roothash rounds. | [worker/common/committee](../../go/worker/common/committee/node.go#L38)
oasis_worker_inconsistent_merge_root_count | Counter | Number of inconsistent merge roots. | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go#L60)
oasis_worker_merge_discrepancy_detected_count | Counter | Number of detected merge discrepancies. | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go#L39)
oasis_worker_node_registered | Gauge | Is oasis node registered (binary). | [worker/registration](../../go/worker/registration/worker.go#L58)
oasis_worker_processed_block_count | Counter | Number of processed roothash blocks. | [worker/common/committee](../../go/worker/common/committee/node.go#L24)
oasis_worker_processed_event_count | Counter | Number of processed roothash events. | [worker/common/committee](../../go/worker/common/committee/node.go#L31)
oasis_worker_roothash_merge_commit_latency | Summary | Latency of roothash merge commit (seconds). | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go#L46)
oasis_worker_storage_commit_latency | Summary | Latency of storage commit calls (state + outputs) (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go#L64)
oasis_worker_txnscheduler_incoming_queue_size | Gauge | Size of the incoming queue (number of entries). | [worker/compute/txnscheduler/committee](../../go/worker/compute/txnscheduler/committee/node.go#L45)
oasis_abci_db_size | Gauge | Total size of the ABCI database (MiB). | [consensus/tendermint/abci](../../go/consensus/tendermint/abci/mux.go)
oasis_codec_size | Summary | CBOR codec message size (bytes). | [common/cbor](../../go/common/cbor/codec.go)
oasis_consensus_proposed_blocks | Counter | Number of blocks proposed by the node. | [consensus/metrics](../../go/consensus/metrics/metrics.go)
oasis_consensus_signed_blocks | Counter | Number of blocks signed by the node. | [consensus/metrics](../../go/consensus/metrics/metrics.go)
oasis_finalized_rounds | Counter | Number of finalized rounds. | [roothash](../../go/roothash/metrics.go)
oasis_grpc_calls | Counter | Number of gRPC calls. | [common/grpc](../../go/common/grpc/grpc.go)
oasis_grpc_latency | Summary | gRPC call latency (seconds). | [common/grpc](../../go/common/grpc/grpc.go)
oasis_grpc_stream_writes | Counter | Number of gRPC stream writes. | [common/grpc](../../go/common/grpc/grpc.go)
oasis_node_cpu_stime_seconds | Gauge | CPU system time spent by worker as reported by /proc/<PID>/stat (seconds). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/cpu.go)
oasis_node_cpu_utime_seconds | Gauge | CPU user time spent by worker as reported by /proc/<PID>/stat (seconds). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/cpu.go)
oasis_node_disk_read_bytes | Gauge | Read data from block storage by the worker as reported by /proc/<PID>/io (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/disk.go)
oasis_node_disk_usage_bytes | Gauge | Size of datadir of the worker (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/disk.go)
oasis_node_disk_written_bytes | Gauge | Written data from block storage by the worker as reported by /proc/<PID>/io (bytes) | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/disk.go)
oasis_node_mem_rss_anon_bytes | Gauge | Size of resident anonymous memory of worker as reported by /proc/<PID>/status (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go)
oasis_node_mem_rss_file_bytes | Gauge | Size of resident file mappings of worker as reported by /proc/<PID>/status (bytes) | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go)
oasis_node_mem_rss_shmem_bytes | Gauge | Size of resident shared memory of worker. | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go)
oasis_node_mem_vm_size_bytes | Gauge | Virtual memory size of worker (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/mem.go)
oasis_node_net_receive_bytes_total | Gauge | Received data for each network device as reported by /proc/net/dev (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go)
oasis_node_net_receive_packets_total | Gauge | Received data for each network device as reported by /proc/net/dev (packets). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go)
oasis_node_net_transmit_bytes_total | Gauge | Transmitted data for each network device as reported by /proc/net/dev (bytes). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go)
oasis_node_net_transmit_packets_total | Gauge | Transmitted data for each network device as reported by /proc/net/dev (packets). | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/net.go)
oasis_registry_entities | Gauge | Number of registry entities. | [registry](../../go/registry/metrics.go)
oasis_registry_nodes | Gauge | Number of registry nodes. | [registry](../../go/registry/metrics.go)
oasis_registry_runtimes | Gauge | Number of registry runtimes. | [registry](../../go/registry/metrics.go)
oasis_roothash_block_interval | Summary | Time between roothash blocks (seconds). | [roothash](../../go/roothash/metrics.go)
oasis_storage_failures | Counter | Number of storage failures. | [storage](../../go/storage/metrics.go)
oasis_storage_latency | Summary | Storage call latency (seconds). | [storage](../../go/storage/metrics.go)
oasis_storage_successes | Counter | Number of storage successes. | [storage](../../go/storage/metrics.go)
oasis_storage_value_size | Summary | Storage call value size (bytes). | [storage](../../go/storage/metrics.go)
oasis_up | Gauge | Is oasis-test-runner active for specific test. | [oasis-node/cmd/common/metrics](../../go/oasis-node/cmd/common/metrics/metrics.go)
oasis_worker_aborted_batch_count | Counter | Number of aborted batches. | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_aborted_merge_count | Counter | Number of aborted merges. | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go)
oasis_worker_batch_processing_time | Summary | Time it takes for a batch to finalize (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_batch_read_time | Summary | Time it takes to read a batch from storage (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_batch_runtime_processing_time | Summary | Time it takes for a batch to be processed by the runtime (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_batch_size | Summary | Number of transactions in a batch. | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_epoch_number | Gauge | Current epoch number as seen by the worker. | [worker/common/committee](../../go/worker/common/committee/node.go)
oasis_worker_epoch_transition_count | Counter | Number of epoch transitions. | [worker/common/committee](../../go/worker/common/committee/node.go)
oasis_worker_execution_discrepancy_detected_count | Counter | Number of detected execute discrepancies. | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_failed_round_count | Counter | Number of failed roothash rounds. | [worker/common/committee](../../go/worker/common/committee/node.go)
oasis_worker_inconsistent_merge_root_count | Counter | Number of inconsistent merge roots. | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go)
oasis_worker_merge_discrepancy_detected_count | Counter | Number of detected merge discrepancies. | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go)
oasis_worker_node_registered | Gauge | Is oasis node registered (binary). | [worker/registration](../../go/worker/registration/worker.go)
oasis_worker_processed_block_count | Counter | Number of processed roothash blocks. | [worker/common/committee](../../go/worker/common/committee/node.go)
oasis_worker_processed_event_count | Counter | Number of processed roothash events. | [worker/common/committee](../../go/worker/common/committee/node.go)
oasis_worker_roothash_merge_commit_latency | Summary | Latency of roothash merge commit (seconds). | [worker/compute/merge/committee](../../go/worker/compute/merge/committee/node.go)
oasis_worker_storage_commit_latency | Summary | Latency of storage commit calls (state + outputs) (seconds). | [worker/compute/executor/committee](../../go/worker/compute/executor/committee/node.go)
oasis_worker_txnscheduler_incoming_queue_size | Gauge | Size of the incoming queue (number of entries). | [worker/compute/txnscheduler/committee](../../go/worker/compute/txnscheduler/committee/node.go)

<!-- markdownlint-enable line-length -->

Expand Down
2 changes: 0 additions & 2 deletions go/extra/extract-metrics/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import (
"path/filepath"
"regexp"
"sort"
"strconv"
"strings"

"github.com/spf13/cobra"
Expand Down Expand Up @@ -74,7 +73,6 @@ func markdownTable(metrics map[string]Metric) string {
pkg, _ := filepath.Rel(viper.GetString(CfgCodebasePath), m.Filename)
pkg = filepath.Dir(pkg)
fileURL, _ := filepath.Rel(tplDir, m.Filename)
fileURL += "#L" + strconv.Itoa(m.Line)
desc := html.EscapeString(m.Help)

mdTable += fmt.Sprintf("%s | %s | %s | [%s](%s)\n", m.Name, m.Type, desc,
Expand Down

0 comments on commit 2341d2b

Please sign in to comment.