backtrace-morgue

{ "name": "backtrace-labs/backtrace-morgue", "version": "0.1.4", "libraries": { "xv": "^1.1.25" }, "title": "", "branch": "", "style": { "name": "Default", "componentSet": { "nav": "nav/BasicNav", "header": "header/BannerHeader", "article": "article/BasicArticle", "footer": "footer/BasicFooter" }, "fontFamily": "-apple-system, BlinkMacSystemFont, sans-serif", "fontWeight": 400, "bold": 600, "lineHeight": 1.5, "typeScale": [ 72, 48, 24, 20, 16, 14, 12 ], "monospace": "Menlo, monospace", "heading": { "fontFamily": null, "fontStyle": null, "fontWeight": 600, "lineHeight": 1.25, "textTransform": null, "letterSpacing": null }, "h0": {}, "h1": {}, "h2": {}, "h3": {}, "h4": {}, "h5": {}, "h6": {}, "alternativeText": {}, "space": [ 0, 8, 16, 32, 48, 64, 96 ], "layout": { "maxWidth": 1024, "centered": false }, "colors": { "text": "#111", "background": "#fff", "primary": "#08e", "secondary": "#059", "highlight": "#e08", "border": "#ddd", "muted": "#eee" }, "border": { "width": 1, "radius": 2 }, "link": {}, "button": { "hover": { "boxShadow": "inset 0 0 0 999px rgba(0, 0, 0, .125)" } }, "input": {}, "body": { "margin": 0 }, "breakpoints": { "xs": "@media screen and (max-width:40em)", "sm": "@media screen and (min-width:40em)", "md": "@media screen and (min-width:52em)", "lg": "@media screen and (min-width:64em)" } }, "content": [ { "component": "nav", "links": [ { "href": "https://github.com/backtrace-labs/backtrace-morgue", "text": "GitHub" }, { "href": "https://npmjs.com/package/backtrace-morgue", "text": "npm" } ] }, { "component": "header", "heading": "backtrace-morgue", "subhead": "Object store client.", "children": [ { "component": "ui/TweetButton", "text": "backtrace-morgue: Object store client.", "url": null }, { "component": "ui/GithubButton", "user": "backtrace-labs", "repo": "backtrace-morgue" } ], "text": "v1.7.1" }, { "component": "article", "metadata": { "source": "github.readme" }, "html": "<h1>morgue</h1>\n<h2>Installation</h2>\nIt is recommended to install <code>morgue</code> using <code>npm</code>.\n<pre>npm install backtrace-morgue -g</pre>If you working from the repository, then instead use the following command.\n<pre>npm install -g</pre>This will install the <code>morgue</code> tool in your configured path. Refer to the\n<code>morgue --help</code> command to learn more.\n<h2>Introduction</h2>\n<code>morgue</code> is a command-line interface to the Backtrace object store. It allows\nyou to upload, download and issue queries on objects with-in the object store.\n<h2>Usage</h2>\n<h3>login</h3>\n<pre>Usage: morgue login <url></pre>The first step to using <code>morgue</code> is to log into a server.\n<pre>$ morgue login http://localhost\nUser: sbahra\nPassword: **************\n\nLogged in.</pre>At this point, you are able to issue queries.\n<h3>describe</h3>\n<pre>Usage: morgue describe <[<universe>/]project> [substring]</pre>Requests a list and description of all metadata that can be queried against.\n<h4>Example</h4>\n<pre>$ morgue describe bidder uname\n uname.machine: machine hardware name\n uname.release: kernel release\n uname.sysname: kernel name\n uname.version: kernel version</pre><h3>get</h3>\n<pre>Usage: morgue get <[<universe>/]project> [options] <object id> [-o <output file>]</pre>Downloads the specified object from the Backtrace object store and prints\nto standard output. Optionally, output the file to disk.\nThe following options are available:\n<table>\n<thead>\n<tr>\n<th>Option</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>--resource=name</code></td>\n<td>Fetch the specified resource rather than the object.</td>\n</tr>\n</tbody>\n</table>\n<h3>put</h3>\n<pre>Usage: morgue put <[<universe>/]project> <file> <--format=btt|minidump|json|symbols> [options]</pre>Uploads object file to the Backtrace object store. User has the following options\n<table>\n<thead>\n<tr>\n<th>Option</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>`--compression=gzip</td>\n<td>deflate`</td>\n<td>uploaded file is compressed</td>\n</tr>\n<tr>\n<td><code>--kv=key1:value1,key2:value2,...</code></td>\n<td>upload key-values</td>\n</tr>\n<tr>\n<td><code>--form_data</code></td>\n<td>upload file by multipart/form-data post request</td>\n</tr>\n</tbody>\n</table>\n<h3>modify</h3>\n<pre>Usage: morgue modify <[universe/]project> (<query>|<object> ...) [--set ...] [--clear ...]</pre>Modifies attributes of the given object in the manner specified.\nBoth options below may be specified more than once.\n<table>\n<thead>\n<tr>\n<th>Option</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>--set</code></td>\n<td>Set the given <code>attribute=value</code> pair</td>\n</tr>\n<tr>\n<td><code>--clear</code></td>\n<td>Clear the given <code>attribute</code></td>\n</tr>\n</tbody>\n</table>\nYou are also able to modify multiple objects by specifying filters. The\n<code>--filter</code>, <code>--age</code> and <code>--time</code> arguments are accepted to modify.\n<h4>Example</h4>\nSet hostname to <code>fqdn.example.com</code> for object identifier 0.\n<pre>$ morgue modify --set hostname=fqdn.example.com myproject 0</pre>Set custom attribute <code>reason</code> to <code>oom</code> for all crashes containing <code>memory_abort</code>.\n<pre>$ morgue modify --set reason=oom --filter=callstack,regular-expression,memory_abort</pre><h3>attachment</h3>\n<pre>Usage: morgue attachment <add|get|list|delete> ...\n\n morgue attachment add [options] <[universe/]project> <oid> <filename>\n\n --content-type=CT Specify Content-Type for attachment.\n The server may auto-detect this.\n --attachment-name=N Use this name for the attachment name.\n Default is the same as the filename.\n\n morgue attachment get [options] <[universe/]project> <oid>\n\n Must specify one of:\n --attachment-id=ID Attachment ID to delete.\n --attachment-name=N Attachment name to delete.\n\n morgue attachment list [options] <[universe/]project> <oid>\n\n morgue attachment delete [options] <[universe/]project <oid>\n\n Must specify one of:\n --attachment-id=ID Attachment ID to delete.\n --attachment-name=N Attachment name to delete.</pre>Manage attachments associated with an object.\n<h3>list</h3>\nAllows you to perform queries on object metadata. You can perform\neither selection queries or aggregation queries, but not both at the\nsame time.\n<pre>Usage: morgue list <[<universe>/]project> [substring]</pre>You may pass <code>--verbose</code> in order to get more detailed query performance\ndata.\n<h4>Filters</h4>\nThe filter option expects a comma-delimited list of the form\n<code><attribute>,<operation>,<value></code>.\nThe currently supported operations are <code>equal</code>, <code>regular-expression</code>,\n<code>inverse-regular-expression</code>, <code>at-least</code>, <code>greater-than</code>, <code>at-most</code>,\n<code>less-than</code>, <code>contains</code>, <code>not-contains</code>, <code>is-set</code>, and <code>is-not-set</code>.\n<h4>Pagination</h4>\nPagination is handled with two flags\n<code>--limit=<n></code> controls the number of returned rows. <code>--offset=<n></code> controls the\noffset at which rows are returned, another way to put it is that it skips the\nfirst <code><n></code> rows.\n<h4>Aggregations</h4>\nAggregation is expressed through a myriad of command-line options that express\ndifferent aggregation operations. Options are of form <code>--<option>=<attribute></code>.\nThe <code>*</code> factor is used when aggregations are performed when no factor is\nspecified or if an object does not have a valid value associated with the\nfactor.\n<table>\n<thead>\n<tr>\n<th>Option</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>--age</code></td>\n<td>Specify a relative timestamp to now. <code>1h</code> ago, or <code>1d</code> ago.</td>\n</tr>\n<tr>\n<td><code>--time</code></td>\n<td>Specify a range using <a href=\"https://github.com/wanasit/chrono#readme\">Chrono</a>.</td>\n</tr>\n<tr>\n<td><code>--unique</code></td>\n<td>provide a count of distinct values</td>\n</tr>\n<tr>\n<td><code>--histogram</code></td>\n<td>provide all distinct values</td>\n</tr>\n<tr>\n<td><code>--distribution</code></td>\n<td>provide a truncated histogram</td>\n</tr>\n<tr>\n<td><code>--mean</code></td>\n<td>calculate the mean of a column</td>\n</tr>\n<tr>\n<td><code>--sum</code></td>\n<td>sum all values</td>\n</tr>\n<tr>\n<td><code>--range</code></td>\n<td>provide the minimum and maximum values</td>\n</tr>\n<tr>\n<td><code>--count</code></td>\n<td>count all non-null values</td>\n</tr>\n<tr>\n<td><code>--bin</code></td>\n<td>provide a linear histogram of values</td>\n</tr>\n<tr>\n<td><code>--head</code></td>\n<td>provide the first value in a factor</td>\n</tr>\n<tr>\n<td><code>--tail</code></td>\n<td>provide the last value in a factor</td>\n</tr>\n<tr>\n<td><code>--object</code></td>\n<td>provide the maximum object identifier of a column</td>\n</tr>\n</tbody>\n</table>\n<h4>Sorting</h4>\nSorting of results is done with the stackable option <code>--sort=<term></code>. The term\nsyntax is <code>[-](<column>|<fold_term>)</code>.\n<ul>\n<li>The optional <code>-</code> reverse the sort term order to descending, otherwise it\ndefaults to ascending.</li>\n<li>The <code><column></code> term refers to a valid column in the table. This is only\neffective for selection type query, i.e. when using the <code>--select</code> option.</li>\n<li>The <code><fold_term></code> is an expression pointing to a fold operation. The\nexpression language for fold operation is one of the following literal:<ul>\n<li><code>;group</code>: sort by the group key itself.</li>\n<li><code>;count</code>: sort by the group count (number of crashes).</li>\n<li><code>column;idx</code>: where <code>column</code> is a string referencing a column in the fold\ndictionary and <code>idx</code> is an indice in the array. See examples .</li>\n</ul>\n</li>\n</ul>\nMultiple sort terms can be provided to break ties in case the previous\nreferenced sort term has ties.\n<h4>Example</h4>\nRequest all faults from application deployments owned by jdoe.\nProvide the timestamp, hostname, callstack and classifiers.\n<pre>$ morgue list bidder --filter=tag_owner,equal,jdoe --select=timestamp --select=hostname --select=callstack --select=classifiers\n*\n#9d33 Thu Oct 13 2016 18:36:01 GMT-0400 (EDT) 5 months ago\n hostname: 2235.bm-bidderc.prod.nym2\n classifiers: abort stop\n callstack:\n assert ← int_set_union_all ← all_domain_lists ←\n setup_phase_unlocked ← bid_handler_slave_inner ← bid_handler_slave ←\n an_sched_process_task ← an_sched_slave ← event_base_loop ←\n an_sched_enter ← bidder_slave ← an_sched_pthread_cb\n#ef2f Thu Oct 13 2016 18:36:01 GMT-0400 (EDT) 5 months ago\n hostname: 2066.bm-impbus.prod.nym2\n classifiers: abort stop\n callstack:\n assert ← an_discovery_get_instances ← budget_init_discovery ←\n main\n#119bf Thu Oct 13 2016 18:36:01 GMT-0400 (EDT) 5 months ago\n hostname: 2066.bm-impbus.prod.nym2\n classifiers: abort stop\n callstack:\n assert ← an_discovery_get_instances ← budget_init_discovery ←\n main</pre>Request faults owned by jdoe, group them by fingerprint and aggregate\nthe number of unique hosts, display a histogram of affected versions and\nprovide a linear histogram of process age distribution.\n<pre>$ morgue list bidder --age=1y --factor=fingerprint --filter=tag_owner,equal,jdoe --head=callstack --unique=hostname --histogram=tag --bin=process.age\n823a55fb15bf697ba3041d736ade... ▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁ 5 months ago\nDate: Wed May 18 2016 18:44:35 GMT-0400 (EDT)\ncallstack:\n assert ← int_set_union_all ← all_domain_lists ←\n setup_phase_unlocked ← bid_handler_slave_inner ← bid_handler_slave ←\n an_sched_process_task ← an_sched_slave ← event_base_loop ←\n an_sched_enter ← bidder_slave ← an_sched_pthread_cb\nhistogram(tag):\n 8.20.4.adc783.0 ▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆ 1\nunique(hostname): 1\nbin(process.age):\n 7731 7732 ▆▆▆▆▆▆▆▆▆▆ 1\n\n3b851ac1ab1421409159cc38edb2... ▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁ 5 months ago\nDate: Tue May 17 2016 17:28:26 GMT-0400 (EDT)\n Tue May 17 2016 17:30:07 GMT-0400 (EDT)\ncallstack:\n assert ← an_discovery_get_instances ← budget_init_discovery ←\n main\nhistogram(tag):\n 4.44.0.adc783.1 ▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆▆ 2\nunique(hostname): 1\nbin(process.age):\n 23 24 ▆▆▆▆▆▆▆▆▆▆ 1\n 24 25 ▆▆▆▆▆▆▆▆▆▆ 1</pre>Request faults for the last 2 years, group them by fingerprint, show the first\nobject identifier in the group, sort the results by descending fingerprint,\nlimit the results to 5 faults and skip the first 10 (according to sort order).\n<pre>$ morgue list blackhole --age=2y --factor=fingerprint --object=fingerprint --limit=5 --offset=10 --sort="-;group"\nfec4bfecf8e077cf44024f5668fa... ▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 2 years ago\nFirst Occurrence: Tue Jan 12 2016 13:30:12 GMT-0500 (EST)\n Occurrences: 360\nobject(fingerprint): 1c653d\n\nfe7294a780a16e30b619e8d94a8a... █▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 2 years ago\nFirst Occurrence: Wed Oct 28 2015 11:30:47 GMT-0400 (EDT)\n Last Occurrence: Wed Oct 28 2015 12:16:19 GMT-0400 (EDT)\n Occurrences: 203\nobject(fingerprint): 1c23b3\n\nfe5e0dda6cf0fb996a521dde4087... ▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 1 year ago\nFirst Occurrence: Tue Jun 14 2016 11:54:35 GMT-0400 (EDT)\n Occurrences: 1\nobject(fingerprint): 2de5\n\nfe46d9af7c65c084091fed51ef02... █▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 2 years ago\nFirst Occurrence: Tue Oct 27 2015 16:59:34 GMT-0400 (EDT)\n Last Occurrence: Tue Oct 27 2015 20:05:30 GMT-0400 (EDT)\n Occurrences: 3\nobject(fingerprint): 8f41\n\nfdc0860ef6dfd3d0397b53043ab9... ▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 1 year ago\nFirst Occurrence: Tue Jun 07 2016 11:51:55 GMT-0400 (EDT)\n Occurrences: 211\nobject(fingerprint): 1c1958</pre>Request faults for the two years, group them by fingerprint, sum process.age,\nsort the results by descending sum of process.age per fingerprint, limit the\nresults to 3 faults. Note here that <code>1</code> in <code>-process.age;1</code> is the second\noperator (<code>--sum</code>) in this case.\n<pre>$ morgue list blackhole --age=2y --factor=fingerprint --first=process.age --sum=process.age --limit=3 --sort="-process.age;1"\nd9358a6fdb7eaa143254b6987d00... ▁▁▁▁▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 1 year ago\nFirst Occurrence: Tue Sep 20 2016 21:59:46 GMT-0400 (EDT)\n Last Occurrence: Tue Sep 20 2016 22:03:23 GMT-0400 (EDT)\n Occurrences: 38586\nsum(process.age): 56892098354615 sec\n\n524b9f988c8ff9dfc1b3a0c71231... ▁▁▁▁▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 1 year ago\nFirst Occurrence: Tue Sep 20 2016 22:01:52 GMT-0400 (EDT)\n Last Occurrence: Tue Sep 20 2016 22:03:19 GMT-0400 (EDT)\n Occurrences: 25737\nsum(process.age): 37947233900547 sec\n\nbffd05c6b745229fd1c648bbe2a7... ▁▁▁▁▁▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ 1 year ago\nFirst Occurrence: Tue Sep 20 2016 21:59:46 GMT-0400 (EDT)\n Last Occurrence: Tue Sep 20 2016 22:03:01 GMT-0400 (EDT)\n Occurrences: 20096\nsum(process.age): 29630010305216 sec</pre><h3>delete</h3>\nAllows deleting objects.\n<pre>Usage: morgue delete <[universe/]project> <oid1> [... oidN]</pre>Object IDs must be specified; they can be found in <code>morgue list</code> output.\nThe object ID printed in the example above is <code>9d33</code>.\nThe following options support partial deletes:\n<code>--physical-only</code>: Only delete the physical object; retain indexing.\n<code>--crdb-only</code>: Only delete the indexed data; requires physically deleted objects.\n<h3>flamegraph</h3>\n<pre>Usage: morgue flamegraph [--filter=<filter expression>] [--reverse] [--unique] [-o file.svg]</pre>Generate a flamegraph of callstacks of all objects matching the specified\nfilter criteria. The <code>--filter</code> option behaves identically to the <code>list</code>\nsub-command. This functionality requires <code>perl</code> to be installed.\nTo learn more about flamegraphs, please see\n<a href=\"http://www.brendangregg.com/flamegraphs.html\">http://www.brendangregg.com/flamegraphs.html</a>.\nUse <code>--unique</code> to only sample unique crashes. Use <code>--reverse</code> to begin sampling\nfrom leaf functions.\n<h3>report</h3>\nCreate and manage scheduled reports.\n<pre>Usage: morgue report <list | create | delete | send> [--project=...] [--universe=...]</pre><h4>create</h4>\n<pre>Usage: morgue report <project> create\n <--rcpt=...>\n <--title=...>\n [--filter=...]\n [--fingerprint=...]\n [--histogram=...]\n [--hour=...]\n [--day=...]\n --period=<week | day></pre>Example:\n<pre>$ morgue report MyProject create --rcpt=null@backtrace.io\n --rcpt=list@backtrace.io --filter=environment,equal,prod\n --title="Production Crashes weekly" --period=week</pre><h4>delete</h4>\n<pre>Usage: morgue report <project> delete <report integer identifier></pre><h4>list</h4>\n<pre>Usage: morgue report <project> list</pre><h3>repair</h3>\n<pre>Usage: morgue repair <[universe/]project></pre>Repair a project's attribute database. For each corrupted pages of a project's\nattribute database, reprocess the affected objects (if possible). Once\ncompleted and successful, transition the database into normal mode.\n<h3>reprocess</h3>\n<pre>Usage: morgue reprocess <[universe/]project> [<query>|<object> ...] [--first N] [--last N]\n\nOptions for reprocess:\n --first=N Specify the first object ID (default: earliest known)\n --last=N Specify the last object ID (default: most recent known)</pre>Reprocess the project's objects. This command can be used to re-execute\nindexing, fingerprinting, and symbolification (where needed).\nIf a set of objects (or query) is specified, any values for <code>--first</code> and\n<code>--last</code> are replaced to match the object list. If no query, object list,\nor range is provided, all objects in the project are reprocessed.\n<h3>retention</h3>\n<pre>Usage: morgue retention <list|set|status|clear> <name> [options]\n\nOptions for set/clear:\n --type=T Specify retention type (default: project)\n valid: instance, universe, project\n\nOptions for status:\n [--type=<universe|project> <name>]\n\nOptions for set:\n --max-age=N Specify time limit for objects, in seconds\n --physical-only Specifies that the policy only delete physical copies;\n indexing will be retained.</pre>Configure the retention policy for a given namespace, which can cover the\ncoroner instance, or a specific universe or project.\n<h4>Example</h4>\n<pre>$ morgue retention clear a_project\nsuccess\n$ morgue retention set blackhole --max-age=3600\n$ morgue retention list\nProject-level:\n blackhole: max age: 1h\n$</pre><h3>sampling</h3>\n<pre>Usage: morgue sampling <status|reset> [options]\n\nOptions for either status or reset:\n --fingerprint=group Specify a fingerprint to apply to.\n Without this, applies to all.\n --project=[universe/]project Specify a project to apply to.\n Without this, applies to all.\n\nOptions for status only:\n --max-groups=N Specify max number of groups to display\n per project.</pre>Retrieve the object sampling status, or reset it.\nProject is a required flag if fingerprint is specified.\n<h3>symbol</h3>\n<pre>Usage: morgue symbol <[<universe>/]project> [summary | list | missing | archives] [-o <output file>]</pre>Retrieve a list of uploaded symbols or symbol archives. By default, <code>morgue symbol</code>\nwill return a summary of uploaded archives, available symbols and missing symbols.\nIf <code>archives</code> is used, a list of uploaded, in-process and symbol processing errors\nare outputted. If <code>list</code> is used, then a list of uploaded symbols is returned. If\n<code>missing</code> is used, then the set of missing symbols for the project are included.\n<h3>scrubber</h3>\nCreate, modify and delete data scrubbers.\n<pre>Usage: morgue scrubber <project> <list | create | modify | delete></pre>Use <code>--name</code> to identify the scrubber. Use <code>--regexp</code> to specify the pattern to\nmatch and scrub. Use <code>--builtin</code> to specify a builtin scrubber, <code>ssn</code>, <code>ccn</code>,\n<code>key</code> and <code>env</code> are currently supported for social security number, credit card\nnumber, encryption key and environment variable. If <code>--builtin=all</code> in <code>create</code>\nsubcommand, all supported builtin scrubbers are created. <code>--regexp</code> and\n<code>--builtin</code> are mutually exclusive. Use <code>--enable</code> to activate the scrubber, 0\ndisables the scrubber while other integer values enable it.\n<h3>setup</h3>\n<pre>Usage: morgue setup <url></pre>If you are using an on-premise version of <code>coronerd</code>, use <code>morgue setup</code>\nto configure the initial organization and user. For example, if the server is\n<code>backtrace.mycompany.com</code>, then you would run <code>morgue setup http://backtrace.mycompany.com</code>.\nWe recommend resetting your password after you enable SSL (done by configuring\nyour certificates).\n<h3>nuke</h3>\n<pre>Usage: morgue nuke --universe=<universe name> [--project=<project name>]</pre>If you want to nuke an object and all of the dependencies of the object.\nDo not use this operation without making a back-up of your data.\n<h3>token</h3>\n<pre>Usage: morgue token [create | list | delete] [--project=...] [--universe=...]</pre><h4>create</h4>\n<pre>Usage: morgue token create --project=<project> --capability=<capability></pre>Capability can be any of:\n<ul>\n<li>symbol:post - Enable symbol uploads with the specified API token.</li>\n<li>error:post - Enable error and dump submission with the specified API token.</li>\n<li>query:post - Enable queries to be issued using the specified token.</li>\n<li>sync:post - Allow for slower but more verbose submission.</li>\n</ul>\nMultiple capabilities can be specified by using <code>--capability</code> multiple times\nor using a comma-separated list.\n<h4>list</h4>\n<pre>Usage: morgue token list [--universe=...] [--project=...]</pre>List API tokens in the specified universe, for all projects or a specified\nproject.\n<h4>delete</h4>\n<pre>Usage: morgue token delete <sha256 or prefix></pre>Delete the specified token by substring or exact match.\n<h3>user</h3>\n<pre>Usage: morgue user reset [--universe=...] [--user=...] [--password=...]</pre>Modify users.\nCurrently, can only be used to reset user passwords. Prompts for user and\npassword if either is not specified.\n<h3>tenant</h3>\nCreate isolated tenants for receiving error data and log in. Tenants provide\nnamespace isolation. Users in one tenant are unable to interact with any\nobjects outside of their tenant.\nThis is an enterprise feature and not enabled by default for self-serve\ncustomers. The tenant commands require superuser access.\n<pre>Usage: morgue tenant <list | create | delete>\n create <name>: Create a tenant with the specified name.\n delete <name>: Delete a tenant with the specified name.\n list: List all tenants on your instance.</pre><h4>Examples</h4>\n1.0 Create a Tenant\nAfter logging into an object store as a superuser, we are able to simply\ncreate a tenant using the following command:\n<pre>$ morgue tenant create testingxyz\nTenant successfully created at https://testingxyz.sp.backtrace.io\nWait a few minutes for propagation to complete.</pre>Tenants are required to be contained with-in the same TLD. For example,\na tenant of name <code>X</code> is expected to be contained in <code>X.sp.backtrace.io</code>.\nAfter creating a tenant, you will probably need to invite an initial\nadministrator user for the tenant. For that, please see <code>invite</code> sub-command\nlisted below. You must use the <code>--tenant</code> option to invite an administrator\nto a particular tenant.\n2.0 Delete a Tenant\nAfter logging into an object store as a superuser, we are able to simply\ncreate a tenant using the following command:\n<pre>$ morgue tenant delete testingxyz\nTenant successfully deleted.</pre>Please note this is a destructive command from a configuration perspective.\nUnless you are maintaining backups, there is no way to restore your\nconfiguration data.\n3.0 List Tenants\nYou can list existing tenants using the <code>morgue tenant list</code> command\nas below.\n<pre>$ morgue tenant list\n ID Tenant URL\n 1 test https://test.sp.backtrace.io\n 4 test1 https://test1.sp.backtrace.io</pre><h3>similarity</h3>\nCompute the similarity and list acceptably similar crash groups according\nto their callstack attribute.\n<pre>Usage: morgue similarity <[universe]/project> [filter expression]\n [--threshold=N] The minimum length of the callstack for groups to\n consider for similarity analysis.\n [--intersect=N] The minimum number of common symbols between\n two groups.\n [--distance=N] The maximum acceptable edit distance between\n two groups.\n [--fingerprint=N] A fingerprint to compute similarity to.</pre><h3>invite</h3>\nInvite new users into your system. Requires you to have logged in.\n<pre>Usage: morgue invite <create | list | resend>\n create <username> <email>\n --role=<"guest" | "member" | "admin">\n --metadata=<metadata>\n --tenant=<tenant name>\n --method=<"password" | "saml" | "pam">\n delete <token>\n resend <token></pre><h4>Examples</h4>\n1.0 Invite a User\nBelow, we invite a new user into the tenant currently logged into (or\nthe first tenant, if multiple exist). The default settings for the user\nare to use password authentication and have a <code>member</code> role.\n<pre>$ morgue invite create <username> <user e-mail></pre><pre>$ morgue invite sbahra user@backtrace.io\nInvitation successfully created for user@backtrace.io\nSending e-mail...done</pre>1.1 Invite a User as an Administrator\n<pre>$ morgue invite create user user@gmail.com --role=admin\nInvitation successfully created for user@backtrace.io\nSending e-mail...done</pre>1.2 Invite a User into a Particular Tenant\n<pre>$ morgue invite create user user@gmail.com --tenant=mystudio\nInvitation successfully created for user@backtrace.io\nSending e-mail...done</pre>2.0 List Pending Invitation\nThis will list invitations that have yet to be accepted or\nactivated.\n<pre>$ morgue invite list\nTenant Username Method Role Email Token\n 1 ashley2 password admin ashley2@backtrace.io f892200fa564...\n 1 jack1 password member jack@backtrace.io 39c1b80a7e00...\n 1 jack2 password member jack+2@backtrace.io c399bdf23873...\n 1 jack17131 password member ja