Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 153 lines (114 sloc) 5.338 kb
b2fd9ad6 »
2011-04-16 Doc updates
1 Narcissus - Realtime visualizations of web server hits
2 ------------------------------------------------------
6708f3f7 »
2012-02-03 Updated docs.
3 .. figure:: narcissus/raw/master/narcissus/public/images/narcissus-caravaggio.jpg
b2fd9ad6 »
2011-04-16 Doc updates
4 :align: right
5 :scale: 50 %
6 :alt: Narcissus wastes a bunch of time.
7
8 Narcissus wastes a bunch of time.
9
10 .. split here
11
edbc3c9d »
2011-05-07 Big README updates.
12 What is this?
13 -------------
6708f3f7 »
2012-02-03 Updated docs.
14
edbc3c9d »
2011-05-07 Big README updates.
15 This is ``narcissus``. It is a web application that visualizes web server hits
b798552c »
2011-05-07 Too much emphasis.
16 as they happen in real time.
edbc3c9d »
2011-05-07 Big README updates.
17
18 Features:
19
20 * IP addresses converted to latitude/longitude, then streamed via
21 `orbited <http://http://orbited.org/>`_ and plotted on `polymaps
22 <http://polymaps.org/>`_.
23 * Realtime graphs of url-hit distribution with `jQuery flot
24 <http://code.google.com/p/flot/>`_.
25 * Colorized raw logs streamed to the browser by way of `ccze
26 <http://freshmeat.net/projects/ccze/>`_ and `ansi2html
27 <http://pypi.python.org/pypi/ansi2html>`_.
b2fd9ad6 »
2011-04-16 Doc updates
28 * `AMQP (Advanced Message Queueing Protocol)
29 <http://www.amqp.org/confluence/display/AMQP/Advanced+Message+Queuing+Protocol>`_
edbc3c9d »
2011-05-07 Big README updates.
30 from logs to browser.
31 * **Fast**. Little to no handshaking overhead.
32
33 The Story
34 ---------
35 ``narcissus`` was written on April 15th, 2011 at the `hackfest` hosted by the
5b6f8e4a » decause
2011-05-07 Tweaks to the about page.
36 FOSSBox at `Rochester Institute of Technology <http://www.rit.edu>`_.
edbc3c9d »
2011-05-07 Big README updates.
37
38 We knew that `mirror.rit.edu <http://mirror.rit.edu>`_ was cool, fast, and was
39 the site with the heaviest traffic on RIT's entire network, but looking at a
40 mirror frontpage or silently updating your Linux distribution in the background
5b6f8e4a » decause
2011-05-07 Tweaks to the about page.
41 is not very flashy--not something to phone home about. We wanted to make
42 something cool. Something that would show the 'big picture' of the Open Source
43 world. We feel we did that with ``narcissus``.
edbc3c9d »
2011-05-07 Big README updates.
44
5b6f8e4a » decause
2011-05-07 Tweaks to the about page.
45 The RIT FOSSbox is the launch pad for all things Free & Open Source Software
46 (FOSS) at RIT. It is parented both by the `Center for Student Innovation
47 <http://www.rit.edu/academicaffairs/centerforstudentinnovation/>`_ (physically)
2e1dae2e » decause
2011-05-07 Fixed a busted link
48 and the Lab for Technological Literacy's `FOSS@RIT Initiative
49 <http://foss.rit.edu>`_ (virtually). They have great `staff
5b6f8e4a » decause
2011-05-07 Tweaks to the about page.
50 <http://foss.rit.edu/people>`_, `mentors <http://foss.rit.edu/mentors>`_, and
51 students who all work on `amazing stuff <http://foss.rit.edu/projects>`_. If
52 you read their `history <http://foss.rit.edu/history>`_ you can learn all sorts
53 of neat things about their work on the One Laptop Per Child project.
edbc3c9d »
2011-05-07 Big README updates.
54
55 The ``narcissus`` authors got together and got the proof-of-concept (and some
56 bling-bling) working in a single afternoon but really it was the space, time,
57 and environment provided by the FOSSbox that made it possible.
58
59 This project could **not** have happened without the hard work of `Remy
60 DeCausemaker <https://opensource.com/users/remyd>`_, the "FOSSBoss" and
5b6f8e4a » decause
2011-05-07 Tweaks to the about page.
61 backbone of the FOSSbox. He and his students have made countless contributions
62 at cost to self that push the limits in the art of software development and
63 code culture on campus, and should be recognized therefore. Together with `Luke
4cf69afc »
2012-03-28 No more wordpress.
64 Macken <http://lewk.org>`_, `RJ Bean <http://threebean.org/blog>`_, the
5b6f8e4a » decause
2011-05-07 Tweaks to the about page.
65 power of `Moksha <http://fedorahosted.org/moksha>`_, and the support of the
66 Grey Beards, RIT has become a real center of gravity for the FOSS Movement.
b2fd9ad6 »
2011-04-16 Doc updates
67
68 Live Demo
69 ---------
edbc3c9d »
2011-05-07 Big README updates.
70 You can see ``narcissus`` running live at `narcissus.rc.rit.edu
71 <http://narcissus.rc.rit.edu>`_.
72
73 The Research Computing department at the Rochester Institute of Technology runs
74 that ``narcissus`` instance. It is pointed at their **very** active `FOSS mirror
75 <http://mirror.rit.edu>`_. (That site is the highest-traffic site at RIT!)
b2fd9ad6 »
2011-04-16 Doc updates
76
edbc3c9d »
2011-05-07 Big README updates.
77 Source
78 ------
6708f3f7 »
2012-02-03 Updated docs.
79
edbc3c9d »
2011-05-07 Big README updates.
80 Get the source from `github.com <http://github.com/ralphbean/narcissus>`_.
b2fd9ad6 »
2011-04-16 Doc updates
81
82 Running
83 -------
6708f3f7 »
2012-02-03 Updated docs.
84
163c518e »
2011-05-06 Updated install instructions.
85 On your machine that will host `narcissus`, say, ``monitoring.host.org``,
6708f3f7 »
2012-02-03 Updated docs.
86 create ``~/.moksha/ctl.conf`` with the following content::
b2fd9ad6 »
2011-04-16 Doc updates
87
6708f3f7 »
2012-02-03 Updated docs.
88 narcissus_source_location = /home/threebean/narc/narcissus
89 moksha_source_location = /home/threebean/narc/moksha
b2fd9ad6 »
2011-04-16 Doc updates
90
163c518e »
2011-05-06 Updated install instructions.
91 Then run the following commands::
b2fd9ad6 »
2011-04-16 Doc updates
92
b0c0b9ed »
2011-05-06 Updated install instructions
93 $ mkdir narc && cd narc
94 $ git clone git://github.com/ralphbean/narcissus.git
95 $ git clone git://github.com/ralphbean/moksha.git
96
6708f3f7 »
2012-02-03 Updated docs.
97 $ pushd moksha && git checkout dev && popd
f52eda38 »
2011-05-10 Added instructions in case fab restart breaks.
98
6708f3f7 »
2012-02-03 Updated docs.
99 $ pushd narcissus
100 $ ./narc-ctl.py bootstrap
101 $ ./narc-ctl.py rebuild
102 $ ./narc-ctl.py start
103 $ ./narc-ctl.py wtf
104 $ ./narc-ctl.py logs
f52eda38 »
2011-05-10 Added instructions in case fab restart breaks.
105
163c518e »
2011-05-06 Updated install instructions.
106 Finally, on the machine that is being monitored, say, ``monitored.host.org``,
107 run the following to setup the narcissus `sending` script::
108
109 $ sudo su -
110 $ yum install inotail python-qpid
111
112 $ mkdir narc && cd narc
113 $ git clone git://github.com/ralphbean/narcissus.git
114
115 And to run it and send stuff to your `monitoring` host::
116
117 $ inotail -f /var/log/lighttpd/access.log | \
118 ./narcissus/scripts/amqp-log-sender.py --target=monitoring.host.org
119
120 ``inotail`` is faster than ``tail``, btw.
121
643f799d »
2011-05-06 Added gotcha.
122 Gotchas
123 -------
124 - Watch out for iptables on ports 9000, 5672, 8080, and 8000.
125
edbc3c9d »
2011-05-07 Big README updates.
126 IRC
127 ---
128 Try us in ``#moksha`` on ``irc.freenode.net``.
129
b2fd9ad6 »
2011-04-16 Doc updates
130 Authors
131 -------
6708f3f7 »
2012-02-03 Updated docs.
132 * Ralph Bean <rbean@redhat.com>
edbc3c9d »
2011-05-07 Big README updates.
133
4cf69afc »
2012-03-28 No more wordpress.
134 * http://threebean.org
edbc3c9d »
2011-05-07 Big README updates.
135
b2fd9ad6 »
2011-04-16 Doc updates
136 * Luke Macken <lmacken@redhat.com>
edbc3c9d »
2011-05-07 Big README updates.
137
138 * `lewk.org <http://lewk.org>`_
139
b2fd9ad6 »
2011-04-16 Doc updates
140 * Lee Burton <lburton@mrow.org>
141
edbc3c9d »
2011-05-07 Big README updates.
142 * `mrow.org <http://mrow.org>`_
143
144
b2fd9ad6 »
2011-04-16 Doc updates
145 .. split here
146
147 Powered by
148 ----------
6708f3f7 »
2012-02-03 Updated docs.
149 .. image:: narcissus/raw/master/narcissus/public/images/moksha.png
b2fd9ad6 »
2011-04-16 Doc updates
150 :align: left
151 :scale: 100 %
152 :alt: Moksha
153 :target: https://fedorahosted.org/moksha/
Something went wrong with that request. Please try again.