chore(docs): add getting started guide to docs

docs/docs/deploy/aws-eks.md → docs/docs/deploy/aws/aws-eks.md

@@ -6,4 +6,4 @@ a [deployment](https://github.com/intergral/deep/tree/master/examples/kubernetes
 ## Configure
 
 Before you can use any of the examples that use AWS S3 you will need to create an IAM role to allow DEEP access to the
-bucket. See [AWS/Permissions](./aws/permissions.md) for more info.
+bucket. See [AWS/Permissions](permissions.md) for more info.

docs/docs/deploy/local.md

@@ -1,4 +1,4 @@
-# Deploy DEEP Locally
+# Deploy Locally
 
 The easiest way to evaluate DEEP and to test the features is to deploy the stack locally. To do this there a few
 examples using docker compose available in the [main repo](https://github.com/intergral/deep/tree/master/examples/docker-compose). 

docs/docs/getstarted.md

@@ -0,0 +1,85 @@
+# Getting Started
+
+On this page we will cover how to get started with DEEP using the local docker compose stack.
+
+## Prerequisites
+
+To follow this guide you will need to install:
+
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- [Docker](https://docs.docker.com/engine/install/)
+- [Docker Compose](https://docs.docker.com/compose/)
+
+## Guide
+
+To start deep using the local docker stack follow these steps:
+
+1. Checkout the repo
+   ```bash
+   git checkout https://github.com/intergral/deep.git
+   ```
+2. Open the example directory
+   ```bash
+   cd examples/docker-compose/local
+   ```
+3. Start the services
+   ```bash
+   docker compose up -d
+   ```
+
+At this point docker will start the required containers. These will include:
+
+- Deep - running in single tenant and single binary mode
+- Prometheus - collecting metrics from deep
+- Grafana - with datasource's connecting to Deep and Prometheus (this is currently a custom-built image with the deep
+  plugins installed)
+- Test App - A simple test app running python that can be used as the target to debug
+
+## Using Deep
+
+Now that we have deep running and a test app connected we want to see what we can do.
+
+1. Open Grafana to the [explore page](http://localhost:3000/explore).
+2. Ensure that the Deep data source is selected. (Should be the default datasource)
+3. Now open the query input to create a tracepoint:
+
+![Tracepoint Create](./images/Explore_TracepointCreate.png)
+
+4. Here we can enter the file and line number to collect data. In this example we want to use:
+    - File Path: simple_test.py
+    - Line Number: 31
+
+   Once set click 'Create Tracepoint' to create the tracepoint.
+7. If created successfully you will see the result in the query result below:
+
+![Tracepoint List](./images/Explore_TracepointList.png)
+
+8. This new config will be sent to the connected client and will result in a Snapshot being created. To see the
+   Snapshots click on the lint in the column 'Tracepoint ID'. This will create a split view and show the available
+   Snapshots.
+
+   Note: It can take up to a minute before the Snapshot will be available in the results.
+
+![Snapshot Result](./images/Explore_SnapshotSplitView.png)
+
+9. From this you can now select a snapshot from the list to view the full details.
+
+![Snapshot Panel](./images/Explore_SnapshotPanel.png)
+
+Now you know how to create tracepoints and view the data you can play with creating other tracepoints, or changing the
+settings to collect watches, or change the fire count. 
+
+The source code for the test app is open source [intergral/python-deep-client/examples](https://github.com/intergral/deep-python-client/tree/master/examples) 
+
+
+## Clean up
+To clean up this example you simple need to remove the compose stack.
+
+```bash
+docker compose down -v
+```
+
+You will also might want to remove the stored data
+```bash
+rm -Rf deep-data
+```

docs/docs/index.md

@@ -11,7 +11,7 @@ on [GitHub](https://github.com/intergra/deep)
 To use deep you need to deploy the service, there are a few options for this:
 
 - [Local as a docker compose stack](./deploy/local.md)
-- [Using AWS EKS](./deploy/aws-eks.md)
+- [Using AWS EKS](deploy/aws/aws-eks.md)
 
 Once the service is deployed you will need to setup a client and connect Grafana to the service.
 

docs/mkdocs.yml

@@ -10,3 +10,13 @@ copyright: Intergral GmbH 2023
 
 theme:
   name: material
+
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences

examples/docker-compose/debug/docker-compose.yaml

@@ -35,16 +35,12 @@ services:
       - GF_AUTH_ANONYMOUS_ENABLED=true
       - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
       - GF_AUTH_DISABLE_LOGIN_FORM=true
-      - GF_FEATURE_TOGGLES_ENABLE=traceqlEditor
     ports:
       - "3000:3000"
 
   test_app:
     image: ghcr.io/intergral/deep-python-client:simple-app
     environment:
       - DEEP_SERVICE_SECURE=False
-      - DEEP_LOGGING_CONF=/etc/client_logging.conf
-    volumes:
-      - ../shared/client_logging.conf:/etc/client_logging.conf
     depends_on:
       - deep

examples/docker-compose/distributed/docker-compose.yaml

@@ -110,9 +110,6 @@ services:
     environment:
       - DEEP_SERVICE_URL=distributor:43315
       - DEEP_SERVICE_SECURE=False
-      - DEEP_LOGGING_CONF=/etc/client_logging.conf
-    volumes:
-      - ../shared/client_logging.conf:/etc/client_logging.conf
     depends_on:
       - distributor
 
@@ -135,6 +132,5 @@ services:
       - GF_AUTH_ANONYMOUS_ENABLED=true
       - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
       - GF_AUTH_DISABLE_LOGIN_FORM=true
-      - GF_FEATURE_TOGGLES_ENABLE=traceqlEditor
     ports:
       - "3000:3000"

examples/docker-compose/local/docker-compose.yaml

@@ -34,16 +34,12 @@ services:
       - GF_AUTH_ANONYMOUS_ENABLED=true
       - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
       - GF_AUTH_DISABLE_LOGIN_FORM=true
-      - GF_FEATURE_TOGGLES_ENABLE=traceqlEditor
     ports:
       - "3000:3000"
 
   test_app:
     image: ghcr.io/intergral/deep-python-client:simple-app
     environment:
       - DEEP_SERVICE_SECURE=False
-      - DEEP_LOGGING_CONF=/etc/client_logging.conf
-    volumes:
-      - ../shared/client_logging.conf:/etc/client_logging.conf
     depends_on:
       - deep

examples/docker-compose/s3/docker-compose.yaml

@@ -30,9 +30,6 @@ services:
     image: ghcr.io/intergral/deep-python-client:simple-app
     environment:
       - DEEP_SERVICE_SECURE=False
-      - DEEP_LOGGING_CONF=/etc/client_logging.conf
-    volumes:
-      - ../shared/client_logging.conf:/etc/client_logging.conf
     depends_on:
       - deep