-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ja.html
580 lines (486 loc) · 18.9 KB
/
index.ja.html
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="utf-8">
<title>Focuslight - Lightning fast Graphing / Visualization</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Le styles -->
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="css/prettify.css" rel="stylesheet">
<style type="text/css">
body {
padding-top: 60px;
padding-bottom: 40px;
}
</style>
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body data-spy="scroll">
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation" id="top">
<div class="container">
<div class="navbar-inner">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">Focuslight</a>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="#top">Home</a></li>
<li><a href="#install">Install</a></li>
<li><a href="#basic">Basic</a></li>
<li><a href="#api">API</a></li>
<li><a href="#software">Software</a></li>
<li><a href="https://github.com/focuslight/focuslight/">Source Code</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-globe"></span> 日本語 <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html">英語</a></li>
<li class="active"><a href="index.ja.html">日本語</a></li>
</ul>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="container">
<!-- Main hero unit for a primary marketing message or call to action -->
<div class="jumbotron" style="padding-top: 0px; padding-bottom: 30px; background-color: #CFE2D4">
<h1><img src="img/logo_native002_2.png" alt="Focuslight"></h1>
<p><small>Ruby clone of <a href="http://kazeburo.github.io/GrowthForecast/">GrowthForecast</a></small></p>
<p>Focuslightは様々な値をWebAPI経由でグラフ化できるWebツールです。シンプルなAPIでリアルタイムにグラフを作成、更新でき、Webインターフェイスからグラフの表示をカスタマイズしたり、複数のメトリクスを重ね合わせたグラフを作成できます</p>
</div>
<section>
<div class="row">
<div class="col-md-6">
<h3>MySQLのデータを1行のコードでグラフ化できます</h3>
<pre class="prettyprint linenums">
$ crontab -l
*/5 * * * * curl -d number=`mysql -BN -e 'select count(*) from member' game` http://example.com/api/socialgame/member/register 2>&1 | logger -t post_gf -p local0.info
</pre>
<p>cronで定期的にFocuslightにPOSTするだけで、設定なしでグラフが作れます</p>
</div>
<div class="col-md-6"><img src="img/sample1.png" class="img-responsive" /></div>
</div>
</section>
<hr>
<section id="install">
<div class="page-header">
<h1>Install <small>インストールと起動方法</small></h1>
</div>
<h3>(1) 依存パッケージの導入</h3>
<div class="row">
<div class="col-md-4">
<p>RRDToolが依存するライブラリを導入します。以下のライブラリをyum、apt、homebrew等OSのパッケージマネージャを利用してインストールします</p>
<ul>
<li>glib</li>
<li>xml2</li>
<li>pango</li>
<li>cairo</li>
</ul>
<p></p>
</div>
<div class="col-md-8">
<h3>CentOS</h3>
<pre class="prettyprint linenums">
$ sudo yum groupinstall "Development Tools"
$ sudo yum install pkgconfig glib2-devel gettext libxml2-devel pango-devel cairo-devel
</pre>
<h3>Ubuntu</h3>
<pre class="prettyprint linenums">
$ sudo apt-get build-dep rrdtool
</pre>
</div>
</div>
<h3>(2) Focuslightのインストール</h3>
<div class="row">
<div class="col-md-4">
<p><a href="http://bundler.io">bundler</a>コマンドを利用して依存モジュールも一緒にインストールします。</p>
<p>OSに最初から入っているrubyではなく<a href="https://github.com/sstephenson/rbenv">rbenv</a>等で構築したrubyを使う事をお勧めします</p>
<p></p>
</div>
<div class="col-md-8">
<pre class="prettyprint linenums">
$ git clone [email protected]:focuslight/focuslight.git
$ cd focuslight
$ gem install bundler
$ bundle install
$ bundle exec rake init
</pre>
<p>インストールは依存 gem の数が多いので時間がかかります</p>
</div>
</div>
<h3>(3) Focuslightの起動</h3>
<div class="row">
<div class="col-md-4">
<p>ここまでの手順でインストールは完了です。Focuslight の起動は「bundle exec foreman start」を実行します</p>
<p>port 5125 でWebサーバが起動するので、ブラウザで確認できます</p>
</div>
<div class="col-md-8">
<h3>起動コマンド</h3>
<pre class="prettyprint linenums">
$ bundle exec foreman start
</pre>
<h3>設定</h3>
プロジェクトルートの .env ファイルを編集して設定します。
<table class="table">
<tr>
<th>変数名</th>
<th>説明</th>
</tr>
<tr>
<td>DATADIR</td><td>グラフデータ(rrdfile)を保存するディレクトリ。デフォルトは ./data</td>
</tr>
<tr>
<td>PORT</td><td>バインドするTCPポート。デフォルトは5125</td>
</tr>
<tr>
<td>HOST</td><td>バインドするIPアドレス。デフォルトは0.0.0.0</td>
</tr>
<tr>
<td>FRONT_PROXY (未対応)</td><td>リバースプロキシーを利用している場合、リバースプロキシーのIPアドレスもしくはCIDRで指定する。複数指定可</td>
</tr>
<tr>
<td>ALLOW_FROM (未対応 )</td><td>アクセス元IPアドレスの指定。指定しないと全てのリモートホストからアクセス可能</td>
</tr>
<tr>
<td>1MIN_METRICS</td><td>1分毎にグラフを更新する機能の停止</td>
</tr>
<tr>
<td>FLOAT_SUPPORT</td><td>浮動小数点数を受け付ける。デフォルトは整数のみ</td>
</tr>
<tr>
<td>DBURL</td><td>データベースURL。SQLite の場合は sqlite://data/gforecast.db、MySQL の場合は mysql2://root:@localhost/focuslight のように指定する。デフォルトは sqlite://data/gforecast.db</td>
</tr>
<tr>
<td>RRDCACHED (未対応)</td><td>rrdcached アドレス。unix:</path/to/unix.sock> または <hostname-or-ip>:<port> のように指定する。デフォルトは no</td>
</tr>
<tr>
<td>MOUNT (未対応)</td><td>Focuslight のアドレス path。デフォルトはルート(/)</td>
</tr>
<tr>
<td>LOG_LEVEL</td><td>ログレベル。debug, info, warn, error, fatal のいずれかを指定する。デフォルトは info</td>
</tr>
</table>
</div>
</div>
<h3>MySQLを使う場合</h3>
<div class="row">
<div class="col-md-4">
<p>MySQLを使う場合、データベースを作成し、次の権限を与える必要がなります。</p>
<ul>
<li>CREATE</li>
<li>ALTER</li>
<li>DELETE</li>
<li>INSERT</li>
<li>UPDATE</li>
<li>SELECT</li>
</ul>
</div>
<div class="col-md-8">
<h4>例</h4>
<pre class="prettyprint linenums">
mysql> CREATE DATABASE focuslight;
mysql> GRANT CREATE, ALTER, DELETE, INSERT, UPDATE, SELECT \\
ON focuslight.* TO 'user'\@'localhost' IDENTIFIED BY password;
</pre>
<p>ユーザ名とパスワードは DBURL 変数で指定します</p>
<pre class="prettyprint linenums">
DBURL=mysql2://user:password@localhost/focuslight
</pre>
</div>
</div>
</section>
<section id="basic">
<div class="page-header">
<h1>Basic <small>基本的な使い方</small></h1>
</div>
<h3>グラフの登録方法</h3>
<p>グラフの作成・データ更新を行うには以下のURLに対してPOSTメソッドにてリクエストを行います</p>
<pre class="prettyprint linenums">
http://example.com/api/:service_name/:section_name/:graph_name
</pre>
<div class="row">
<div class="col-md-3">
<p>POSTする際のURL中の各名前は右にまとめました</p>
<p>各項目名にはUTF-8であればマルチバイト文字列が使えます</p>
</div>
<div class="col-md-7">
<table class="table">
<tr>
<th>例中の名前</th>
<th>役割</th>
<th>具体例を , 区切りで</th>
</tr>
<tr>
<td>:service_name</td>
<td>グラフを取りたいサービスの名前</td>
<td>blog, photo, place, socialgame</td>
</tr>
<tr>
<td>:section_name</td>
<td>そのサービスの中での、グラフを取る対象が属してる機能やシステム名</td>
<td>entry, user, spot, items</td>
</tr>
<tr>
<td>:graph_name</td>
<td>具体的に何のグラフか</td>
<td>total_entry, kakin_user, muryo_user</td>
</tr>
</table>
</div>
</div>
<p>もしソーシャルゲームの登録ユーザ数をグラフにするのであれば</p>
<pre class="prettyprint linenums">
http://example.com/api/socialgame/member/register
</pre>
<p>に対して POST します。</p>
<p>また、 POST する時には以下のパラメータをつけます。</p>
<table class="table">
<tr>
<th>パラメータ</th>
<th>説明</th>
<th>必須/オプション</th>
</tr>
<tr>
<td>number</td>
<td>グラフに与える数値</td>
<td>必須</td>
</tr>
<tr>
<td>mode</td>
<td>数値のアップデート方法。count or modified or gauge。<br />
count: 登録済みの数値を number の値で加算<br />
modified: 前回と異なる数値の時だけ上書き更新<br />
gauge: number の数値で常に上書き<br />
デフォルトは gauge</td>
<td>オプション</td>
</tr>
<tr>
<td>color</td>
<td>グラフの色。#FFFFFF 形式で指定</td>
<td>オプション/新規グラフで指定なしの場合自動生成</td>
</tr>
</table>
<h3>グラフ登録サンプル</h3>
<p>curlを使った場合</p>
<pre class="prettyprint linenums">
$ curl -d number=10 http://example.com/api/socialgame/member/register
</pre>
</section>
<!--
<section id="gf_internal">
<div class="page-header">
<h1>Internal <small>内部動作</small></h1>
</div>
<h3>GrowthForeacstの仕組み</h3>
<div class="row">
<div class="col-md-4">
<p>FocuslightはRound Robbin Databaseおよびグラフ描画のツールとしてRRDtoolを利用しています。</p>
<p>APIのエンドポイントに送信されたデータはRDMBSに一旦保存されます。Workerが定期的に動作し、RDBMSからデータを読み出し、RRDファイルを更新しています。その歳、Focuslightのworkerは、現在の値に加えて、一つ前との差分をsubtractデータとして格納しています。</p>
<p>subtractデータをグラフのソースとして利用することで、データの変化量を可視化することができます</p>
</div>
<div class="col-md-8" style="text-align:center"><img src="img/gf_internal.png" class="img-responsive" /></div>
<div>
</section>
-->
<section id="api">
<div class="page-header">
<h1>API <small>その他のAPI</small></h1>
</div>
<h3>グラフの表示のカスタマイズ</h3>
<p>グラフのURIに対していくつかパラメータを与えるとグラフの描画をカスタマイズすることができます</p>
<h4>エンドポイント</h4>
<pre class="prettyprint">
グラフのURI http://example.com/graph/:service_name/:section_name/:graph_name
複合グラフのURI http://example.com/graph/:pattern
</pre>
<div class="row">
<div class="col-md-3">
<h4>サポートしているパラメータ一覧</h4>
<p>パラメータを変更する事で↓こんなグラフも作れます</p>
<p><img src="img/sample.png" class="img-responsive" /></p>
<pre class="prettyprint">
http://example.com/graph/service/section/graph?t=d&border=0&legend=0&width=200&background_color=333333&canvas_color=333333&font_color=CCCCCC&axis_color=666666
</pre>
</div>
<div class="col-md-9">
<table class="table">
<tr>
<th>パラメータ</th>
<th>説明</th>
</tr>
<tr>
<td>t</td>
<td>グラフの範囲。y(年間)、m(月間)、w(週間)、3d(3日間)、s3d(3日間・1分更新)、d(一日)、sd(一日・1分更新)、8h(8時間)、s8h(8時間・1分更新)、4h(4時間)、s4h(4時間・1分更新)、h(1時間)、sh(1時間・1分更新)、n(半日)、sn(半日・1分更新)、c(任意)、sc(任意・1分更新)</td>
</tr>
<tr>
<td>from</td>
<td>「t」が「c」または「sc」の場合、描画する開始日付。「2011/12/08 12:10:00」の形式で指定</td>
</tr>
<tr>
<td>to</td>
<td>「t」が「c」または「sc」の場合、描画する終了日付。「2011/12/08 12:10:00」の形式で指定</td>
</tr>
<tr>
<td>width</td>
<td>横幅。実際には凡例などを含むので指定したサイズより大きくなる</td>
</tr>
<tr>
<td>height</td>
<td>縦幅。実際には凡例などを含むので指定したサイズより大きくなる</td>
</tr>
<tr>
<td>graphonly</td>
<td>グラフ部分しか描画しないモード。デフォルト「0」</td>
</tr>
<tr>
<td>logarithmic</td>
<td>対数グラフ。デフォルト「0」</td>
</tr>
<tr>
<td>xgrid</td>
<td>X軸の設定。フォーマットは<a href="http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html">rrdtool</a>のドキュメント参照のこと</td>
</tr>
<tr>
<td>ygrid</td>
<td>Y軸の設定。フォーマットは<a href="http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html">rrdtool</a>のドキュメント参照のこと</td>
</tr>
<tr>
<td>background_color</td>
<td>背景色。FFFFFF または FFFFFF00 で指定。最後の2文字はアルファチャンネル</td>
</tr>
<tr>
<td>canvas_color</td>
<td>グラフ部分背景色。FFFFFF または FFFFFF00 で指定</td>
</tr>
<tr>
<td>font_color</td>
<td>文字色。FFFFFF または FFFFFF00 で指定</td>
</tr>
<tr>
<td>frame_color</td>
<td>凡例の色を囲っている部分。FFFFFF または FFFFFF00 で指定</td>
</tr>
<tr>
<td>axis_color</td>
<td>グラフ部分の枠線。FFFFFF または FFFFFF00 で指定</td>
</tr>
<tr>
<td>shadea_color</td>
<td>左上、上の枠線。FFFFFF または FFFFFF00 で指定</td>
</tr>
<tr>
<td>shadeb_color</td>
<td>右下、下の枠線。FFFFFF または FFFFFF00 で指定</td>
</tr>
<tr>
<td>border</td>
<td>枠線の太さ。「0」も可能。デフォルト「3」</td>
</tr>
<tr>
<td>legend</td>
<td>凡例の有無。デフォルト「1」</td>
</tr>
<tr>
<td>sumup</td>
<td>凡例に合計値を含むかどうか。デフォルト「0」</td>
</tr>
</table>
</div>
</div>
<h3>グラフデータのサマリー</h3>
<p>グラフデータの凡例部分をJSON形式でエクスポートできます</p>
<h4>エンドポイント</h4>
<pre class="prettyprint">
グラフのサマリーURI http://example.com/summary/:service_name/:section_name/:graph_name
複合グラフのサマリーURI http://example.com/summary/:pattern
</pre>
<h3>グラフデータのエクスポート</h3>
<div class="row">
<div class="col-md-3">
<p>グラフデータをJSON形式でエクスポートできます</p>
</div>
<div class="col-md-9">
<h4>エンドポイント</h4>
<pre class="prettyprint">
グラフのURI http://example.com/xport/:service_name/:section_name/:graph_name
複合グラフのURI http://example.com/xport/:pattern
</pre>
<h4>パラメータ一覧</h4>
<table class="table">
<tr>
<th>パラメータ</th>
<th>説明</th>
</tr>
<tr>
<td>t</td>
<td>グラフの範囲。y(年間)、m(月間)、w(週間)、3d(3日間)、s3d(3日間・1分更新)、d(一日)、sd(一日・1分更新)、8h(8時間)、s8h(8時間・1分更新)、4h(4時間)、s4h(4時間・1分更新)、h(1時間)、sh(1時間・1分更新)、n(半日)、sn(半日・1分更新)、c(任意)、sc(任意・1分更新)</td>
</tr>
<tr>
<td>from</td>
<td>「t」が「c」または「sc」の場合、描画する開始日付。「2011/12/08 12:10:00」の形式で指定</td>
</tr>
<tr>
<td>to</td>
<td>「t」が「c」または「sc」の場合、描画する終了日付。「2011/12/08 12:10:00」の形式で指定</td>
</tr>
<tr>
<td>width</td>
<td>rowの最大個数</td>
</tr>
</table>
</div>
</div>
</section>
<section id="software">
<div class="page-header">
<h1>Related Softwares <small>関連ソフトウェア</small></h1>
</div>
<div class="row">
<div class="col-md-12">
<p>Focuslight は GrowthForecast と HTTP API 互換を持つ Ruby クローンであるため、以下の GrowthForecast 用クライアントソフトウェアを利用することができます</p>
<h4>fluent-plugin-growthforecast</h4>
<p><a href="https://github.com/tagomoris/fluent-plugin-growthforecast">https://github.com/tagomoris/fluent-plugin-growthforecast</a><br />
Fluentd plugin to output numbers(metrics) to 'GrowthForecast', metrics drawing tool over HTTP.</p>
<h4>rb-growthforecast (ruby)</h4>
<p><a href="https://github.com/tagomoris/rb-growthforecast">https://github.com/tagomoris/rb-growthforecast</a><br />
Client library and command to operate GrowthForecast</p>
<h4>growthforecast-client (ruby)</h4>
<p><a href="https://github.com/sonots/growthforecast-client">https://github.com/sonots/growthforecast-client</a><br />
growthforecast-client is a ruby client library for GrowthForecast API where GrowthForecast is a visualization graph tool.</p>
<h4>Net::GrowthForecast (perl)</h4>
<p><a href="https://metacpan.org/pod/Net::GrowthForecast">https://metacpan.org/pod/Net::GrowthForecast</a><br />
A client library for awesome visualization tool GrowthForecast</p>
<div>
<div>
</section>
<hr>
<footer>
<p>© 2012- Masahiro Nagano</p>
<p>© 2014- Naotoshi Seo</p>
<p><a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons licenses" style="border-width:0" src="http://i.creativecommons.org/l/by/4.0/80x15.png" /></a>- Logo by 125design</p>
</footer>
</div> <!-- /container -->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/prettify.js"></script>
<script>
(function(){
$('#navbar').scrollspy();
prettyPrint();
})();
</script>
</body>
</html>