Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion metrics-collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,20 @@ ibmcloud ce jobrun submit \

The metrics collector scrapes CPU/Memory metrics from your Code Engine applications, jobs, and builds. Metrics of all running instances are scraped every 30 seconds.

Once, metrics are ingested into an IBM Cloud Monitoring instance, the pre-populated dashboard "IBM Cloud Code Engine - Component Resource Overview" appears in Dashboard Manager.
Once, metrics are ingested into an IBM Cloud Monitoring instance, the pre-populated dashboard "Code Engine - Component Resource Overview" appears in Dashboard Manager. No manual dashboard upload is required. Allow a few minutes for the first data to arrive.

![](./images/monitoring-dashboard-library.png)

The dashboard provides the following panels. Use the `code_engine_project_name`, `component_type` and `component_name` scope filters to narrow them down.

- **Components with Running Instances** / **Running Instances** - Number of components and instances currently running
- **Total Available CPUs** / **Total Used CPUs** / **Total CPU Utilization %** - Aggregated CPU capacity, usage and utilization
- **Total Available Memory** / **Total Used Memory** / **Total Memory Utilization %** - Aggregated memory capacity, usage and utilization
- **CPU Utilization % (by Component)** - CPU utilization per component
- **CPU Usage (per Instance)** - Raw CPU usage per instance
- **Memory Utilization % (by Component)** - Memory utilization per component
- **Memory Usage (per Instance)** - Raw memory usage per instance

#### Exposed Metrics

The following Prometheus metrics are exposed as gauges:
Expand Down Expand Up @@ -396,6 +406,12 @@ app:"codeengine" AND message.metric:"instance-resources"
- **Missing `/etc/secrets/monitoring-apikey` file**: Ensure the secret is created and properly mounted
- **Invalid API key**: Regenerate the monitoring API key and update the secret

**Dashboard Not Showing Data:**
- Verify the metrics collector is running with `METRICS_ENABLED=true`
- Check that metrics are being sent to IBM Cloud Monitoring
- Ensure the Prometheus remote write configuration is correct
- Wait a few minutes for data to appear (initial scrape interval)

**General Issues:**
- **Missing or wrong `METRICS_REMOTE_WRITE_FQDN`**: Verify the endpoint matches your region's ingestion endpoint
- **Prometheus agent fails to start**: Check the logs for configuration errors or network connectivity issues
Expand Down
344 changes: 0 additions & 344 deletions metrics-collector/setup/ibm-cloud-monitoring/README.md

This file was deleted.

Loading
Loading