1<!DOCTYPE html> 2 3<html lang="en"> 4 <head> 5 <meta charset="utf-8" /> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> 7 8 <title>Documentation for OpenTSDB 2.4 — OpenTSDB 2.4 documentation</title> 9 <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> 10 <link rel="stylesheet" type="text/css" href="_static/solar.css" /> 11
11<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
11 12
12<script src="_static/doctools.js"></script>
12 13
13<script src="_static/sphinx_highlight.js"></script>
13 14 <link rel="index" title="Index" href="genindex.html" /> 15 <link rel="search" title="Search" href="search.html" /> 16 <link rel="next" title="Whatâs New" href="new.html" /><link href='http://fonts.googleapis.com/css?family=Source+Code+Pro|Open+Sans:300italic,400italic,700italic,400,300,700' rel='stylesheet' type='text/css'> 17<link href="_static/solarized-dark.css" rel="stylesheet">
18<script type="text/javascript"> 19 var _gaq = _gaq || []; 20 _gaq.push(['_setAccount', 'UA-18339382-1']); 21 _gaq.push(['_setDomainName', 'none']); 22 _gaq.push(['_setAllowLinker', true]); 23 _gaq.push(['_trackPageview']); 24 (function() { 25 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; 26 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; 27 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); 28 })(); 29</script>
29 30 </head><body> 31 <div class="related" role="navigation" aria-label="related navigation"> 32 <h3>Navigation</h3> 33 <ul> 34 <li class="right" style="margin-right: 10px"> 35 <a href="genindex.html" title="General Index" 36 accesskey="I">index</a></li> 37 <li class="right" > 38 <a href="new.html" title="Whatâs New" 39 accesskey="N">next</a> |</li> 40 <li class="nav-item nav-item-0"><a href="#">OpenTSDB 2.4 documentation</a> »</li> 41 <li class="nav-item nav-item-this"><a href="">Documentation for OpenTSDB 2.4</a></li> 42 </ul> 43 </div> 44 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> 45 <div class="sphinxsidebarwrapper"> 46 <div> 47 <h3><a href="#">Table of Contents</a></h3> 48 <ul> 49<li><a class="reference internal" href="#">Documentation for OpenTSDB 2.4</a><ul> 50<li><a class="reference internal" href="#opentsdb-3-0">OpenTSDB 3.0</a></li> 51</ul> 52</li> 53<li><a class="reference internal" href="#contents">Contents</a></li> 54<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> 55</ul> 56 57 </div> 58 <div> 59 <h4>Next topic</h4> 60 <p class="topless"><a href="new.html" 61 title="next chapter">Whatâs New</a></p> 62 </div> 63<div id="searchbox" style="display: none" role="search"> 64 <h3 id="searchlabel">Quick search</h3> 65 <div class="searchformwrapper"> 66 <form class="search" action="search.html" method="get"> 67 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> 68 <input type="submit" value="Go" /> 69 </form> 70 </div> 71</div>
72<script>document.getElementById('searchbox').style.display = "block"</script>
72 73 </div> 74 </div> 75 76 <div class="document"> 77 <div class="documentwrapper"> 78 <div class="bodywrapper"> 79 <div class="body" role="main"> 80 81 <section id="documentation-for-opentsdb-version"> 82<h1>Documentation for OpenTSDB 2.4<a class="headerlink" href="#documentation-for-opentsdb-version" title="Permalink to this heading">¶</a></h1> 83<p>Welcome to OpenTSDB 2.4, the scalable, distributed time series database. We recommend that you start with the <a class="reference internal" href="user_guide/index.html"><span class="doc">User Guide</span></a> then test your understanding with an <a class="reference internal" href="installation.html"><span class="doc">Installation</span></a> and read on the <a class="reference internal" href="api_http/index.html"><span class="doc">HTTP API</span></a> if you need to develop against it.</p> 84<section id="opentsdb-3-0"> 85<h2>OpenTSDB 3.0<a class="headerlink" href="#opentsdb-3-0" title="Permalink to this heading">¶</a></h2> 86<p>Documentation for the OpenTSDB 3.0 work-in-progress can be found here: <a class="reference external" href="../../3x/build/html/index.html">OpenTSDB 3.0</a>.</p> 87</section> 88</section> 89<section id="contents"> 90<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this heading">¶</a></h1> 91<div class="toctree-wrapper compound"> 92<ul> 93<li class="toctree-l1"><a class="reference internal" href="new.html">Whatâs New</a><ul> 94<li class="toctree-l2"><a class="reference internal" href="new.html#x-planned">3.X (Planned)</a></li> 95<li class="toctree-l2"><a class="reference internal" href="new.html#id1">2.4</a></li> 96<li class="toctree-l2"><a class="reference internal" href="new.html#id2">2.3</a></li> 97<li class="toctree-l2"><a class="reference internal" href="new.html#id3">2.2</a></li> 98<li class="toctree-l2"><a class="reference internal" href="new.html#id4">2.1</a></li> 99<li class="toctree-l2"><a class="reference internal" href="new.html#id5">2.0</a></li> 100</ul> 101</li> 102<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul> 103<li class="toctree-l2"><a class="reference internal" href="installation.html#runtime-requirements">Runtime Requirements</a></li> 104<li class="toctree-l2"><a class="reference internal" href="installation.html#id1">Installation</a></li> 105<li class="toctree-l2"><a class="reference internal" href="installation.html#upgrading-from-1-x">Upgrading from 1.x</a></li> 106<li class="toctree-l2"><a class="reference internal" href="installation.html#upgrading-from-2-x-to-a-later-2-x">Upgrading from 2.x to a Later 2.x</a></li> 107<li class="toctree-l2"><a class="reference internal" href="installation.html#downgrading">Downgrading</a></li> 108</ul> 109</li> 110<li class="toctree-l1"><a class="reference internal" href="user_guide/index.html">User Guide</a><ul> 111<li class="toctree-l2"><a class="reference internal" href="user_guide/configuration.html">Configuration</a></li> 112<li class="toctree-l2"><a class="reference internal" href="user_guide/writing/index.html">Writing Data</a></li> 113<li class="toctree-l2"><a class="reference internal" href="user_guide/query/index.html">Querying or Reading Data</a></li> 114<li class="toctree-l2"><a class="reference internal" href="user_guide/rollups.html">Rollup And Pre-Aggregates</a></li> 115<li class="toctree-l2"><a class="reference internal" href="user_guide/uids.html">UIDs and TSUIDs</a></li> 116<li class="toctree-l2"><a class="reference internal" href="user_guide/metadata.html">Metadata</a></li> 117<li class="toctree-l2"><a class="reference internal" href="user_guide/trees.html">Trees</a></li> 118<li class="toctree-l2"><a class="reference internal" href="user_guide/guis/index.html">GUI</a></li> 119<li class="toctree-l2"><a class="reference internal" href="user_guide/plugins.html">Plugins</a></li> 120<li class="toctree-l2"><a class="reference internal" href="user_guide/stats.html">Stats</a></li> 121<li class="toctree-l2"><a class="reference internal" href="user_guide/definitions.html">Definitions</a></li> 122<li class="toctree-l2"><a class="reference internal" href="user_guide/backends/index.html">Storage</a></li> 123<li class="toctree-l2">
123<a class="reference internal" href="user_guide/cli/index.html">CLI Tools</a></li> 124<li class="toctree-l2"><a class="reference internal" href="user_guide/utilities/index.html">Utilities</a></li> 125<li class="toctree-l2"><a class="reference internal" href="user_guide/logging.html">Logging</a></li> 126<li class="toctree-l2"><a class="reference internal" href="user_guide/tuning.html">Tuning</a></li> 127<li class="toctree-l2"><a class="reference internal" href="user_guide/troubleshooting.html">Troubleshooting</a></li> 128</ul> 129</li> 130<li class="toctree-l1"><a class="reference internal" href="api_http/index.html">HTTP API</a><ul> 131<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#overview">Overview</a></li> 132<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#version-1-x-to-2-x">Version 1.X to 2.x</a></li> 133<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#serializers">Serializers</a></li> 134<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#authentication-permissions">Authentication/Permissions</a></li> 135<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#response-codes">Response Codes</a></li> 136<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#errors">Errors</a></li> 137<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#verbs">Verbs</a></li> 138<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#api-versioning">API Versioning</a></li> 139<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#query-string-vs-body-content">Query String Vs. Body Content</a></li> 140<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#compressed-requests">Compressed Requests</a></li> 141<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#cors">CORS</a></li> 142<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#documentation">Documentation</a></li> 143<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#deprecated-api">Deprecated API</a></li> 144<li class="toctree-l2"><a class="reference internal" href="api_http/index.html#api-endpoints">API Endpoints</a></li> 145</ul> 146</li> 147<li class="toctree-l1"><a class="reference internal" href="api_telnet/index.html">Telnet Style API</a><ul> 148<li class="toctree-l2"><a class="reference internal" href="api_telnet/put.html">put</a></li> 149<li class="toctree-l2"><a class="reference internal" href="api_telnet/rollup.html">rollup</a></li> 150<li class="toctree-l2"><a class="reference internal" href="api_telnet/histogram.html">histogram</a></li> 151<li class="toctree-l2"><a class="reference internal" href="api_telnet/stats.html">stats</a></li> 152<li class="toctree-l2"><a class="reference internal" href="api_telnet/version.html">version</a></li> 153<li class="toctree-l2"><a class="reference internal" href="api_telnet/help.html">help</a></li> 154<li class="toctree-l2"><a class="reference internal" href="api_telnet/dropcaches.html">dropcaches</a></li> 155<li class="toctree-l2"><a class="reference internal" href="api_telnet/diediedie.html">diediedie</a></li> 156</ul> 157</li> 158<li class="toctree-l1"><a class="reference internal" href="development/index.html">Development</a><ul> 159<li class="toctree-l2"><a class="reference internal" href="development/index.html#guidelines">Guidelines</a></li> 160<li class="toctree-l2"><a class="reference internal" href="development/index.html#git-repository">Git Repository</a></li> 161<li class="toctree-l2"><a class="reference internal" href="development/index.html#details">Details</a></li> 162</ul> 163</li> 164<li class="toctree-l1"><a class="reference internal" href="resources.html">Additional Resources</a><ul> 165<li class="toctree-l2"><a class="reference internal" href="resources.html#monitoring">Monitoring</a></li> 166<li class="toctree-l2"><a class="reference internal" href="resources.html#docker-images">Docker Images</a></li> 167<li class="toctree-l2"><a class="reference internal" href="resources.html#front-ends">Front Ends</a></li> 168<li class="toctree-l2"><a class="reference internal" href="resources.html#utilities">Utilities</a></li> 169<li class="toctree-l2"><a class="reference internal" href="resources.html#clients">Clients</a></li> 170<li class="toctree-l2"><a class="reference internal" href="resources.html#references-to-opentsdb">References to OpenTSDB</a></li> 171<li class="toctree-l2"><a class="reference internal" href="resources.html#statistical-analysis-tools">Statistical Analysis Tools</a></li> 172</ul> 173</li> 174</ul> 175</div> 176</section> 177<section id="indices-and-tables"> 178<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1> 179<ul class="simple"> 180<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> 181<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> 182</ul> 183</section> 184 185 186 <div class="clearer"></div> 187 </div> 188 </div> 189 </div> 190 <div class="clearer"></div> 191 </div> 192 <div class="related" role="navigation" aria-label="related navigation"> 193 <h3>Navigation</h3> 194 <ul> 195 <li class="right" style="margin-right: 10px"> 196 <a href="genindex.html" title="General Index" 197 >index</a></li> 198 <li class="right" > 199 <a href="new.html" title="Whatâs New" 200 >next</a> |</li> 201 <li class="nav-item nav-item-0"><a href="#">OpenTSDB 2.4 documentation</a> »</li> 202 <li class="nav-item nav-item-this"><a href="">Documentation for OpenTSDB 2.4</a></li> 203 </ul> 204 </div> 205 <div class="footer"> 206 ©
206 Copyright 2026, OpenTSDB. 207 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>. Theme by <a href="http://github.com/vkvn">vkvn</a> 208 </div> 209 </body> 210</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.