# Cadvisor

**🟡 Monitoring Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | cadvisor |
| **Host** | setillo |
| **Category** | Monitoring |
| **Difficulty** | 🟡 |
| **Docker Image** | `gcr.io/cadvisor/cadvisor:latest` |
| **Compose File** | `setillo/prometheus/compose.yaml` |
| **Directory** | `setillo/prometheus` |

## 🎯 Purpose

cadvisor is a monitoring and observability tool that helps track system performance and health.

## 🚀 Quick Start

### Prerequisites
- Docker and Docker Compose installed
- Basic understanding of REDACTED_APP_PASSWORD
- Access to the host system (setillo)

### Deployment
```bash
# Navigate to service directory
cd setillo/prometheus

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f cadvisor
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
command:
- --docker_only=true
container_name: Prometheus-cAdvisor
cpu_shares: 512
hostname: prometheus-cadvisor
image: gcr.io/cadvisor/cadvisor:latest
mem_limit: 256m
mem_reservation: 64m
networks:
- prometheus-net
read_only: true
restart: on-failure:5
security_opt:
- no-new-privileges=true
volumes:
- /:/rootfs:ro
- /var/run:/var/run:ro
- /sys:/sys:ro
- /var/run/docker.sock:/var/run/docker.sock:ro

```

### Environment Variables
No environment variables configured.

### Port Mappings
No ports exposed.

### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/` | `/rootfs` | bind | Data storage |
| `/var/run` | `/var/run` | bind | Data storage |
| `/sys` | `/sys` | bind | Data storage |
| `/var/run/docker.sock` | `/var/run/docker.sock` | bind | Data storage |


## 🌐 Access Information

This service does not expose any web interfaces.

## 🔒 Security Considerations

- ✅ Security options configured
- ⚠️ Consider running as non-root user
- ✅ Read-only root filesystem

## 📊 Resource Requirements

No resource limits configured

### Recommended Resources
- **Minimum RAM**: 512MB
- **Recommended RAM**: 1GB+
- **CPU**: 1 core minimum
- **Storage**: Varies by usage

### Resource Monitoring
Monitor resource usage with:
```bash
docker stats
```

## 🔍 Health Monitoring

⚠️ No health check configured
Consider adding a health check:
```yaml
healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
  interval: 30s
  timeout: 10s
  retries: 3
```

### Manual Health Checks
```bash
# Check container health
docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME

# View health check logs
docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME
```

## 🚨 Troubleshooting

### Common Issues
**Service won't start**
- Check Docker logs: `docker-compose logs service-name`
- Verify port availability: `netstat -tulpn | grep PORT`
- Check file permissions on mounted volumes

**Can't access web interface**
- Verify service is running: `docker-compose ps`
- Check firewall settings
- Confirm correct port mapping

**Performance issues**
- Monitor resource usage: `docker stats`
- Check available disk space: `df -h`
- Review service logs for errors

**Metrics not collecting**
- Check target endpoints are accessible
- Verify configuration syntax
- Check network connectivity

### Useful Commands
```bash
# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f cadvisor

# Restart service
docker-compose restart cadvisor

# Update service
docker-compose pull cadvisor
docker-compose up -d cadvisor

# Access service shell
docker-compose exec cadvisor /bin/bash
# or
docker-compose exec cadvisor /bin/sh
```

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for cadvisor
- **Docker Hub**: [gcr.io/cadvisor/cadvisor:latest](https://hub.docker.com/r/gcr.io/cadvisor/cadvisor:latest)
- **Community Forums**: Search for community discussions and solutions
- **GitHub Issues**: Check the project's GitHub for known issues

## 🔗 Related Services

Services REDACTED_APP_PASSWORD cadvisor:
- Grafana
- Prometheus
- Uptime Kuma
- Node Exporter

---

*This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.*

**Last Updated**: 2025-11-17  
**Configuration Source**: `setillo/prometheus/compose.yaml`
