diff --git a/docs/4-explainer.md b/docs/4-explainer.md index 1595c77..d49d79b 100644 --- a/docs/4-explainer.md +++ b/docs/4-explainer.md @@ -84,4 +84,4 @@ As explained previously the Keptn Lifecycle Toolkit also provides a way to run S ![keptn evaluation label](assets/keptn-eval-label.png) -➡️ Next: [Deploy Slow Application Version](5-deploy-slow-version.md) ➡️ \ No newline at end of file +➡️ Next: [View Telemetry](5-view-telemetry.md) ➡️ diff --git a/docs/5-view-telemetry.md b/docs/5-view-telemetry.md new file mode 100644 index 0000000..2128529 --- /dev/null +++ b/docs/5-view-telemetry.md @@ -0,0 +1,30 @@ +# View Deployment Telemetry + +Keptn emits DORA metrics and OpenTelemetry traces for every deployment. + +In the codespace, go to the `Ports` tab and open Grafana. + +Login with these details: + +- Username: `admin` +- Password: `admin` + +* Go to "Dashboards > Browse" +* Open the "Keptn Applications" dashboard in the "Default" folder + +You should see: + +* 1 successful deployment +* Zero failed deployments +* Zero active deployments (this metrics tracks currently-in-progress deployments) +* Zero data for "time between deployments" (this is calculated when there are > 1 deployments) +* A deployment time (in seconds) for `V1.1` +* An OpenTelemetry trace for the `V1.1` deployment + +![telemetry 1](assets/telemetry-1.png) + +Clicking the OpenTelemetry trace displays the end-to-end timings of the deployment as ArgoCD actioned it. + +![telemetry 2](assets/telemetry-2.png) + +➡️ Next: [Deploy a Slow Version of the Application](6-deploy-slow-version.md) ➡️ \ No newline at end of file diff --git a/docs/5-deploy-slow-version.md b/docs/6-deploy-slow-version.md similarity index 100% rename from docs/5-deploy-slow-version.md rename to docs/6-deploy-slow-version.md diff --git a/docs/assets/telemetry-1.png b/docs/assets/telemetry-1.png new file mode 100644 index 0000000..9e5a256 Binary files /dev/null and b/docs/assets/telemetry-1.png differ diff --git a/docs/assets/telemetry-2.png b/docs/assets/telemetry-2.png new file mode 100644 index 0000000..66fe2f1 Binary files /dev/null and b/docs/assets/telemetry-2.png differ diff --git a/mkdocs.yml b/mkdocs.yml index d4d7271..564ccac 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,7 +36,8 @@ nav: - '2: Create Kubernetes Cluster': '2-create-cluster.md' - '3: Access ArgoCD': '3-access-argo.md' - '4: The System Explained': '4-explainer.md' - - '5: Roll out Slow Version': '5-deploy-slow-version.md' + - '5: View Telemetry': '5-view-telemetry.md' + - '6: Roll out Slow Version': '6-deploy-slow-version.md' # pip install mkdocs-macros-plugin # Allows use of variables (see `extras` below)