mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-22 12:44:30 +03:00
315 lines
28 KiB
HTML
315 lines
28 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Statistics - Synapse</title>
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/table-of-contents.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/indent-section-headers.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/version-picker.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "../";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="../welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="../setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="../postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="../reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="../setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="../turn-howto.html">Configuring a Turn Server</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/turn/coturn.html">coturn TURN server</a></li><li class="chapter-item expanded "><a href="../setup/turn/eturnal.html">eturnal TURN server</a></li></ol></li><li class="chapter-item expanded "><a href="../delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="../upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="../federate.html">Federation</a></li><li class="chapter-item expanded "><a href="../usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="../usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="../usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="../structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="../templates.html">Templates</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="../sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="../password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="../jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="../CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="../application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="../server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="../consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="../user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="../message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="../modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
<div class="version-picker">
|
||
|
|
<div class="dropdown">
|
||
|
|
<div class="select">
|
||
|
|
<span></span>
|
||
|
|
<i class="fa fa-chevron-down"></i>
|
||
|
|
</div>
|
||
|
|
<input type="hidden" name="version">
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
<!-- Versions will be added dynamically in version-picker.js -->
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">Synapse</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/statistics.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<!-- Page table of contents -->
|
||
|
|
<div class="sidetoc">
|
||
|
|
<nav class="pagetoc"></nav>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 id="users-media-usage-statistics"><a class="header" href="#users-media-usage-statistics">Users' media usage statistics</a></h1>
|
||
|
|
<p>Returns information about all local media usage of users. Gives the
|
||
|
|
possibility to filter them by time and user.</p>
|
||
|
|
<p>To use it, you will need to authenticate by providing an <code>access_token</code>
|
||
|
|
for a server admin: see <a href="../usage/administration/admin_api/">Admin API</a>.</p>
|
||
|
|
<p>The API is:</p>
|
||
|
|
<pre><code>GET /_synapse/admin/v1/statistics/users/media
|
||
|
|
</code></pre>
|
||
|
|
<p>A response body like the following is returned:</p>
|
||
|
|
<pre><code class="language-json">{
|
||
|
|
"users": [
|
||
|
|
{
|
||
|
|
"displayname": "foo_user_0",
|
||
|
|
"media_count": 2,
|
||
|
|
"media_length": 134,
|
||
|
|
"user_id": "@foo_user_0:test"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"displayname": "foo_user_1",
|
||
|
|
"media_count": 2,
|
||
|
|
"media_length": 134,
|
||
|
|
"user_id": "@foo_user_1:test"
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"next_token": 3,
|
||
|
|
"total": 10
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p>To paginate, check for <code>next_token</code> and if present, call the endpoint
|
||
|
|
again with <code>from</code> set to the value of <code>next_token</code>. This will return a new page.</p>
|
||
|
|
<p>If the endpoint does not return a <code>next_token</code> then there are no more
|
||
|
|
reports to paginate through.</p>
|
||
|
|
<p><strong>Parameters</strong></p>
|
||
|
|
<p>The following parameters should be set in the URL:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>limit</code>: string representing a positive integer - Is optional but is
|
||
|
|
used for pagination, denoting the maximum number of items to return
|
||
|
|
in this call. Defaults to <code>100</code>.</li>
|
||
|
|
<li><code>from</code>: string representing a positive integer - Is optional but used for pagination,
|
||
|
|
denoting the offset in the returned results. This should be treated as an opaque value
|
||
|
|
and not explicitly set to anything other than the return value of <code>next_token</code> from a
|
||
|
|
previous call. Defaults to <code>0</code>.</li>
|
||
|
|
<li><code>order_by</code> - string - The method in which to sort the returned list of users. Valid values are:
|
||
|
|
<ul>
|
||
|
|
<li><code>user_id</code> - Users are ordered alphabetically by <code>user_id</code>. This is the default.</li>
|
||
|
|
<li><code>displayname</code> - Users are ordered alphabetically by <code>displayname</code>.</li>
|
||
|
|
<li><code>media_length</code> - Users are ordered by the total size of uploaded media in bytes.
|
||
|
|
Smallest to largest.</li>
|
||
|
|
<li><code>media_count</code> - Users are ordered by number of uploaded media. Smallest to largest.</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><code>from_ts</code> - string representing a positive integer - Considers only
|
||
|
|
files created at this timestamp or later. Unix timestamp in ms.</li>
|
||
|
|
<li><code>until_ts</code> - string representing a positive integer - Considers only
|
||
|
|
files created at this timestamp or earlier. Unix timestamp in ms.</li>
|
||
|
|
<li><code>search_term</code> - string - Filter users by their user ID localpart <strong>or</strong> displayname.
|
||
|
|
The search term can be found in any part of the string.
|
||
|
|
Defaults to no filtering.</li>
|
||
|
|
<li><code>dir</code> - string - Direction of order. Either <code>f</code> for forwards or <code>b</code> for backwards.
|
||
|
|
Setting this value to <code>b</code> will reverse the above sort order. Defaults to <code>f</code>.</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Response</strong></p>
|
||
|
|
<p>The following fields are returned in the JSON response body:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>users</code> - An array of objects, each containing information
|
||
|
|
about the user and their local media. Objects contain the following fields:
|
||
|
|
<ul>
|
||
|
|
<li><code>displayname</code> - string - Displayname of this user.</li>
|
||
|
|
<li><code>media_count</code> - integer - Number of uploaded media by this user.</li>
|
||
|
|
<li><code>media_length</code> - integer - Size of uploaded media in bytes by this user.</li>
|
||
|
|
<li><code>user_id</code> - string - Fully-qualified user ID (ex. <code>@user:server.com</code>).</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><code>next_token</code> - integer - Opaque value used for pagination. See above.</li>
|
||
|
|
<li><code>total</code> - integer - Total number of users after filtering.</li>
|
||
|
|
</ul>
|
||
|
|
<h1 id="get-largest-rooms-by-size-in-database"><a class="header" href="#get-largest-rooms-by-size-in-database">Get largest rooms by size in database</a></h1>
|
||
|
|
<p>Returns the 10 largest rooms and an estimate of how much space in the database
|
||
|
|
they are taking.</p>
|
||
|
|
<p>This does not include the size of any associated media associated with the room.</p>
|
||
|
|
<p>Returns an error on SQLite.</p>
|
||
|
|
<p><em>Note:</em> This uses the planner statistics from PostgreSQL to do the estimates,
|
||
|
|
which means that the returned information can vary widely from reality. However,
|
||
|
|
it should be enough to get a rough idea of where database disk space is going.</p>
|
||
|
|
<p>The API is:</p>
|
||
|
|
<pre><code>GET /_synapse/admin/v1/statistics/database/rooms
|
||
|
|
</code></pre>
|
||
|
|
<p>A response body like the following is returned:</p>
|
||
|
|
<pre><code class="language-json">{
|
||
|
|
"rooms": [
|
||
|
|
{
|
||
|
|
"room_id": "!OGEhHVWSdvArJzumhm:matrix.org",
|
||
|
|
"estimated_size": 47325417353
|
||
|
|
}
|
||
|
|
],
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Response</strong></p>
|
||
|
|
<p>The following fields are returned in the JSON response body:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>rooms</code> - An array of objects, sorted by largest room first. Objects contain
|
||
|
|
the following fields:
|
||
|
|
<ul>
|
||
|
|
<li><code>room_id</code> - string - The room ID.</li>
|
||
|
|
<li><code>estimated_size</code> - integer - Estimated disk space used in bytes by the room
|
||
|
|
in the database.</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p><em>Added in Synapse 1.83.0</em></p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../admin_api/server_notices.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="../admin_api/user_admin_api.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../admin_api/server_notices.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="../admin_api/user_admin_api.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
<script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script>
|
||
|
|
<script type="text/javascript" src="../docs/website_files/version-picker.js"></script>
|
||
|
|
<script type="text/javascript" src="../docs/website_files/version.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|