Added logging/metrics information, removed hosted thing in main README. (#183)

README.md

@@ -1,5 +1,13 @@
 # IronFunctions
 
+Welcome to IronFunctions!  The open source Functions as a Service platform.
+
+## Join Our Community
+
+First off, join the community!
+
+[![Slack Status](https://open-iron.herokuapp.com/badge.svg)](https://open-iron.herokuapp.com)
+
 ## Quickstart
 
 This guide will get you up and running in a few minutes.
@@ -49,6 +57,8 @@ The app `myapp` that we created above along with the `/hello` route we added wou
 curl http://localhost:8080/r/myapp/hello
 ```
 
+Or just surf to it: http://localhost:8080/r/myapp/hello
+
 ### Passing data into a function
 
 Your function will get the body of the HTTP request via STDIN, and the headers of the request will be passed in as env vars. Try this:
@@ -98,36 +108,19 @@ You will get a `call_id` in the response:
 {"call_id":"572415fd-e26e-542b-846f-f1f5870034f2"}
 ```
 
-If you watch the logs, you will see the function actually runs in the background.
+If you watch the logs, you will see the function actually runs in the background:
+
+![async log](docs/async-logs.png)
+
+Read more on [logging](docs/logging.md).
 
 ## Writing Functions
 
 TODO: 
 
-See examples for now. 
-
-## Using IronFunctions Hosted by Iron.io
-
-Simply point to https://functions.iron.io instead of localhost and add your Iron.io Authentication header (TODO: link), like this:
-
-```sh
-curl -H "Authorization: Bearer IRON_TOKEN" -H "Content-Type: application/json" -X POST -d '{"app": {"name":"myapp"}}' https://functions.iron.io/v1/apps
-```
-
-And you'll get an ironfunctions.com host for your app:
-
-```sh
-myapp.USER_ID.ironfunctions.com/hello
-```
-
 ## More Documentation
 
-* [IronFunctions Options](api.md)
+See [docs/](docs/) for full documentation. 
-* [Running in Production](docs/production.md)
-* [Triggers](docs/triggers.md)
-* [Metrics](docs/metrics.md)
-* [Extending IronFunctions](docs/extending.md)
-* [API Reference](https://swaggerhub.com/api/iron/functions)
 
 ## Join Our Community
 

docs/README.md

@@ -1,10 +1,12 @@
 
 # IronFunctions Documentation
 
-* [Running IronFunctions](api.md)
+* [IronFunctions Options](api.md)
+* [API Reference](https://app.swaggerhub.com/api/iron/functions/)
+* [Running in Production](production.md)
 * [Databases](databases/README.md)
 * [Message Queues](mqs/README.md)
-* [Running in Production](production.md)
+* [Logging](logging.md)
-* [Triggers](triggers.md)
 * [Metrics](metrics.md)
+* [Triggers](triggers.md)
 * [Extending IronFunctions](extending.md)

docs/logging.md

@@ -0,0 +1,32 @@
+# Logging
+
+There are a few things to note about what IronFunctions logs. 
+
+## Logspout
+
+We recommend using [logspout](https://github.com/gliderlabs/logspout) to forward your logs to a log aggregator of your choice. 
+
+## Format
+
+All logs are emitted in [logfmt](https://godoc.org/github.com/kr/logfmt) format for easy parsing. 
+
+## Call ID
+
+Every function call/request is assigned a `call_id`. If you search your logs, you can track all the activity 
+for each function call and find errors on a call by call basis. For example, these are the log lines for an aynschronous
+function call:
+
+![async logs](async-log-full.png)
+
+Note the easily searchable `call_id=x` format. 
+
+```sh
+call_id=477949e2-922c-5da9-8633-0b2887b79f6e
+```
+
+## Metrics
+
+Metrics are emitted via the logs. 
+
+See [Metrics](metrics.md) doc for more information. 
+

docs/metrics.md

@@ -1,10 +1,25 @@
 # Metrics
 
-TODO: Explain metrics format. Log Metric Format - LMF(AO)
+Metrics are emitted via the logs for few couple of reasons:
+
+1) Everything supports STDERR.
+2) User can optionally use them, if not, they just end up in the logs. 
+3) No particular metrics system required, in other words, all metrics systems can be used via adapters (see below).
+
+## Metrics
+
+The metrics format follows logfmt format and looks like this:
 
 ```
 metric=someevent value=1 type=count
 metric=somegauge value=50 type=gauge
 ```
 
+It's a very simple format that can be easily parsed by any logfmt parser and passed on to another stats service. 
+
 TODO: List all metrics we emit to logs.
+
+## Statsd
+
+The [Logspout Statsd Adapter](https://github.com/iron-io/logspout-statsd) adapter can parse the log metrics and forward
+them to any statsd server.