Merge pull request #8 from KnowWhereGraph/metrics-endpoint

Add metrics endpoint

Author: ckfisher

README.md

@@ -2,16 +2,6 @@
 
 API service for KnowWhereGraph
 
-## Running
-
-To run the API in a production setting, deploy with docker
-1. `docker build -t kwg-api .`
-2. `docker run -d --name kwg-api -p 8080:8080 kwg-api`
-
-Visit the redoc page at http://127.0.0.1:8080/redoc
-
-Visit the swagger page at http://127.0.0.1:8080/docs
-
 ## Features
 
 - Node de-referencing
@@ -29,23 +19,6 @@ poetry run black .
 poetry run isort .
 ```
 
-### Running Locally
-
-The API can be run locally when developing. To run,
-
-```bash
-poetry install
-poetry run uvicorn kwg_api.main:app --reload --port 80
-```
-
-#### Via Docker
-
-The API can also be run using the `docker-compose.dev.yaml` file with
-
-```commandline
-docker-compose -f docker-compose.local.yaml up
-```
-
 ### Testing
 
 The unit tests can be run through pytest with
@@ -54,6 +27,7 @@ The unit tests can be run through pytest with
 poetry run pytest
 ```
 
+
 ## Building Docs
 
 The API uses the sphinx documentation formation. To build the documentation, first [install sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html).
@@ -64,3 +38,31 @@ Then,
 cd docs
 make build
 ```
+
+## Running
+
+When the API is running, the following pages can be used to play with the endpoint
+
+Visit the redoc page at http://127.0.0.1:8080/redoc
+
+Visit the swagger page at http://127.0.0.1:8080/docs
+
+
+The API can be run locally when developing. To run,
+
+### For local Development
+
+#### Non-Docker
+
+```bash
+poetry install
+poetry run uvicorn kwg_api.main:app --reload --port 80
+```
+
+### With Docker
+
+The API can also be run using the `docker-compose.dev.yaml` file with
+
+```commandline
+docker-compose -f docker-compose.dev.yaml up
+```

docker-compose.dev.yaml

@@ -0,0 +1,13 @@
+version: '3'
+
+services:
+  kwg-api:
+    container_name: kwg-api
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - '8080:8080'
+    environment:
+      - base_address_http=http://staging.knowwheregraph.org
+      - base_address_https=https://staging.knowwheregraph.org

kwg_api/main.py

@@ -3,13 +3,14 @@
 
 import uvicorn
 from fastapi import FastAPI, Request, Response
+from prometheus_fastapi_instrumentator import Instrumentator
 
 from kwg_api.api.node_negotiator import NodeNegotiator
 from kwg_api.lib.prefix_builder import PrefixBuilder
 
-app = FastAPI(title="KnowWhereGraph API", version="1.0.0")
 logging.basicConfig(level=logging.INFO)
-
+app = FastAPI(title="KnowWhereGraph API", version="1.0.0")
+Instrumentator().instrument(app).expose(app)
 
 @app.get(
     "/lod/ontology/{resource_id}",