giraffe-web
Version:
Giraffe dashboard for Graphite wrapped in a webserver
489 lines (185 loc) • 7.03 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Bluebox Class: GiraffeWeb</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Bluebox</a>
<ul class="nav">
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="GiraffeWeb.html">GiraffeWeb</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: GiraffeWeb</h1>
<section>
<header>
<h2>
GiraffeWeb
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="GiraffeWeb"><span class="type-signature"></span>new GiraffeWeb<span class="signature">(options)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">hash</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>port</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>Port to start the webserver on</p></td>
</tr>
<tr>
<td class="name"><code>graphiteUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Graphite URL to connect to</p></td>
</tr>
<tr>
<td class="name"><code>configFile</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Path for the dashboardsfile to read</p></td>
</tr>
<tr>
<td class="name"><code>proxyGraphite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Flag if we need to proxy Graphite requests via this webserver</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="giraffe-web.js.html">giraffe-web.js</a>, <a href="giraffe-web.js.html#sunlight-1-line-10">line 10</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="loadConfig"><span class="type-signature"><static> </span>loadConfig<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Method to read the config dashboard and replace the graphite according to settings
If we proxy it replaces the graphiteURL to point to this webserver/graphite</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="giraffe-web.js.html">giraffe-web.js</a>, <a href="giraffe-web.js.html#sunlight-1-line-31">line 31</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="start"><span class="type-signature"><static> </span>start<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Method to launch the webserver</p>
<ul>
<li>If we proxyGraphite, we will proxy the request to another Graphite HTTP server</li>
<li>We override the dashboards.js file provided by plain Giraffe by our own dashboard file specified</li>
</ul>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="giraffe-web.js.html">giraffe-web.js</a>, <a href="giraffe-web.js.html#sunlight-1-line-62">line 62</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>