Log scopes, a powerful tool for managing logs from various projects, with permissions and control handled through log views in a log bucket.
Do your observability technologies make it difficult to distinguish the relevant data from the rest of the data? Focusing on the important aspects of your career may become challenging as a result.
You can find the log entries you wish to examine or analyze more quickly by using the log scopes creation and management instructions provided in this document. This document isn’t for you if all you want to do is view and examine the log entries that come from a specific project, folder, or organization. However, the information in this page may be able to assist you in finding certain log entries more quickly if you utilize log views or rely on log sinks to route logs to user-defined log bucket or other projects.
There is no instruction on how to examine your logs in this document. Regarding that subject, refer to View logs with the Logs Explorer.
Concerning log scopes
Log scopes are project-level, permanent resources that provide a list of resources to look for log entries. Projects, folders, organizations, and log views can all be included in a log scope. You could create a log scopes, for instance, that lists the projects containing production-use resources, or one that lists the log views containing log entries for a particular kind of resource.
Logging produces a log scope called Default when you create a Google Cloud project, folder, or organization resource. The project, folder, or organization that was made is included in this scope. The log entries that start in the resource and end up in a log bucket are among the outcomes of a search of these resources. In the case of projects, the search results also contain log entries that are saved in a log bucket after being routed to the project by a sink in another project.
Log scopes can be made. The log scopes you create can also be edited or removed. On the other hand, the Default log scope cannot be edited or removed.
The collection of resources that the Logs Explorer page searches when it opens for projects is determined by the default log scopes. But which log items are fetched from storage depend on your Identity and Access Management (IAM) responsibilities on the searched resources and the time-range setting. The Default log scope is set as the default log scope when a project is created. Which log scopes is used by default can be changed.
Best methods
Google cloud advise creating log scopes for complex search configurations since they give you an opportunity to establish and store a configuration for later usage.
Assume, for instance, that you are troubleshooting a problem and that you would like to see all of your team’s virtual machine (VM) instances’ log entries. You could complete this challenge by doing the following:
- You find that the log entries you wish to view are spread across several projects and log bucket. There is a log view that contains the log entries you wish to see for the majority of log bucket. If there isn’t already a log view, you can make one.
- You anticipate needing to perform a similar troubleshooting operation in the future, so you decide to build a log scope.
- To choose a new log scope, enter the Google Cloud console’s Logs Explorer page and pick it using the Refine scope option.
- After going throughout the log entries, you discover the details you require to fix the problem you were looking into.
- You inform your coworkers of the failure cause after resolving the issue. You also mention that you anticipate seeing failures of this nature in the future, so you made a log scope that will enable you or the person looking into the failure to locate pertinent log entries with ease.
Limitations
- No, you cannot remove or edit the Default log scope.
- A default log scope is supported only by Google Cloud projects.
- A user-defined log scope cannot have files or organizations added to it.
- The creation and management of log scopes is not supported by the Google Cloud CLI or the Cloud Logging API.
Google cloud is thrilled to present log scopes for Cloud Logging today, a significant improvement in the management and analysis of your company’s logs. A designated collection of interesting logs from the same or various projects is called a log scope. They consist of collections of log views that manage and authorize a portion of the logs within a log bucket.
Log buckets
Consider the following scenario: your company has two log buckets, log bucket A (which contains log views X, Y, and Z) and log bucket B (which contains log views M and N). Now that log views X and Y from log bucket A and log view M from log bucket B are included, you may make a log scope Q.
Log scopes, in conjunction with metrics scopes, enable you to build a set of connected telemetry for your application, which can subsequently be referred to for insights or speedier debugging.
Log scopes with sample use cases
To help you understand the value proposition of the log scope, below are a few sample use cases.
Use case 1: When a company employs a centralized log storage architecture, comparing metrics with logs from the same application
To manage configurations, access control, and costs more easily, your firm may have used a bucket sink to route all logs from apps to a centralized project.
In light of this configuration, you might wish to make an observability view specifically for your application within your project. This is exactly what you can do when you combine log scopes with metrics scopes, as Figure 1 below illustrates.
To accomplish this, in your project (Project App1), construct a log scope that points to App1’s log view in Project Central.
Use case 2: Linking metrics to logs for isolated environments throughout projects, including development, staging, and production
Production, staging, and development environments are examples of separated settings that your company could choose to monitor apps . As demonstrated below, it is now simple to group logs for every isolated environment into a log scope.
Start using log scopes now
The Google Cloud console now offers log scopes. A default log scope has been set for each project in the console, and you can create additional log scopes based on your organization’s requirements.
Choose the Settings option from the left-hand navigation bar on any Cloud Observability page, such as Logging, Monitoring, Trace, or Error Reporting, to start a log scope. To build and maintain a log scope, according to the on-screen instructions.
