Permalink
Browse files

Updated README, still more work to be done

  • Loading branch information...
1 parent 194ab93 commit fe9732d0415da4e21e120d925d1ae5fe2f26b3ab @jbohman committed Jul 8, 2010
Showing with 53 additions and 24 deletions.
  1. +44 −17 README
  2. +5 −5 config.yaml
  3. +2 −1 logsandra.egg-info/SOURCES.txt
  4. +2 −1 logsandra.egg-info/requires.txt
View
61 README
@@ -1,23 +1,50 @@
Logsandra
+=========
+Logsandra is a log management application written in Python and using Cassandra as back-end.
-Work in progress!
-Requirements:
- - Cassandra + Thrift
- - pycassa
- - PyYaml
- - Python Dateutils
+Requirements
+------------
+Cassandra 0.6 or higher and the following python requirements:
+ * Pylons >= 1.0
+ * Jinja2
+ * PyYAML
+ * Pycassa
+ * python-dateutil
+ * CherryPy >= 3.1
+ * Thrift
+ * ordereddict
+ * Cassandra
-Current keyspace config (for testing purposes only):
+The Cassandra bindings are not automatically installed.
+
+
+Installation
+------------
+To install Logsandra you run this command:
+
+ python setup.py install
+
+It is also possible to directly start using logsandra-httpd.py and logsandra-monitord.py without installing Logsandra to your site-package directory if all
+required modules are all ready installed.
+
+The current keyspace configuration for Cassandra needed for Logsandra to work is:
+
+ <Keyspaces>
+ <Keyspace Name="logsandra">
+ <ColumnFamily Name="entries" CompareWith="BytesType" />
+ <ColumnFamily Name="by_date" CompareWith="LongType" />
+ <ColumnFamily Name="by_date_data" CompareWith="LongType" />
+ <ColumnFamily Name="categories" CompareWith="UTF8Type" />
+ <ReplicaPlacementStrategy>org.apache.cassandra.locator.RackUnawareStrategy</ReplicaPlacementStrategy>
+ <ReplicationFactor>1</ReplicationFactor>
+ <EndPointSnitch>org.apache.cassandra.locator.EndPointSnitch</EndPointSnitch>
+ </Keyspace>
+ </Keyspaces>
+
+The keyspace definition might be obsolete in future releases of Cassandra (0.7+) where you can programmatically create and drop keyspaces.
+
+Usage
+-----
-<Keyspaces>
- <Keyspace Name="logsandra">
- <ColumnFamily Name="entries" CompareWith="BytesType" />
- <ColumnFamily Name="by_date" CompareWith="LongType" />
- <ColumnFamily Name="by_date_data" CompareWith="LongType" />
- <ReplicaPlacementStrategy>org.apache.cassandra.locator.RackUnawareStrategy</ReplicaPlacementStrategy>
- <ReplicationFactor>1</ReplicationFactor>
- <EndPointSnitch>org.apache.cassandra.locator.EndPointSnitch</EndPointSnitch>
- </Keyspace>
-</Keyspaces>
View
@@ -1,11 +1,11 @@
# Ident
ident: 'Logsandra Server 1'
-# Webservice
-webservice_enabled: True
-webservice_address: "0.0.0.0"
-webservice_port: 5000
-webservice_config: 'development.ini'
+# Web service
+web_enabled: True
+web_address: "0.0.0.0"
+web_port: 5000
+web_config: 'development.ini'
# Cassandra cluster to connect to
cassandra_address: 'localhost'
@@ -46,4 +46,5 @@ logsandra/tests/test_models.py
logsandra/tests/functional/__init__.py
logsandra/tests/functional/test_log.py
logsandra/utils/__init__.py
-logsandra/utils/daemon.py
+logsandra/utils/daemon.py
+logsandra/utils/model.py
@@ -4,4 +4,5 @@ PyYAML
Pycassa
python-dateutil
CherryPy>=3.1
-Thrift
+Thrift
+ordereddict

0 comments on commit fe9732d

Please sign in to comment.