--- name: satellite-health title: Logging for Satellite description: Integrate Satellite and other IBM Cloud resources with IBM® Cloud Logs to get a comprehensive view and tools to manage all your resources. last-updated: 2025-06-05 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/satellite?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Logging for Satellite {: #health} Integrate Satellite and other IBM Cloud resources with IBM® Cloud Logs to get a comprehensive view and tools to manage all your resources. {: shortdesc} Logging for your Satellite location and for the IBM Cloud services that run in your location must be set up separately. For example, to collect logs for your Satellite location setup, you enable an IBM Cloud Logs instance to collect platform logs in the same region that your location is managed from. Then, to collect logs for a Red Hat OpenShift on IBM Cloud cluster that runs in your Satellite location, you create a logging agent in your cluster to automatically collect and forward pod logs to an IBM Cloud Logs instance. Note that you can use the same IBM Cloud Logs instance to collect logs for both your Satellite location and services that run in your Satellite location. ## Setting up IBM Cloud Logs for Satellite location platform logs {: #setup-la} Forward and view logs that are automatically generated for your Satellite location setup in an IBM Cloud Logs instance that is enabled for platform-level logs. {: shortdesc} ### Enabling platform logs {: #enable-la} If you already have an IBM Cloud Logs instance in the same IBM Cloud region that your Satellite location is managed from, and the IBM Cloud Logs instance is configured to collect platform logs, the logs that are generated for your Satellite location are automatically forwarded to this IBM Cloud Logs instance. Otherwise, follow these steps to set up IBM Cloud Logs for your Satellite location. {: shortdesc} 1. [Provision an IBM Cloud Logs instance](https://cloud.ibm.com/catalog){: external} in the same IBM Cloud region that your Satellite location is managed from. 2. [Enable the instance for platform-level log collection](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-cl-platform-logs&format=markdown). Note that within one region, only one IBM Cloud Logs instance can be enabled for platform logs collection. ### Viewing logs for your Satellite location {: #view-la} Because the IBM Cloud Logs instance is enabled for platform-level log collection, logs for all IBM Cloud Logs-integrated services are shown in the IBM Cloud Logs dashboard. You can apply filters to view only logs for your Satellite location. {: shortdesc} 1. In the [**Logging** dashboard](https://cloud.ibm.com/observe/logging){: external}, click **Open Dashboard** for your IBM Cloud Logs instance. 2. In the Filters toolbar, click **Sources**, select `satellite`, and click **Apply**. The logs for all your Satellite locations in the region are shown. 3. To filter for a specific Satellite location, click **Apps** in the Filters toolbar, select the CRN for your Satellite location, and click **Apply**. To identify the CRN for your location, get your location ID by running `ibmcloud sat location ls`, look for this location's ID at the end of the listed CRNs. For more tips on identifying logs in the dashboard, review how you can [search and filter logs](https://cloud.ibm.com/docs/cloud-logs?topic=cloud-logs-query-data-filter&format=markdown). {: tip} ### Analyzing logs for your Satellite location {: #analyze-la} Use logs that are automatically generated for your Satellite location to monitor and maintain its health. {: shortdesc} #### How often are logs posted? {: #analyze-la-time} Logs are collected for your location and posted every 60 seconds. #### What kinds of logs are collected? {: #analyze-la-types} By default, three types of logs are automatically generated for your Satellite location: [`R00XX`-level error messages](#logs-error), [the status of whether resource deployment to the location is enabled](#logs-deploy), and [the status of Satellite Link](#logs-link). Review the following sections for an example of each log type and descriptions of each log field. #### How can I set up alerts for location error logs? {: #analyze-la-alert} You can use the built-in IBM Cloud Logs dashboard tools to save log searches and set up alerts for certain types of logs, such as errors. 1. To filter for a specific Satellite location, click **Apps** in the Filters toolbar, select the CRN for your Satellite location, and click **Apply**. To identify the CRN for your location, look for the location's ID at the end of the CRN. 2. Search for a specific query that you want an alert for. For example, to be alerted for any logs that contain `R00XX`-level location error messages, search for `R00`. To be alerted for Satellite Link health check failures, search for `Failed to reach endpoint`. 3. Click **Unsaved view > Save as new view**. Add a name and an optional category. 4. In the **Alert** drop-down list, select **View-specific alert** and follow the steps for the notification channel that you selected to configure a custom alert for this log query. 5. Click **Save view**. #### Is IBM alerted for any of these logs? {: #analyze-la-monitor} The IBM Cloud Monitoring component generates certain alerts for issues with your location setup and host infrastructure. To review the alerts that IBM monitors, see [IBM monitoring to resolve and report location alerts](https://cloud.ibm.com/docs/satellite?topic=satellite-monitor&format=markdown#monitoring-default). ### `R00XX` error logs {: #logs-error} `R00XX` error logs report messages and more detailed information about issues with your location setup and host infrastructure. For more information about each `R00XX` error message, including troubleshooting steps, see [Location error messages](https://cloud.ibm.com/docs/satellite?topic=satellite-ts-locations-debug&format=markdown). {: shortdesc} Example log ```sh {"logSourceCRN":"crn:v1:bluemix:public:satellite:us-south:a/f601ad712b0dd981276cf3b995554afc:c1hk4ek107l5au5mq8hg::","saveServiceCopy":true,"Details":{"message":"R0025: The Satellite location has OpenShift clusters in critical health.","errorDetails":"Customer etcd cluster moved down to 1 or less available pods. Quorum broke. Manual recovery of cluster needed.","messageID":"R0025"}} ``` {: screen} |Log field|Description| |---------|-----------| |`logSourceCRN`|The CRN of the Satellite location. To identify the CRN for a location, look for the location's ID at the end of the CRN.| |`saveServiceCopy`|Set to `true` so that a copy of the log record is sent to IBM for monitoring and alerts.| |`Details`|The detailed information for log.| |`Details.message`|The current error message for the location, including any troubleshooting steps or documentation links.| |`Details.errorDetails`|Other details for the current error, such as specific causes or issues with certain components. These details are used by IBM site reliability engineers to manage alerts, but can help provide more details about the issue while you troubleshoot.| |`Details.messageID`|The error message's `R00XX` identifier.| {: caption="Pre-defined fields for R00XX error logs" caption-side="bottom"} ### Enablement of resource deployment logs {: #logs-deploy} Enablement of resource deployment logs report the current status of whether resources such as hosts, clusters, or Satellite-enabled IBM Cloud service instances can be changed or deployed in your location, and the reason for this status. For example, resource deployment might be set to false due to one or more location errors. {: shortdesc} Example log ```sh {"logSourceCRN":"crn:v1:bluemix:public:satellite:us-south:a/f601ad712b0dd981276cf3b995554afc:c1hk4ek107l5au5mq8hg::","saveServiceCopy":true,"message":"Enablement of resource deployment in the location is set false due to R0012: The location control plane does not have hosts in all 3 zones. Add available hosts to your location for the control plane. R0025: The Satellite location has OpenShift clusters in critical health."} ``` {: screen} |Log field|Description| |---------|-----------| |`logSourceCRN`|The CRN of the Satellite location. To identify the CRN for a location, look for the location's ID at the end of the CRN.| |`saveServiceCopy`|Set to `true` so that a copy of the log record is sent to IBM for monitoring and alerts.| |`message`|The status of whether resource deployment is currently enabled (`true` or `false`). If set to `false`, the current `R00XX`-level error messages for the location are listed.| {: caption="Pre-defined fields of logs for the status of deployment enablement" caption-side="bottom"} ### Endpoint health status logs {: #logs-link} Endpoint health status logs report the current health check status of the Satellite Link tunnel server endpoint. For more information, see [Why is IBM Cloud unable to check my location's health?](https://cloud.ibm.com/docs/satellite?topic=satellite-ts-location-healthcheck&format=markdown). {: shortdesc} - If logs report `Successfully checked endpoint`, your Satellite Link tunnel server endpoint is reachable and healthy. - If logs report `Failed to reach endpoint`, your Satellite Link tunnel server endpoint is unreachable. Example log ```sh {"logSourceCRN":"crn:v1:bluemix:public:satellite:us-east:a/6ef045fd2b43266cfe8e6388dd2ec098:c0rcidjw0s3rf9v8sms0::","saveServiceCopy":true,"message":"Endpoint health status: Failed to reach endpoint. Get \"http://c-03.us-east.link.satellite.cloud.ibm.com:32900\": read tcp 172.XX.XXX.XXX:58564-\u003e166.9.XX.XXX:32900: read: connection reset by peer. Endpoint: http://c-03.us-east.link.satellite.cloud.ibm.com:32900"} ``` {: screen} |Log field|Description| |---------|-----------| |`logSourceCRN`|The CRN of the Satellite location. To identify the CRN for a location, look for the location's ID at the end of the CRN.| |`saveServiceCopy`|Set to `true` so that a copy of the log record is sent to IBM for monitoring and alerts.| |`message`|The status of whether your Satellite Link tunnel server endpoint is reachable, and the endpoint that was health checked.| {: caption="Pre-defined fields for endpoint health status logs" caption-side="bottom"} ## Setting up IBM Cloud Logs for Satellite location events {: #setup-at} To track how users and applications interact with your Satellite location, IBM Cloud Satellite automatically generates user-initiated management events and forwards these event logs to IBM Cloud Logs. {: shortdesc} To access these logs, provision an instance of IBM Cloud Logs in the same region that your location is managed from. For more information about the types of Satellite events that you can track, see [Auditing events for Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-at_events&format=markdown). ## Setting up logging for clusters {: #setup-clusters-logging} To understand and set up logging for Red Hat OpenShift clusters that run in your Satellite location, see the tutorials in the [IBM Cloud Logs documentation](https://cloud.ibm.com/docs/cloud-logs?format=markdown). {: shortdesc} You cannot currently use the Red Hat OpenShift on IBM Cloud console to enable logging for Satellite clusters. You must [manually deploy logging agents to your cluster](#enable-clusters-logging) to forward logs to IBM Cloud Logs. {: note} ### Enabling a logging instance in your cluster {: #enable-clusters-logging} To enable a logging instance in your Satellite cluster, you must manually install the logging agent in the cluster. {: shortdesc} 1. Locate an existing logging instance that you want to install in your cluster. The logging instance must be in the same region where your cluster's Satellite location is managed from. 2. From the [Logging](https://cloud.ibm.com/observe/logging){: external} page, click the logging instance. 3. Click **Logging sources** and navigate to the **Red Hat OpenShift** tab. 4. Follow the instructions in the **Red Hat OpenShift** tab to install the logging agent. Step 5 **Install the OpenShift DaemonSet** mentions YAML files for **Public Endpoint** and **Private Endpoint**. You can manually edit those YAML files (`agent-resources-openshift.yaml` and `agent-resources-openshift-private.yaml`) to use the `satellite-logdna` link endpoint address so that you don't need to open up new firewall rules.