<commit_before>Titan
=====

Titan was designed with one large goal in mind, continuous reporting. The framework is tied closely with the Mac OS X core to detect an active Internet connection and push any reports which may have been blocked. 

Origination
-----------
Titan spawned from the hard work of the MIDAS/Tripyarn project, a Etsy/Facebook masterpiece. Although effective, MIDAS uses syslog as a reporting mechanism. This is great, but we already log over 500 million logs a day from our services. We wanted to create a RESTful interface with anomaly detection and hooks that can report and take action immediately, rather than having to parse through a butt-load of logs at a later time.

Features
--------

The following features are currently supported in Titan:

  - Easy 3rd-party module installation
  - Dynamic module loading
  - Added PHP runtime for modules
  - Inventory management __[in dev]__
  - Local report viewing __[in dev]__
  - Customizable reporting mechanism __[in dev]__

Usage
-----

### Installation:

### Configuration:

### Adding Modules:

### Creating Modules:


Contributors
---------------------------

#### Titan Contributors

+ __<NAME>__ ([@mikemackintosh](https://twitter.com/mikemackintosh))

#### Original MIDAS Contributors
<commit_msg>added location to readme<commit_after>Titan
=====

Titan was designed with one large goal in mind, continuous reporting. The framework is tied closely with the Mac OS X core to detect an active Internet connection and push any reports which may have been blocked. 

Origination
-----------
Titan spawned from the hard work of the MIDAS/Tripyarn project, a Etsy/Facebook masterpiece. Although effective, MIDAS uses syslog as a reporting mechanism. This is great, but we already log over 500 million logs a day from our services. We wanted to create a RESTful interface with anomaly detection and hooks that can report and take action immediately, rather than having to parse through a butt-load of logs at a later time.

Features
--------

The following features are currently supported in Titan:

  - Easy 3rd-party module installation
  - Dynamic module loading
  - Added PHP runtime for modules
  - Inventory management __[in dev]__
  - Local report viewing __[in dev]__
  - Customizable reporting mechanism __[in dev]__

Usage
-----

### Installation:



### Configuration:

Default configuration expects Titan to exist in `/usr/local/titan/`. 

### Adding Modules:

### Creating Modules:


Contributors
---------------------------

#### Titan Contributors

+ __<NAME>__ ([@mikemackintosh](https://twitter.com/mikemackintosh))

#### Original MIDAS Contributors

{'fraction_non_alphanumeric': 0.09795763993948563, 'fraction_numerical': 0.0030257186081694403, 'mean_word_length': 3.6, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '273470', 'n_tokens_mistral': 704, 'n_tokens_neox': 651, 'n_words': 331}