View fleet logs

This page describes how to enable and view logs for fleets. With fleet logging, multiple logs are aggregated and scoped together, enabling you to analyze the health of your applications in one consolidated view. This page is intended for:

• Platform administrators who want to enable fleet logging and view logs in all namespaces.
• Service operators who want to view logs in the specific namespaces to which they have access.

Overview

Fleet logs let you view logs at the entire fleet level, or for specific team scopes. Scopes are a team-management feature that let you define subsets of fleet logs and other resources on a per-team basis, with each scope associated with one or more fleet member clusters. For more information on scopes, see Manage teams for your fleet .

You can view two types of fleet logs:

• Default logs: All Kubernetes logs (except Audit logs ) that don't belong to any specific fleet scope with the following resource types :

  • k8s_container
  • k8s_pod
  • k8s_node
  • k8s_cluster
  • k8s_control_plane_components

• Fleet scope logs: Container and Pod logs for applications owned by a team deployed in a specific fleet scope with multiple fleet-level namespaces.

Viewing fleet scope logs is optional. If you don't want to set up team management, you can still use fleet logging to view default logs.

Logs can be routed to different log buckets in the fleet host project with different views for access control. The default retention period of a log bucket is 30 days. You can configure this period if needed.

There are two modes supported for log routing where fleets contain clusters from multiple projects ( cross-project registration ):

• MOVE : All logs are moved to the fleet host project. If a cluster in the fleet belongs to a different project, their logs are not retained in the original Google Cloud project.

• COPY : All logs are sent to the fleet host project. If a cluster in the fleet belongs to a different project, their logs are also retained in the original Google Cloud project.

Before you begin

1. If you have already manually created Cloud Logging buckets , sinks , and set exclusion filters , ensure that the names you have assigned these objects don't conflict with the fleet logging naming restrictions . If there is a naming conflict, contact Support before proceeding.

2. Ensure that the clusters whose logs you want to view have been registered to your chosen fleet .

3. If you don't have it installed already, install the Google Cloud CLI following the installation instructions . You need version 424.0.0 or higher to view your fleet logs.

4. Ensure that your fleet host project has all the required APIs enabled, including the Anthos API:

   gcloud services enable --project= FLEET_HOST_PROJECT_ID 
   \
   gkehub.googleapis.com \
   container.googleapis.com \
   connectgateway.googleapis.com \
   cloudresourcemanager.googleapis.com \
   iam.googleapis.com \
   anthos.googleapis.com

   where:

   • FLEET_HOST_PROJECT_ID is the project ID of your fleet host project. Learn how to find this value .

Prepare scopes, namespaces and workloads

If you want to view fleet scope logs, you will need to create a fleet scope and a fleet namespace, in addition to preparing workloads for log collection.

Before you continue, set the default project for the Google Cloud CLI by running the following command:

gcloud config set project FLEET_HOST_PROJECT_ID 

Create scopes and namespaces

If you want to view logs at the scope level, and haven't already set up scopes, follow the instructions in Manage teams for your fleet to create scopes, add clusters to scopes, and set up fleet namespaces.

Prepare workloads

To view log data from your applications, you will need to deploy your workloads in a cluster to the fleet namespace configured in the preceding step. This step is applicable whether you choose to view default logs, fleet scope logs, or both. Here is an example to configure your workload:

   
apiVersion:  
v1  
kind:  
Pod  
metadata:  
name:  
fleet-example-pod  
namespace:  
 NAMESPACE_NAME 
  
spec:  
containers:  
-  
name:  
count  
image:  
ubuntu:14.04  
args:  
 [ 
bash,  
-c,  
 'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done' 
 ] 
 

After deploying the resource, you may see an error if the fleet namespace failed to create for some reason. In this case, run the following command to create the namespace again, and rerun the workload deployment command:

kubectl create namespace NAMESPACE_NAME