David Pursehouse | 8ad1173 | 2016-08-29 15:00:14 +0900 | [diff] [blame] | 1 | = Gerrit Code Review - Metrics |
| 2 | |
| 3 | Metrics about Gerrit's internal state can be sent to external monitoring systems |
| 4 | via plugins. See the link:dev-plugins.html#metrics[plugin documentation] for |
| 5 | details of plugin implementations. |
| 6 | |
| 7 | == Metrics |
| 8 | |
| 9 | The following metrics are reported. |
| 10 | |
| 11 | === General |
| 12 | |
| 13 | * `build/label`: Version of Gerrit server software. |
| 14 | * `events`: Triggered events. |
| 15 | |
| 16 | === Process |
| 17 | |
| 18 | * `proc/birth_timestamp`: Time at which the Gerrit process started. |
| 19 | * `proc/uptime`: Uptime of the Gerrit process. |
| 20 | * `proc/cpu/usage`: CPU time used by the Gerrit process. |
| 21 | * `proc/num_open_fds`: Number of open file descriptors. |
| 22 | * `proc/jvm/memory/heap_committed`: Amount of memory guaranteed for user objects. |
| 23 | * `proc/jvm/memory/heap_used`: Amount of memory holding user objects. |
| 24 | * `proc/jvm/memory/non_heap_committed`: Amount of memory guaranteed for classes, |
| 25 | etc. |
| 26 | * `proc/jvm/memory/non_heap_used`: Amount of memory holding classes, etc. |
| 27 | * `proc/jvm/memory/object_pending_finalization_count`: Approximate number of |
| 28 | objects needing finalization. |
| 29 | * `proc/jvm/gc/count`: Number of GCs. |
| 30 | * `proc/jvm/gc/time`: Approximate accumulated GC elapsed time. |
| 31 | * `proc/jvm/thread/num_live`: Current live thread count. |
| 32 | |
| 33 | === Caches |
| 34 | |
| 35 | * `caches/memory_cached`: Memory entries. |
| 36 | * `caches/memory_hit_ratio`: Memory hit ratio. |
| 37 | * `caches/memory_eviction_count`: Memory eviction count. |
| 38 | * `caches/disk_cached`: Disk entries used by persistent cache. |
| 39 | * `caches/disk_hit_ratio`: Disk hit ratio for persistent cache. |
| 40 | |
| 41 | === HTTP |
| 42 | |
| 43 | * `http/server/error_count`: Rate of REST API error responses. |
| 44 | * `http/server/success_count`: Rate of REST API success responses. |
| 45 | * `http/server/rest_api/count`: Rate of REST API calls by view. |
| 46 | * `http/server/rest_api/error_count`: Rate of REST API calls by view. |
| 47 | * `http/server/rest_api/server_latency`: REST API call latency by view. |
| 48 | * `http/server/rest_api/response_bytes`: Size of REST API response on network |
| 49 | (may be gzip compressed) by view. |
| 50 | |
| 51 | === Query |
| 52 | |
| 53 | * `query/query_latency`: Successful query latency, accumulated over the life |
| 54 | of the process. |
| 55 | |
| 56 | === SSH sessions |
| 57 | |
| 58 | * `sshd/sessions/connected`: Number of currently connected SSH sessions. |
| 59 | * `sshd/sessions/created`: Rate of new SSH sessions. |
| 60 | * `sshd/sessions/authentication_failures`: Rate of SSH authentication failures. |
| 61 | |
| 62 | === SQL connections |
| 63 | |
| 64 | * `sql/connection_pool/connections`: SQL database connections. |
| 65 | |
| 66 | === JGit |
| 67 | |
| 68 | * `jgit/block_cache/cache_used`: Bytes of memory retained in JGit block cache. |
| 69 | * `jgit/block_cache/open_files`: File handles held open by JGit block cache. |
| 70 | |
| 71 | === Git |
| 72 | |
| 73 | * `git/upload-pack/request_count`: Total number of git-upload-pack requests. |
| 74 | * `git/upload-pack/phase_counting`: Time spent in the 'Counting...' phase. |
| 75 | * `git/upload-pack/phase_compressing`: Time spent in the 'Compressing...' phase. |
| 76 | * `git/upload-pack/phase_writing`: Time spent transferring bytes to client. |
| 77 | * `git/upload-pack/pack_bytes`: Distribution of sizes of packs sent to clients. |
| 78 | |
Edwin Kempin | 516167d | 2016-11-25 14:42:11 +0100 | [diff] [blame] | 79 | === BatchUpdate |
| 80 | |
| 81 | * `batch_update/execute_change_ops`: BatchUpdate change update latency, |
| 82 | excluding reindexing |
| 83 | |
David Pursehouse | 8ad1173 | 2016-08-29 15:00:14 +0900 | [diff] [blame] | 84 | === NoteDb |
| 85 | |
| 86 | * `notedb/update_latency`: NoteDb update latency by table. |
| 87 | * `notedb/stage_update_latency`: Latency for staging updates to NoteDb by table. |
| 88 | * `notedb/read_latency`: NoteDb read latency by table. |
| 89 | * `notedb/parse_latency`: NoteDb parse latency by table. |
| 90 | * `notedb/auto_rebuild_latency`: NoteDb auto-rebuilding latency by table. |
| 91 | * `notedb/auto_rebuild_failure_count`: NoteDb auto-rebuilding attempts that |
| 92 | failed by table. |
Edwin Kempin | 69608c4 | 2017-03-30 17:20:22 +0200 | [diff] [blame] | 93 | * `notedb/external_id_update_count`: Total number of external ID updates. |
| 94 | * `notedb/read_all_external_ids_latency`: Latency for reading all |
| 95 | external ID's from NoteDb. |
David Pursehouse | 8ad1173 | 2016-08-29 15:00:14 +0900 | [diff] [blame] | 96 | |
Edwin Kempin | f68598a | 2016-11-15 17:38:49 -0800 | [diff] [blame] | 97 | === Reviewer Suggestion |
| 98 | |
| 99 | * `reviewer_suggestion/query_accounts`: Latency for querying accounts for |
| 100 | reviewer suggestion. |
| 101 | * `reviewer_suggestion/recommend_accounts`: Latency for recommending accounts |
| 102 | for reviewer suggestion. |
| 103 | * `reviewer_suggestion/load_accounts`: Latency for loading accounts for |
| 104 | reviewer suggestion. |
| 105 | * `reviewer_suggestion/query_groups`: Latency for querying groups for reviewer |
| 106 | suggestion. |
| 107 | |
David Pursehouse | 8ad1173 | 2016-08-29 15:00:14 +0900 | [diff] [blame] | 108 | === Replication Plugin |
| 109 | |
| 110 | * `plugins/replication/replication_latency`: Time spent pushing to remote |
| 111 | destination. |
| 112 | * `plugins/replication/replication_delay`: Time spent waiting before pushing to |
| 113 | remote destination. |
| 114 | * `plugins/replication/replication_retries`: Number of retries when pushing to |
| 115 | remote destination. |
| 116 | |
Minh Thai | 44e95ee | 2017-02-28 17:39:37 -0800 | [diff] [blame] | 117 | === License |
| 118 | |
| 119 | * `license/cla_check_count`: Total number of CLA check requests. |
| 120 | |
David Pursehouse | 8ad1173 | 2016-08-29 15:00:14 +0900 | [diff] [blame] | 121 | GERRIT |
| 122 | ------ |
| 123 | Part of link:index.html[Gerrit Code Review] |
| 124 | |
| 125 | SEARCHBOX |
| 126 | --------- |