You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-3Lines changed: 36 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,15 @@ Example .pgpass:
62
62
<pg_host>:5432:*:<pg_user>:<pg_password>
63
63
```
64
64
65
+
### InfluxDB
66
+
67
+
In order to use functions like `gxadmin meta influx-post`, `gxadmin` requires
68
+
a few environment variables to be set. Namely
69
+
*`INFLUX_URL`
70
+
*`INFLUX_PASS`
71
+
*`INFLUX_USER`
72
+
*`INFLUX_DB`
73
+
65
74
### GDPR
66
75
67
76
You may want to set `GDPR_MODE=1`. Please determine your own legal responsibilities, the authors take no responsibility for anything you may have done wrong.
@@ -136,6 +145,7 @@ Command | Description
136
145
[`meta iquery-grt-export`](docs/README.meta.md#meta-iquery-grt-export) | Export data from a GRT database for sending to influx
137
146
[`meta slurp-current`](docs/README.meta.md#meta-slurp-current) | Executes what used to be "Galaxy Slurp"
138
147
[`meta slurp-day`](docs/README.meta.md#meta-slurp-day) | Slurps data on a specific date.
148
+
[`meta slurp-initial`](docs/README.meta.md#meta-slurp-initial) | Slurps data starting at the first date until the second date.
139
149
[`meta slurp-upto`](docs/README.meta.md#meta-slurp-upto) | Slurps data up to a specific date.
140
150
[`meta update`](docs/README.meta.md#meta-update) | Update the script
141
151
[`meta whatsnew`](docs/README.meta.md#meta-whatsnew) | What's new in this version of gxadmin
@@ -147,22 +157,27 @@ Command | Description
147
157
[`mutate approve-user`](docs/README.mutate.md#mutate-approve-user) | Approve a user in the database
148
158
[`mutate assign-unassigned-workflows`](docs/README.mutate.md#mutate-assign-unassigned-workflows) | Randomly assigns unassigned workflows to handlers. Workaround for galaxyproject/galaxy#8209
149
159
[`mutate delete-group-role`](docs/README.mutate.md#mutate-delete-group-role) | Remove the group, role, and any user-group + user-role associations
160
+
[`mutate drop-extraneous-workflow-step-output-associations`](docs/README.mutate.md#mutate-drop-extraneous-workflow-step-output-associations) | #8418, drop extraneous connection
150
161
[`mutate fail-history`](docs/README.mutate.md#mutate-fail-history) | Mark all jobs within a history to state error
151
162
[`mutate fail-job`](docs/README.mutate.md#mutate-fail-job) | Sets a job state to error
152
163
[`mutate fail-terminal-datasets`](docs/README.mutate.md#mutate-fail-terminal-datasets) | Causes the output datasets of jobs which were manually failed, to be marked as failed
153
164
[`mutate oidc-role-find-affected`](docs/README.mutate.md#mutate-oidc-role-find-affected) | Find users affected by galaxyproject/galaxy#8244
154
165
[`mutate oidc-role-fix`](docs/README.mutate.md#mutate-oidc-role-fix) | Fix permissions for users logged in via OIDC. Workaround for galaxyproject/galaxy#8244
166
+
[`mutate reassign-job-to-handler`](docs/README.mutate.md#mutate-reassign-job-to-handler) | Reassign a job to a different handler
167
+
[`mutate reassign-workflows-to-handler`](docs/README.mutate.md#mutate-reassign-workflows-to-handler) | Reassign workflows in 'new' state to a different handler.
155
168
156
169
### query
157
170
158
171
Command | Description
159
172
------- | -----------
160
-
`query active-users` | Deprecated, use monthly-users-active
161
173
[`query collection-usage`](docs/README.query.md#query-collection-usage) | Information about how many collections of various types are used
174
+
[`query data-origin-distribution`](docs/README.query.md#query-data-origin-distribution) | data sources (uploaded vs derived)
175
+
[`query data-origin-distribution-summary`](docs/README.query.md#query-data-origin-distribution-summary) | breakdown of data sources (uploaded vs derived)
162
176
[`query datasets-created-daily`](docs/README.query.md#query-datasets-created-daily) | The min/max/average/p95/p99 of total size of datasets created in a single day.
163
177
[`query disk-usage`](docs/README.query.md#query-disk-usage) | Disk usage per object store.
164
178
[`query errored-jobs`](docs/README.query.md#query-errored-jobs) | Lists jobs that errored in the last N hours.
165
179
[`query group-cpu-seconds`](docs/README.query.md#query-group-cpu-seconds) | Retrieve an approximation of the CPU time in seconds for group(s)
180
+
[`query group-gpu-time`](docs/README.query.md#query-group-gpu-time) | Retrieve an approximation of the GPU time for users
166
181
[`query groups-list`](docs/README.query.md#query-groups-list) | List all groups known to Galaxy
167
182
[`query hdca-datasets`](docs/README.query.md#query-hdca-datasets) | List of files in a dataset collection
168
183
[`query hdca-info`](docs/README.query.md#query-hdca-info) | Information on a dataset collection
@@ -171,6 +186,7 @@ Command | Description
171
186
[`query history-runtime-system`](docs/README.query.md#query-history-runtime-system) | Sum of runtimes by all jobs in a history
172
187
[`query history-runtime-wallclock`](docs/README.query.md#query-history-runtime-wallclock) | Time as elapsed by a clock on the wall
173
188
[`query job-history`](docs/README.query.md#query-job-history) | Job state history for a specific job
189
+
[`query job-info`](docs/README.query.md#query-job-info) | Retrieve information about jobs given some job IDs
174
190
[`query job-inputs`](docs/README.query.md#query-job-inputs) | Input datasets to a specific job
175
191
[`query job-outputs`](docs/README.query.md#query-job-outputs) | Output datasets from a specific job
176
192
[`query jobs-max-by-cpu-hours`](docs/README.query.md#query-jobs-max-by-cpu-hours) | Top 10 jobs by CPU hours consumed (requires CGroups metrics)
[`query monthly-cpu-years`](docs/README.query.md#query-monthly-cpu-years) | CPU years allocated to tools by month
185
201
[`query monthly-data`](docs/README.query.md#query-monthly-data) | Number of active users per month, running jobs
202
+
[`query monthly-gpu-years`](docs/README.query.md#query-monthly-gpu-years) | GPU years allocated to tools by month
186
203
[`query monthly-jobs`](docs/README.query.md#query-monthly-jobs) | Number of jobs run each month
187
204
[`query monthly-users-active`](docs/README.query.md#query-monthly-users-active) | Number of active users per month, running jobs
188
-
`query monthly-users` | Deprecated, use monthly-users-active
189
205
[`query monthly-users-registered`](docs/README.query.md#query-monthly-users-registered) | Number of users registered each month
190
206
[`query old-histories`](docs/README.query.md#query-old-histories) | Lists histories that haven't been updated (used) for <weeks>
207
+
[`query pg-cache-hit`](docs/README.query.md#query-pg-cache-hit) | Check postgres in-memory cache hit ratio
208
+
[`query pg-index-size`](docs/README.query.md#query-pg-index-size) | show table and index bloat in your database ordered by most wasteful
209
+
[`query pg-index-usage`](docs/README.query.md#query-pg-index-usage) | calculates your index hit rate (effective databases are at 99% and up)
210
+
[`query pg-long-running-queries`](docs/README.query.md#query-pg-long-running-queries) | show all queries longer than five minutes by descending duration
211
+
[`query pg-mandelbrot`](docs/README.query.md#query-pg-mandelbrot) | show the mandlebrot set
212
+
[`query pg-stat-bgwriter`](docs/README.query.md#query-pg-stat-bgwriter) | Stats about the behaviour of the bgwriter, checkpoints, buffers, etc.
213
+
[`query pg-stat-user-tables`](docs/README.query.md#query-pg-stat-user-tables) | stats about tables (tuples, index scans, vacuums, analyzes)
214
+
[`query pg-table-bloat`](docs/README.query.md#query-pg-table-bloat) | show table and index bloat in your database ordered by most wasteful
215
+
[`query pg-table-size`](docs/README.query.md#query-pg-table-size) | show the size of the tables (excluding indexes), descending by size
216
+
[`query pg-unused-indexes`](docs/README.query.md#query-pg-unused-indexes) | show unused and almost unused indexes
217
+
[`query pg-vacuum-stats`](docs/README.query.md#query-pg-vacuum-stats) | show dead rows and whether an automatic vacuum is expected to be triggered
191
218
[`query queue`](docs/README.query.md#query-queue) | Brief overview of currently running jobs
192
219
[`query queue-detail`](docs/README.query.md#query-queue-detail) | Detailed overview of running and queued jobs
220
+
[`query queue-detail-by-handler`](docs/README.query.md#query-queue-detail-by-handler) | List jobs for a specific handler
193
221
[`query queue-overview`](docs/README.query.md#query-queue-overview) | View used mostly for monitoring
194
222
[`query queue-time`](docs/README.query.md#query-queue-time) | The average/95%/99% a specific tool spends in queue state.
195
223
[`query recent-jobs`](docs/README.query.md#query-recent-jobs) | Jobs run in the past <hours> (in any state)
196
224
[`query runtime-per-user`](docs/README.query.md#query-runtime-per-user) | computation time of user (by email)
225
+
[`query server-groups-allocated-cpu`](docs/README.query.md#query-server-groups-allocated-cpu) | Retrieve an approximation of the CPU allocation for groups
226
+
[`query server-groups-allocated-gpu`](docs/README.query.md#query-server-groups-allocated-gpu) | Retrieve an approximation of the GPU allocation for groups
227
+
[`query server-groups-disk-usage`](docs/README.query.md#query-server-groups-disk-usage) | Retrieve an approximation of the disk usage for groups
197
228
[`query tool-available-metrics`](docs/README.query.md#query-tool-available-metrics) | list all available metrics for a given tool
198
229
[`query tool-errors`](docs/README.query.md#query-tool-errors) | Summarize percent of tool runs in error over the past weeks for all tools that have failed (most popular tools first)
199
230
[`query tool-last-used-date`](docs/README.query.md#query-tool-last-used-date) | When was the most recent invocation of every tool
@@ -209,7 +240,10 @@ Command | Description
209
240
[`query ts-repos`](docs/README.query.md#query-ts-repos) | Counts of toolshed repositories by toolshed and owner.
210
241
[`query upload-gb-in-past-hour`](docs/README.query.md#query-upload-gb-in-past-hour) | Sum in bytes of files uploaded in the past hour
211
242
[`query user-cpu-years`](docs/README.query.md#query-user-cpu-years) | CPU years allocated to tools by user
243
+
[`query user-disk-quota`](docs/README.query.md#query-user-disk-quota) | Retrieves the 50 users with the largest quotas
212
244
[`query user-disk-usage`](docs/README.query.md#query-user-disk-usage) | Retrieve an approximation of the disk usage for users
245
+
[`query user-gpu-years`](docs/README.query.md#query-user-gpu-years) | GPU years allocated to tools by user
246
+
[`query user-history-list`](docs/README.query.md#query-user-history-list) | Shows the ID of the history, it's size and when it was last updated.
213
247
[`query user-recent-aggregate-jobs`](docs/README.query.md#query-user-recent-aggregate-jobs) | Show aggregate information for jobs in past N days for user
214
248
[`query users-count`](docs/README.query.md#query-users-count) | Shows sums of active/external/deleted/purged accounts
215
249
[`query users-total`](docs/README.query.md#query-users-total) | Total number of Galaxy users (incl deleted, purged, inactive)
@@ -235,7 +269,6 @@ Command | Description
235
269
[`uwsgi memory`](docs/README.uwsgi.md#uwsgi-memory) | Current system memory usage
236
270
[`uwsgi pids`](docs/README.uwsgi.md#uwsgi-pids) | Galaxy process PIDs
237
271
[`uwsgi stats-influx`](docs/README.uwsgi.md#uwsgi-stats-influx) | InfluxDB formatted output for the current stats
238
-
`uwsgi stats_influx` | Deprecated, use uwsgi stats-influx
Copy file name to clipboardExpand all lines: docs/README.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,15 @@ Example .pgpass:
62
62
<pg_host>:5432:*:<pg_user>:<pg_password>
63
63
```
64
64
65
+
### InfluxDB
66
+
67
+
In order to use functions like `gxadmin meta influx-post`, `gxadmin` requires
68
+
a few environment variables to be set. Namely
69
+
*`INFLUX_URL`
70
+
*`INFLUX_PASS`
71
+
*`INFLUX_USER`
72
+
*`INFLUX_DB`
73
+
65
74
### GDPR
66
75
67
76
You may want to set `GDPR_MODE=1`. Please determine your own legal responsibilities, the authors take no responsibility for anything you may have done wrong.
Copy file name to clipboardExpand all lines: docs/README.mutate.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,14 @@ Command | Description
5
5
[`mutate approve-user`](#mutate-approve-user) | Approve a user in the database
6
6
[`mutate assign-unassigned-workflows`](#mutate-assign-unassigned-workflows) | Randomly assigns unassigned workflows to handlers. Workaround for galaxyproject/galaxy#8209
7
7
[`mutate delete-group-role`](#mutate-delete-group-role) | Remove the group, role, and any user-group + user-role associations
8
+
[`mutate drop-extraneous-workflow-step-output-associations`](#mutate-drop-extraneous-workflow-step-output-associations) | #8418, drop extraneous connection
8
9
[`mutate fail-history`](#mutate-fail-history) | Mark all jobs within a history to state error
9
10
[`mutate fail-job`](#mutate-fail-job) | Sets a job state to error
10
11
[`mutate fail-terminal-datasets`](#mutate-fail-terminal-datasets) | Causes the output datasets of jobs which were manually failed, to be marked as failed
11
12
[`mutate oidc-role-find-affected`](#mutate-oidc-role-find-affected) | Find users affected by galaxyproject/galaxy#8244
12
13
[`mutate oidc-role-fix`](#mutate-oidc-role-fix) | Fix permissions for users logged in via OIDC. Workaround for galaxyproject/galaxy#8244
14
+
[`mutate reassign-job-to-handler`](#mutate-reassign-job-to-handler) | Reassign a job to a different handler
15
+
[`mutate reassign-workflows-to-handler`](#mutate-reassign-workflows-to-handler) | Reassign workflows in 'new' state to a different handler.
13
16
14
17
## mutate approve-user
15
18
@@ -54,6 +57,26 @@ mutate delete-group-role - Remove the group, role, and any user-group + user-ro
0 commit comments