Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 108 lines (59 sloc) 2.833 kB
4af4c39 @msmathers Adding log.io to github
msmathers authored
1 Log.io - Real-time log monitoring in your browser
2 =================================================
3
4 Powered by [node.js](http://nodejs.org) + [socket.io](http://socket.io)
5
6 ## How does it work?
7
4ae3c25 @msmathers README fixes
msmathers authored
8 *Harvesters* watch log files for changes, send new log messages to the *server*, which broadcasts to *web clients*.
9
10 Users create *stream* and *history* screens to view and search log messages.
4af4c39 @msmathers Adding log.io to github
msmathers authored
11
12 ## Requirements
13
14 [node.js](http://nodejs.org)
e88a88f @msmathers Updated README
msmathers authored
15
d15d525 @msmathers Added package.json, file cleanup
msmathers authored
16 [socket.io v0.6.17](http://socket.io) (Log.io is currently incompatible with socket.io v0.7.x)
e88a88f @msmathers Updated README
msmathers authored
17
4af4c39 @msmathers Adding log.io to github
msmathers authored
18 [connect](http://senchalabs.github.com/connect/)
e88a88f @msmathers Updated README
msmathers authored
19
20 [underscore](http://documentcloud.github.com/underscore/)
21
e074aa8 @msmathers Fixes broken Socket.io-node-client dependency.
msmathers authored
22 [Socket.io-node-client](https://github.com/msmathers/Socket.io-node-client)
4af4c39 @msmathers Adding log.io to github
msmathers authored
23
24 ## Compatibility
25
e074aa8 @msmathers Fixes broken Socket.io-node-client dependency.
msmathers authored
26 Harvesters & server have been tested on *Ubuntu 11.04*
4af4c39 @msmathers Adding log.io to github
msmathers authored
27
e88a88f @msmathers Updated README
msmathers authored
28 Web clients have been tested on *Chrome*, *Safari*, and *Firefox*.
4af4c39 @msmathers Adding log.io to github
msmathers authored
29
30 # Install log server on Machine A
31
823849c @msmathers README markdown updates
msmathers authored
32 1) Download source
e88a88f @msmathers Updated README
msmathers authored
33
34 git clone git://github.com/NarrativeScience/Log.io.git log.io
35
823849c @msmathers README markdown updates
msmathers authored
36 2) Verify dependencies
4af4c39 @msmathers Adding log.io to github
msmathers authored
37
e88a88f @msmathers Updated README
msmathers authored
38 cd log.io/bin
39 ./configure
4af4c39 @msmathers Adding log.io to github
msmathers authored
40
823849c @msmathers README markdown updates
msmathers authored
41 3) Install & launch server
4af4c39 @msmathers Adding log.io to github
msmathers authored
42
e88a88f @msmathers Updated README
msmathers authored
43 sudo ./install/server
44
823849c @msmathers README markdown updates
msmathers authored
45 4) Browse to:
e88a88f @msmathers Updated README
msmathers authored
46
d15d525 @msmathers Added package.json, file cleanup
msmathers authored
47 http://machine_a.host.com:8998
e88a88f @msmathers Updated README
msmathers authored
48
823849c @msmathers README markdown updates
msmathers authored
49 5) Configure port, add HTTP basic auth (Optional)
6d5a544 @msmathers Pushing Log.io to Github
msmathers authored
50
d15d525 @msmathers Added package.json, file cleanup
msmathers authored
51 Modify /etc/log.io/server.conf
6d5a544 @msmathers Pushing Log.io to Github
msmathers authored
52
53 sudo /etc/init.d/log.io-server restart
4af4c39 @msmathers Adding log.io to github
msmathers authored
54
55 # Install log harvester on Machine B
56
823849c @msmathers README markdown updates
msmathers authored
57 1) Download source
e88a88f @msmathers Updated README
msmathers authored
58
59 git clone git://github.com/NarrativeScience/Log.io.git log.io
4af4c39 @msmathers Adding log.io to github
msmathers authored
60
823849c @msmathers README markdown updates
msmathers authored
61 2) Verify dependencies
4af4c39 @msmathers Adding log.io to github
msmathers authored
62
e88a88f @msmathers Updated README
msmathers authored
63 cd log.io/bin
64 ./configure
65
823849c @msmathers README markdown updates
msmathers authored
66 3) Install harvester
e88a88f @msmathers Updated README
msmathers authored
67
68 sudo ./install/harvester
69
823849c @msmathers README markdown updates
msmathers authored
70 4) Configure harvester (modify /etc/log.io/harvester.conf)
6d5a544 @msmathers Pushing Log.io to Github
msmathers authored
71
823849c @msmathers README markdown updates
msmathers authored
72 - Server host
73 - Local log files
4af4c39 @msmathers Adding log.io to github
msmathers authored
74
823849c @msmathers README markdown updates
msmathers authored
75 5) Start harvester
e88a88f @msmathers Updated README
msmathers authored
76
77 sudo /etc/init.d/log.io-harvester start
4af4c39 @msmathers Adding log.io to github
msmathers authored
78
79 ## Credits
80
81 - Mike Smathers <msmathers@narrativescience.com> ([msmathers](http://github.com/msmathers))
82
4ae3c25 @msmathers README fixes
msmathers authored
83 - Narrative Science http://narrativescience.com ([NarrativeScience](http://github.com/NarrativeScience))
4af4c39 @msmathers Adding log.io to github
msmathers authored
84
85 ## Acknowledgements
86
87 - Guillermo Rauch <guillermo@learnboost.com> ([Guille](http://github.com/guille))
88
4ae3c25 @msmathers README fixes
msmathers authored
89 - Ryan Dahl <ry at tiny clouds dot org> ([ry](https://github.com/ry)) + Joyent http://www.joyent.com/ ([joyent](https://github.com/joyent/))
4af4c39 @msmathers Adding log.io to github
msmathers authored
90
e074aa8 @msmathers Fixes broken Socket.io-node-client dependency.
msmathers authored
91 - Remy Sharp <remy@leftlogic.com> ([remy](https://github.com/remy))
92
4af4c39 @msmathers Adding log.io to github
msmathers authored
93 ## License
94
95 Copyright 2011 Narrative Science <contrib@narrativescience.com>
96
97 Licensed under the Apache License, Version 2.0 (the "License");
98 you may not use this file except in compliance with the License.
99 You may obtain a copy of the License at
100
101 http://www.apache.org/licenses/LICENSE-2.0
102
103 Unless required by applicable law or agreed to in writing, software
104 distributed under the License is distributed on an "AS IS" BASIS,
105 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
106 See the License for the specific language governing permissions and
107 limitations under the License.
Something went wrong with that request. Please try again.