graphite-api 1.1.2-1 / usr / share / doc / graphite-api / html / index.html

This file is indexed.

/usr/share/doc/graphite-api/html/index.html is in graphite-api 1.1.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Graphite-API documentation &mdash; Graphite-API 1.1.2 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Graphite-API 1.1.2 documentation" href="#"/>
        <link rel="next" title="Installation" href="installation.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="#" class="icon icon-home"> Graphite-API
          

          
          </a>

          
            
            
              <div class="version">
                1.1.2
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">HTTP API</a></li>
<li class="toctree-l1"><a class="reference internal" href="functions.html">Built-in functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="finders.html">Storage finders</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom-functions.html">Custom functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Graphite-API releases</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="#">Graphite-API</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          





<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="#">Docs</a> &raquo;</li>
      
    <li>Graphite-API documentation</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/index.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="graphite-api-documentation">
<h1>Graphite-API documentation<a class="headerlink" href="#graphite-api-documentation" title="Permalink to this headline"></a></h1>
<p>
<a class="reference external image-reference" href="https://github.com/brutasse/graphite-api"><img alt="GitHub project" src="https://img.shields.io/badge/GitHub-graphite--api-green.svg" style="height: 18px !important; width: auto !important;"></a>

<a class="reference external image-reference" href="https://travis-ci.org/brutasse/graphite-api"><img alt="Build Status" src="https://travis-ci.org/brutasse/graphite-api.svg?branch=master" style="height: 18px !important; width: auto !important;"></a>

<a class="reference external image-reference" href="https://pypi.python.org/pypi/graphite-api"><img alt="PyPI version" src="https://img.shields.io/pypi/v/graphite-api.svg" style="height: 18px !important; width: auto !important;"></a>
</p><p>Graphite-API is an alternative to Graphite-web, without any built-in
dashboard. Its role is solely to fetch metrics from a time-series database
(whisper, cyanite, etc.) and rendering graphs or JSON data out of these
time series. It is meant to be consumed by any of the numerous Graphite
dashboard applications.</p>
<p>Graphite-API is a fork of Graphite-web and couldn&#8217;t have existed without the
fantastic prior work done by the Graphite team.</p>
<div class="section" id="why-should-i-use-it">
<h2>Why should I use it?<a class="headerlink" href="#why-should-i-use-it" title="Permalink to this headline"></a></h2>
<p>Graphite-API offers a number of improvements over Graphite-web that you might
find useful. Namely:</p>
<ul class="simple">
<li>The Graphite-API application is completely stateless and doesn&#8217;t need a SQL
database. It only needs to talk to a time series database.</li>
<li>Python 2 and 3 are both supported.</li>
<li>The HTTP API accepts JSON data additionnaly to form data and querystring
parameters.</li>
<li>The application is extremely simple to <a class="reference internal" href="installation.html"><em>install</em></a> and
<a class="reference internal" href="configuration.html"><em>configure</em></a>.</li>
<li>The architecture has been drastically simplified and there are many fewer
moving parts than in graphite-web:<ul>
<li>No memcache integration &#8211; rendering is live.</li>
<li>No support for the Pickle format when rendering.</li>
<li>Plugin architecture for <a class="reference internal" href="finders.html"><em>integrating with time series databases</em></a> or <a class="reference internal" href="custom-functions.html"><em>adding more analysis functions</em></a>.</li>
</ul>
</li>
<li>The codebase has been thoroughly updated with a focus on test coverage and
code quality.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Graphite-API does <strong>not</strong> provide any web/graphical interface. If you
currently rely on the built-in Graphite composer, Graphite-API might not
be for you. However, if you&#8217;re using a third-party dashboard interface,
Graphite-API will do just fine.</p>
</div>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#debian-ubuntu-native-package">Debian / Ubuntu: native package</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#python-package">Python package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#etc-graphite-api-yaml">/etc/graphite-api.yaml</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#custom-location">Custom location</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="deployment.html#gunicorn-nginx">Gunicorn + nginx</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.html#apache-mod-wsgi">Apache + mod_wsgi</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.html#docker">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.html#nginx-uwsgi">Nginx + uWSGI</a></li>
<li class="toctree-l2"><a class="reference internal" href="deployment.html#other-deployment-methods">Other deployment methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">HTTP API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#the-metrics-api">The Metrics API</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#the-render-api-render">The Render API &#8211; <code class="docutils literal"><span class="pre">/render</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="functions.html">Built-in functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="functions.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="functions.html#module-graphite_api.functions">List of functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="finders.html">Storage finders</a><ul>
<li class="toctree-l2"><a class="reference internal" href="finders.html#custom-finders">Custom finders</a></li>
<li class="toctree-l2"><a class="reference internal" href="finders.html#fetching-multiple-paths-at-once">Fetching multiple paths at once</a></li>
<li class="toctree-l2"><a class="reference internal" href="finders.html#installing-custom-finders">Installing custom finders</a></li>
<li class="toctree-l2"><a class="reference internal" href="finders.html#configuration">Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="custom-functions.html">Custom functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Graphite-API releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="releases.html#id1">1.1.2 &#8211; 2015-11-19</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#id2">1.1.1 &#8211; 2015-10-23</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#id3">1.1 &#8211; 2015-10-05</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#id9">1.0.1 &#8211; 2014-03-21</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#id12">1.0.0 &#8211; 2014-03-20</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
</ul>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014, Bruno Renié.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'1.1.2',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.