Monitoring

This documentation is for the CARTO Self-Hosted Legacy Version. Use only if you've installed this specific version. Explore our latest documentation for updated features.

Ensuring the health and status of your CARTO Self-Hosted deployment is crucial for a seamless user experience. Follow the instructions below to verify the status in both the Docker Compose and Kubernetes versions.

Single VM deployments (Docker Compose)

To check the status of your CARTO deployment in the Docker Compose version, follow these steps:

1. Open a terminal.

2. Navigate to your CARTO Self-Hosted installation directory.

3. Check the logs of each container using the following command:

   docker-compose logs -f <service_name>

4. Review the logs for each container and ensure there are no error messages. A healthy deployment will have no critical errors reported in the logs.

Orchestrated container deployment (Kubernetes)

For the Kubernetes version, you can check the status and health of your CARTO deployment with the following steps:

1. Open a terminal or use your preferred Kubernetes management tool.

2. Execute the following command to view the status of all pods:

   kubectl get pods -n <namespace>

3. Check the status column for each pod. A healthy deployment will show Running in the status column.

4. Check the logs of each container using the following command:

   kubectl logs -f <service_name> -n <namespace>

5. Additionally, be aware that CARTO Self-Hosted is designed to internally monitor the health of each container. If any container reaches an unhealthy state, the system will automatically deploy a new container to maintain system stability.

Enable debug mode in CARTO Self-Hosted deployment

Debug mode in CARTO allows you to gather additional information for troubleshooting and diagnosing issues. Follow the steps below to enable the debug mode in a CARTO Self-Hosted installation.

Single VM deployments

Add the following line into your customer.env file and apply the changes:

CARTO_TRACING_MODE=local

Orchestrated container deployment

Update your customizations.yaml file and apply the changes:

importApi:
  extraEnvVars:
    - name: CARTO_TRACING_MODE
      value: "local"
      
importWorker:
  extraEnvVars:
    - name: CARTO_TRACING_MODE
      value: "local"

ldsApi:
  extraEnvVars:
    - name: CARTO_TRACING_MODE
      value: "local"

mapsApi:
  extraEnvVars:
    - name: CARTO_TRACING_MODE
      value: "local"

workspaceApi:
  extraEnvVars:
    - name: CARTO_TRACING_MODE
      value: "local"
      
workspaceSubscriber:
  extraEnvVars:
    - name: CARTO_TRACING_MODE
      value: "local"

By regularly checking the status of your CARTO deployment, you can proactively address any potential issues and ensure a reliable and robust CARTO environment.