Fixes and docs

dev/audit-log-review/README.md

@@ -0,0 +1,66 @@
+# Audit Log Review
+
+### Loading audit logs into apisnoop
+
+Once you have the audit logs for the app, you can turn them into an interactive graph of the endpoints and methods that were requested by the app.
+
+Some setup is required
+```
+cd dev/audit-log-review
+pip install -r requirements.txt
+```
+
+To load the audit log into the database
+```
+python logreview.py load-audit <audit log path> <app name>
+```
+
+Now that the log is in the database, lets start the webserver and have a look
+```
+python logreview.py start-server
+```
+
+Go to `http://localhost:9090` in a web browser
+
+Click `Apps` then the app name and you will get a graph that looks similar to this:
+
+![app_sunburst_screenshot.png](../../docs/images/app_sunburst_screenshot.png)
+
+### Loading e2e coverage test audit logs
+
+To see the coverage graph from the Kubernetes e2e tests obtained from Sonobuoy or manually, load the logs using the name **e2e**
+```
+python logreview.py load-audit <audit log path> e2e
+```
+
+Now start the webserver
+```
+python logreview.py start-server
+```
+and go to `http://localhost:9090` in a web browser
+
+Click `e2e` and you will get a graph that looks similar to this:
+
+![e2e_sunburst_screenshot.png](../../docs/images/e2e_sunburst_screenshot.png)
+
+### Exporting data
+
+If you want to export data as csv files
+
+```
+python logreview.py export-data <exporter name> <output csv path> <app name>
+```
+`exporter name` can be one of:
+
+- **app-usage-categories**: breakdown of API categories an app is using
+- **app-usage-summary**: summary of alpha / beta / stable API usage
+- **app-usage-endpoints**: a list of endpoints and methods the app connects to
+- **coverage-spreadsheet**: combines conformance google sheets data with endpoint hit counts
+
+From the CSV, you can easily preview in terminal by using the command
+
+`cat <output csv path> | tr "," " " | column -t`
+
+Example output
+
+![summary_export_example.png](docs/images/summary_export_example.png)

dev/audit-log-review/www/sunburst/sequences.js

@@ -263,7 +263,7 @@ function mouseover(d) {
           .text("untested")
     } else {
       d3.select("#reallybigline")
-          .html("<img src=\"img/tick.png\">")
+          .html("<img src=\"/static/img/tick.png\">")
       d3.select("#bigline")
           .text("Tested")
       d3.select("#midline")