summaryrefslogtreecommitdiffstats
path: root/Documentation/cmd-show-caches.txt
blob: 6a1f554c628f956fbd8eef006e2c7847cebd462e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
= gerrit show-caches

== NAME
gerrit show-caches - Display current cache statistics

== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit show-caches_
  [--gc]
  [--show-jvm]
--

== DESCRIPTION
Display statistics about the size and hit ratio of in-memory caches.

== OPTIONS
--gc::
	Request Java garbage collection before displaying information
	about the Java memory heap.

--show-jvm::
	List the name and version of the Java virtual machine, host
	operating system, and other details about the environment
	that Gerrit Code Review is running in.

--show-threads::
	Show detailed counts for Gerrit specific threads.

--width::
-w::
	Width of the output table.

== ACCESS
The caller must be a member of a group that is granted one of the
following capabilities:

* link:access-control.html#capability_viewCaches[View Caches]
* link:access-control.html#capability_maintainServer[Maintain Server]
* link:access-control.html#capability_administrateServer[Administrate Server]

The summary information about SSH, threads, tasks, memory and JVM are
only printed out if the caller is a member of a group that is granted
the link:access-control.html#capability_administrateServer[Administrate
Server] or link:access-control.html#capability_maintainServer[Maintain
Server] capability.

== SCRIPTING
Intended for interactive use only.

== EXAMPLES

----
  $ ssh -p 29418 review.example.com gerrit show-caches
  Gerrit Code Review        2.9                       now   11:14:13   CEST
                                                   uptime    6 days 20 hrs
    Name                          |Entries              |  AvgGet |Hit Ratio|
                                  |   Mem   Disk   Space|         |Mem  Disk|
  --------------------------------+---------------------+---------+---------+
    accounts                      |  4096               |   3.4ms | 99%     |
    adv_bases                     |                     |         |         |
    changes                       |                     |  27.1ms |  0%     |
    groups                        |  5646               |  11.8ms | 97%     |
    groups_bymember               |                     |         |         |
    groups_byname                 |                     |         |         |
    groups_bysubgroup             |   230               |   2.4ms | 62%     |
    groups_byuuid                 |  5612               |  29.2ms | 99%     |
    groups_external               |     1               |   1.5s  | 98%     |
    groups_subgroups              |  5714               |  19.7ms | 99%     |
    ldap_group_existence          |                     |         |         |
    ldap_groups                   |   650               | 680.5ms | 99%     |
    ldap_groups_byinclude         |  1024               |         | 83%     |
    ldap_usernames                |   390               |   3.8ms | 81%     |
    permission_sort               | 16384               |         | 99%     |
    plugin_resources              |                     |         |         |
    project_list                  |     1               |   3.8s  | 99%     |
    projects                      |  6477               |   2.9ms | 99%     |
    sshkeys                       |  2048               |  12.5ms | 99%     |
  D diff                          |  1299  62033 132.36m|  22.0ms | 85%  99%|
  D diff_intraline                | 12777 218651 128.45m| 171.1ms | 31%  96%|
  D git_tags                      |     3      6  11.85k|         |  0% 100%|
  D web_sessions                  |  1024 151714  59.10m|         | 99%  57%|

  SSH:    385  users, oldest session started    6 days 20 hrs ago
  Tasks:   10  total =    6 running +      0 ready +    4 sleeping
  Mem:  14.94g total =   3.04g used +  11.89g free +  10.00m buffers
        28.44g max
           107 open files

  Threads: 4 CPUs available, 371 threads
----

== SEE ALSO

* link:cmd-flush-caches.html[gerrit flush-caches]
* link:config-gerrit.html#cache[Cache Configuration]
* link:config-gerrit.html#cache_names[Standard Caches]

GERRIT
------
Part of link:index.html[Gerrit Code Review]

SEARCHBOX
---------