Skip to content

getting-started.md

Latest commit

 

History

History
87 lines (59 loc) · 1.87 KB

getting-started.md

File metadata and controls

87 lines (59 loc) · 1.87 KB
Raw

Getting Started

Prerequisites

  • Docker (24+) with Docker Compose V2
  • 4 GB+ RAM available for Docker (OpenSearch needs memory)
  • Ports available: 3000, 4317, 4318, 5601, 9090, 9200, 16686

Quick Start

1. Clone the Repository

git clone https://github.com/TheLoop705/pulse-observability.git
cd pulse-observability

2. Configure Environment

cp .env.example .env
# Optional: edit .env to customize ports, passwords, etc.

3. Start the Stack

docker compose up -d

This starts all 6 core services. First run will pull images (~2 GB).

4. Verify

./scripts/health-check.sh

5. Access the UIs

Service URL Credentials
Grafana http://localhost:3000 admin / pulse
Prometheus http://localhost:9090 —
Jaeger http://localhost:16686 —
OpenSearch Dashboards http://localhost:5601 —

Running the Demo

To see telemetry in action without instrumenting your own app:

docker compose -f docker-compose.yml -f docker-compose.demo.yml up -d --build

Or use the helper:

./scripts/demo.sh

This builds and starts:

  • A Spring Boot demo app (auto-instrumented with OTel Java Agent)
  • A load generator that continuously hits the demo endpoints

Within ~1 minute, you'll see metrics, traces, and logs flowing through the Grafana dashboards.

The demo app is accessible at http://localhost:8080.

Stopping

# Stop everything
./scripts/stop.sh

# Or manually
docker compose -f docker-compose.yml -f docker-compose.demo.yml down

# Remove all data volumes
docker compose down -v

Next Steps