Skip to content

Commit 389511b

Browse files
author
Adriel Perkins
authored
feat: add delivery metrics demo page and update nav (#38)
Also downgrades watchdog due to caching issue. Closes #19
1 parent 91fb7b1 commit 389511b

File tree

6 files changed

+81
-30
lines changed

6 files changed

+81
-30
lines changed

docs/delivery-demo.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Delivery Metrics Demo via GitHub and OpenTelemetry
2+
3+
## Introduction
4+
5+
Welcome to the Delivery Metrics demo page! This demo is a fork of the
6+
[OpenTelemetry Demo][oteldemo] leveraging the [Liatrio OTEL
7+
Collector][lotelcol] distribution in an additional profile to provide the
8+
following additional capabilities:
9+
10+
* Leading delivery indicators from GitHub using the Git Provider Receiver
11+
* DORA Metrics from GitHub through the WebHook Event Receiver
12+
13+
[oteldemo]: https://opentelemetry.io/docs/demo/
14+
[lotelcol]: https://github.com/liatrio/liatrio-otel-collector
15+
16+
At this point in time, the demo fork is only extended to work locally via Docker.
17+
18+
## Getting Started
19+
20+
### Prerequisites
21+
22+
* The same set of prerequisites defined for the [OpenTelemetry Demo](https://opentelemetry.io/docs/demo/docker-deployment/#prerequisites)
23+
* Any prerequisites defined in the [Delivery Demo Documentation](https://github.com/liatrio/opentelemetry-demo/blob/main/docs/delivery.md)
24+
25+
### General Commands
26+
27+
Once those docs are reviewed and prerequisites met run either (or both):
28+
29+
* `make start-delivery`
30+
* `make start-dora`
31+
32+
If setup via the guide in the demo, then you should start to see metrics like the below screenshots by navigating to Grafana:
33+
34+
* Grafana: http://localhost:8080/grafana/
35+
36+
<img src="../img/delivery-metrics-dashboard-1.png" width="1000">
37+
<img src="../img/delivery-metrics-dashboard-2.png" width="1000">
38+
378 KB
Loading
380 KB
Loading

mkdocs.yml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,18 @@ repo_url: https://github.com/liatrio/openo11y.dev
6161
nav:
6262
- "Welcome to Open O11y": "index.md"
6363
- "Why Metrics Matter": "./why-metrics-matter.md"
64-
- "Human Systems":
65-
- "Observing Human Systems": "./human-systems/observing-human-systems.md"
66-
- "Delivery Metrics":
67-
- "Overview": "./human-systems/delivery-metrics/overview.md"
68-
- "Lagging Inidicators": "./human-systems/delivery-metrics/lagging-delivery-indicators.md"
69-
- "Leading Inidicators": "./human-systems/delivery-metrics/leading-delivery-indicators.md"
70-
- "DevEx & Platform": "./human-systems/delivery-metrics/devex-platform.md"
71-
- "Satisfaction & Well-Being": "./human-systems/delivery-metrics/satisfaction-well-being.md"
72-
- "Business Systems": "./business-systems.md"
64+
- "Guidance":
65+
- "Human Systems":
66+
- "Observing Human Systems": "./human-systems/observing-human-systems.md"
67+
- "Delivery Metrics":
68+
- "Overview": "./human-systems/delivery-metrics/overview.md"
69+
- "Lagging Inidicators": "./human-systems/delivery-metrics/lagging-delivery-indicators.md"
70+
- "Leading Inidicators": "./human-systems/delivery-metrics/leading-delivery-indicators.md"
71+
- "DevEx & Platform": "./human-systems/delivery-metrics/devex-platform.md"
72+
- "Satisfaction & Well-Being": "./human-systems/delivery-metrics/satisfaction-well-being.md"
73+
- "Business Systems": "./business-systems.md"
74+
- "Demos":
75+
- "Delivery Metrics Demo": "./delivery-demo.md"
7376
# - "O11y Quick Start Platform":
7477
# - "Overview": "./platform/README.md"
7578
# - "Architecture": "./platform/architecture.md"

poetry.lock

Lines changed: 30 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ readme = "README.md"
1313
python = "^3.11"
1414
mkdocs = "^1.5.2"
1515
mkdocs-material = "^9.1.21"
16+
watchdog = "~3.0.0"
1617

1718

1819
[build-system]

0 commit comments

Comments
 (0)