Skip to content

Commit

Permalink
image update
Browse files Browse the repository at this point in the history
  • Loading branch information
abhishekbhakat committed Dec 6, 2024
1 parent 894da5d commit 773d7a9
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 18 deletions.
18 changes: 14 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Orbis is a deployment compute report generator tool that analyzes data from Astr

## Quick Start with Docker (Recommended)

!!! warning

Docker images are yet to be released. Will be available soon.

```bash
# Pull the latest version
docker pull quay.io/astronomer/orbis:0.5.0
Expand All @@ -29,11 +33,17 @@ docker run --pull always --rm -it \
## Documentation Sections

- [Installation](installation.md)
- [Configuration](configuration.md)
- [Usage Guide](usage/software_usage.md)
- [CLI Reference](cli.md)
- [Contributing](contributing.md)
- [Changelog](changelog.md)
- Modules
- API
- [Houston](modules/api/houston.md)
- [Prometheus](modules/api/prometheus.md)
- Report
- [Generator](modules/report/generator.md)
- [Visualizer](modules/report/visualizer.md)
- [CSV Generator](modules/report/csv_generator.md)
- [Data Models](modules/data_models.md)
- [Reports](reports.md)

## Support

Expand Down
26 changes: 13 additions & 13 deletions docs/modules/api/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,49 +47,49 @@ This document details all the Prometheus queries used by Orbis to collect metric

```promql
# Scheduler CPU usage rate over 5-minute intervals
rate(container_cpu_usage_seconds_total{namespace="optical-illusion-5432", container="scheduler"}[5m])
rate(container_cpu_usage_seconds_total{namespace="astronomer-optical-illusion-5432", container="scheduler"}[5m])
# Scheduler memory usage in gigabytes
max(container_memory_working_set_bytes{namespace="optical-illusion-5432", container="scheduler"}) by (pod)
max(container_memory_working_set_bytes{namespace="astronomer-optical-illusion-5432", container="scheduler"}) by (pod)
/(1024 * 1024 *1024)
# Total count of successful task instances
sum(airflow_ti_successes{release="astronomer-optical-illusion-5432"})
sum(airflow_ti_successes{release="optical-illusion-5432"})
# Total count of failed task instances
sum(airflow_ti_failures{release="astronomer-optical-illusion-5432"})
sum(airflow_ti_failures{release="optical-illusion-5432"})
# Hourly increase in successful tasks
max(round(increase(airflow_ti_successes{release="astronomer-optical-illusion-5432"}[1h])))
max(round(increase(airflow_ti_successes{release="optical-illusion-5432"}[1h])))
# Hourly increase in failed tasks
max(round(increase(airflow_ti_failures{release="astronomer-optical-illusion-5432"}[1h])))
max(round(increase(airflow_ti_failures{release="optical-illusion-5432"}[1h])))
# Celery workers CPU usage rate over 5-minute intervals
rate(container_cpu_usage_seconds_total{namespace="optical-illusion-5432", container="worker", pod=~"astronomer-optical-illusion-5432-worker-.*"}[5m])
rate(container_cpu_usage_seconds_total{namespace="astronomer-optical-illusion-5432", container="worker", pod=~"astronomer-optical-illusion-5432-worker-.*"}[5m])
# Celery workers memory usage in gigabytes
max(container_memory_working_set_bytes{namespace="optical-illusion-5432", container="worker", pod=~"astronomer-optical-illusion-5432-worker-.*"}) by (pod)
max(container_memory_working_set_bytes{namespace="astronomer-optical-illusion-5432", container="worker", pod=~"astronomer-optical-illusion-5432-worker-.*"}) by (pod)
/(1024 * 1024 *1024)
# Count of Celery worker pods
count(kube_pod_info{namespace="optical-illusion-5432", pod=~"astronomer-optical-illusion-5432-worker-.*"})
count(kube_pod_info{namespace="astronomer-optical-illusion-5432", pod=~"astronomer-optical-illusion-5432-worker-.*"})
# Kubernetes Pod Operator CPU usage
sum(
kube_pod_labels{label_airflow_kpo_in_cluster="True",namespace="optical-illusion-5432"}
kube_pod_labels{label_airflow_kpo_in_cluster="True",namespace="astronomer-optical-illusion-5432"}
* on (pod) group_left()
sum by (pod) (
rate(container_cpu_usage_seconds_total{namespace="optical-illusion-5432",pod!~"astronomer-optical-illusion-5432-.*"}[5m])
rate(container_cpu_usage_seconds_total{namespace="astronomer-optical-illusion-5432",pod!~"astronomer-optical-illusion-5432-.*"}[5m])
)
)
# Kubernetes Pod Operator memory usage in gigabytes
sum(
kube_pod_labels{label_airflow_kpo_in_cluster="True",namespace="optical-illusion-5432"}
kube_pod_labels{label_airflow_kpo_in_cluster="True",namespace="astronomer-optical-illusion-5432"}
* on (pod) group_left()
max by (pod) (
container_memory_working_set_bytes{namespace="optical-illusion-5432",pod!~"astronomer-optical-illusion-5432-.*"}
container_memory_working_set_bytes{namespace="astronomer-optical-illusion-5432",pod!~"astronomer-optical-illusion-5432-.*"}
)
)/(1024 * 1024 *1024)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ Reports are generated in the `output` directory when using Docker:
docker run --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
abhishekbhakat/orbis orbis compute-software \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
-s START_DATE -e END_DATE -o ORGANIZATION_ID
```

0 comments on commit 773d7a9

Please sign in to comment.