Generate Logging Query Language queries
Use this skill to generate correct Logging Query Language (LQL) queries for
Cloud Logging.
Attribution
MUST READ: Before executing any gcloud, REST API, or MCP command, you
MUST read Usage Attribution. For commands executed
directly in the terminal (never in generated scripts, Terraform, or user code),
prefix gcloud with
CLOUDSDK_METRICS_REQUEST_ATTRIBUTION="agent-skills/1.0 (skill:cloud-logging-query-generation)"
and append agent-skills/1.0 (skill:cloud-logging-query-generation) to User-Agent headers.
Core rules
Strict syntax requirements:
- Always use double quotes (
") for string literals. Do not use
single quotes (').
- Write boolean operators in all capitals:
AND, OR, NOT.
- Always use parentheses to group terms and explicitly enforce precedence.
Common pitfalls:
- Instance ID vs. Instance Name: For the
gce_instance resource type,
do NOT compare instance names to instance IDs. Instance names are
strings (for example, my-instance). Instance IDs are numeric. If you
only have the name, then search by instance name,
SEARCH("my-instance"), or use resource.labels.instance_name if that
label is available for the resource.
- Resource Type Accuracy: Do not guess resource types. You must look
up the correct
resource.type value in the service-specific reference
files. For example, use internal_http_lb_rule for Internal HTTP(S)
Load Balancer rules when filtering by forwarding rule name or region
(instead of http_load_balancer).
Output format and placeholders:
- Output only the raw LQL query text. Do not include conversational
filler. Do not wrap the query in markdown code blocks unless explicitly
requested by the user. Valid LQL comments (using
--) are allowed, and
are the ONLY acceptable way to include explanations or warnings.
- Never block on missing variables. If the user's request lacks
specific identifiers (like a project ID, instance name, or IP address),
do not ask them for clarification. If the variable is required for a
functional query (like a log bucket name for a regional log), insert an
uppercase placeholder string wrapped in angle brackets (for example,
"<PROJECT_ID>"). CRITICALLY: If you include a placeholder for a
variable the user omitted, it will act as an explicit filter that causes
logs to be missed. Therefore, you MUST omit the entire filter/line
containing the placeholder if the field is not strictly required. For
example, completely omit resource.labels.instance_id="..." if the user
didn't specify an instance, but you MUST include
logName=".../projects/<PROJECT_ID>/..." with a placeholder if
constructing a regional log bucket query where a project ID is strictly
required.
Preferred fields:
- Include
resource.type and log_id restrictions when the query targets
specific Google Cloud services or resources. Global queries (for
example, "latest error logs") do not require these restrictions.
Detailed reference
Refer to references/api_reference.md for LQL syntax rules, including
Operators, NULL handling, SEARCH, and Regex.
Service reference files
Before generating a query, you MUST read the examples for the specific service.
LQL schemas and resource.type values are service-specific. Do not stop
reading after finding the Base Schema in the file. You must verify if there are
specific requirements for state tracking (like previousState) or
resource-specific log IDs detailed in the paragraphs or specific query examples
below the schema block.
For the following services, read the exact file listed:
- App Engine
- BigQuery
- Cloud Deployment Manager
- Cloud Functions
- Cloud Observability (Monitoring, Logging, Trace)
- Cloud Run
- Cloud Source Repositories
- Cloud Spanner
- Cloud SQL
- Cloud Storage
- Cloud Tasks
- Compute Engine (GCE)
- Dataflow
- Dataproc
- Kubernetes Engine (GKE)
- IAM & Service Accounts
- Networking (VPC, Load Balancing, and others)
- Security (Audit logging)
- Service Usage (Enable/Disable API, Quotas)
- Third Party (for example, Nginx, Apache)
For Google Cloud services that aren't listed: If the service is not listed
above, write the LQL query based on your general knowledge.
Query generation rules
- Resource Types: Explicitly define the
resource.type in your queries
when focusing on specific services. For some queries, you may need to search
across multiple types (for example, resource.type=("bigquery_project" OR "bigquery_dataset")).
- Audit and Admin Logs: If the user asks for audit logs, admin logs, API
logs, or logs about who created, updated, deleted, read, or accessed a
resource:
- You MUST read
references/query_audit_logs.md for the
correct
protoPayload schema paths and common examples.
- If a specific example is not listed, guess the
protoPayload.methodName
by combining the service and verb. When guessing, you MUST use the
scoped SEARCH() function (e.g., SEARCH(protoPayload.methodName, "compute.instances.insert")) instead of the exact match operator (=)
to avoid version prefix mismatches. Do NOT use the colon operator (:)
as it may cause substring false positives.
- For generic API enable/disable events (e.g., a service was disabled),
always use
resource.type="audited_resource".
- Handling Unknown Schemas (Crucial): If the user asks to filter by a
specific field or condition, and if you cannot find a matching example or
schema in the reference files, then you must generate a query using global
search.
- Only specify
jsonPayload.* or protoPayload.* field structures when
you are certain of their exact name.
- Use the
SEARCH() function to find the keyword globally within the
correct resource.type.
- Mandatory LQL Comment: When delivering a query that uses
SEARCH,
you MUST add an LQL comment (using --) at the top of the query
indicating you used a global keyword search because the exact schema
wasn't in your references. Do NOT output conversational text, strictly
adhere to the Output Format rule.
Supporting links
1---2name: cloud-logging-query-generation-23metadata:4 source: https://skillmd.com/skills/google/cloud-logging-query-generation-25 version: "1.0.2"6 category: CloudObservabilityAndMonitoring7description: >-8 Generates Logging Query Language (LQL) queries for Cloud Logging on Google Cloud from natural language. Use this skill when you need to query log data or when you are debugging issues. You can filter log data by Google Cloud service. Don't use this skill to query other databases, such as SQL or Cloud Spanner.9---1011# Generate Logging Query Language queries1213Use this skill to generate correct Logging Query Language (LQL) queries for14Cloud Logging.1516## Attribution1718**MUST READ**: Before executing any `gcloud`, REST API, or MCP command, you19MUST read [Usage Attribution](references/attribution.md). For commands executed20directly in the terminal (never in generated scripts, Terraform, or user code),21prefix `gcloud` with22`CLOUDSDK_METRICS_REQUEST_ATTRIBUTION="agent-skills/1.0 (skill:cloud-logging-query-generation)"`23and append `agent-skills/1.0 (skill:cloud-logging-query-generation)` to `User-Agent` headers.2425## Core rules26271. **Strict syntax requirements:**2829 * **Always use double quotes (`"`)** for string literals. Do not use30 single quotes (`'`).31 * Write boolean operators in all capitals: `AND`, `OR`, `NOT`.32 * Always use parentheses to group terms and explicitly enforce precedence.33342. **Common pitfalls:**3536 * **Instance ID vs. Instance Name:** For the `gce_instance` resource type,37 do NOT compare instance names to instance IDs. Instance names are38 strings (for example, `my-instance`). Instance IDs are numeric. If you39 only have the name, then search by instance name,40 `SEARCH("my-instance")`, or use `resource.labels.instance_name` if that41 label is available for the resource.42 * **Resource Type Accuracy:** Do not guess resource types. You must look43 up the correct `resource.type` value in the service-specific reference44 files. For example, use `internal_http_lb_rule` for Internal HTTP(S)45 Load Balancer rules when filtering by forwarding rule name or region46 (instead of `http_load_balancer`).47483. **Output format and placeholders:**4950 * Output **only** the raw LQL query text. Do not include conversational51 filler. Do not wrap the query in markdown code blocks unless explicitly52 requested by the user. Valid LQL comments (using `--`) are allowed, and53 are the ONLY acceptable way to include explanations or warnings.54 * **Never block on missing variables.** If the user's request lacks55 specific identifiers (like a project ID, instance name, or IP address),56 do not ask them for clarification. If the variable is required for a57 functional query (like a log bucket name for a regional log), insert an58 uppercase placeholder string wrapped in angle brackets (for example,59 `"<PROJECT_ID>"`). **CRITICALLY**: If you include a placeholder for a60 variable the user omitted, it will act as an explicit filter that causes61 logs to be missed. Therefore, you MUST omit the entire filter/line62 containing the placeholder if the field is not strictly required. For63 example, completely omit `resource.labels.instance_id="..."` if the user64 didn't specify an instance, but you MUST include65 `logName=".../projects/<PROJECT_ID>/..."` with a placeholder if66 constructing a regional log bucket query where a project ID is strictly67 required.68694. **Preferred fields:**7071 * Include `resource.type` and `log_id` restrictions when the query targets72 specific Google Cloud services or resources. Global queries (for73 example, "latest error logs") do not require these restrictions.7475## Detailed reference7677Refer to `references/api_reference.md` for LQL syntax rules, including78Operators, NULL handling, SEARCH, and Regex.7980## Service reference files8182Before generating a query, you MUST read the examples for the specific service.83LQL schemas and `resource.type` values are service-specific. **Do not stop84reading after finding the Base Schema in the file. You must verify if there are85specific requirements for state tracking (like `previousState`) or86resource-specific log IDs detailed in the paragraphs or specific query examples87below the schema block.**8889**For the following services, read the exact file listed:**9091* [App Engine](references/query_app_engine.md)92* [BigQuery](references/query_bigquery.md)93* [Cloud Deployment Manager](references/query_deployment_manager.md)94* [Cloud Functions](references/query_cloud_functions.md)95* [Cloud Observability (Monitoring, Logging, Trace)](references/query_cloud_observability.md)96* [Cloud Run](references/query_cloud_run.md)97* [Cloud Source Repositories](references/query_cloud_source_repositories.md)98* [Cloud Spanner](references/query_spanner.md)99* [Cloud SQL](references/query_cloud_sql.md)100* [Cloud Storage](references/query_cloud_storage.md)101* [Cloud Tasks](references/query_cloud_tasks.md)102* [Compute Engine (GCE)](references/query_compute_engine.md)103* [Dataflow](references/query_dataflow.md)104* [Dataproc](references/query_dataproc.md)105* [Kubernetes Engine (GKE)](references/query_gke.md)106* [IAM & Service Accounts](references/query_iam.md)107* [Networking (VPC, Load Balancing, and others)](references/query_networking.md)108* [Security (Audit logging)](references/query_security.md)109* [Service Usage (Enable/Disable API, Quotas)](references/query_service_usage.md)110* [Third Party (for example, Nginx, Apache)](references/query_third_party.md)111112**For Google Cloud services that aren't listed:** If the service is not listed113above, write the LQL query based on your general knowledge.114115## Query generation rules1161171. **Resource Types:** Explicitly define the `resource.type` in your queries118 when focusing on specific services. For some queries, you may need to search119 across multiple types (for example, `resource.type=("bigquery_project" OR120 "bigquery_dataset")`).1212. **Audit and Admin Logs:** If the user asks for audit logs, admin logs, API122 logs, or logs about who created, updated, deleted, read, or accessed a123 resource:124 * You MUST read125 [references/query_audit_logs.md](references/query_audit_logs.md) for the126 correct `protoPayload` schema paths and common examples.127 * If a specific example is not listed, guess the `protoPayload.methodName`128 by combining the service and verb. When guessing, you MUST use the129 scoped `SEARCH()` function (e.g., `SEARCH(protoPayload.methodName,130 "compute.instances.insert")`) instead of the exact match operator (`=`)131 to avoid version prefix mismatches. Do NOT use the colon operator (`:`)132 as it may cause substring false positives.133 * For generic API enable/disable events (e.g., a service was disabled),134 always use `resource.type="audited_resource"`.1353. **Handling Unknown Schemas (Crucial):** If the user asks to filter by a136 specific field or condition, and if you cannot find a matching example or137 schema in the reference files, **then you must generate a query using global138 search.**139 * Only specify `jsonPayload.*` or `protoPayload.*` field structures when140 you are certain of their exact name.141 * Use the `SEARCH()` function to find the keyword globally within the142 correct `resource.type`.143 * **Mandatory LQL Comment:** When delivering a query that uses `SEARCH`,144 you MUST add an LQL comment (using `--`) at the top of the query145 indicating you used a global keyword search because the exact schema146 wasn't in your references. Do NOT output conversational text, strictly147 adhere to the Output Format rule.148149## Supporting links150151* [Cloud Logging query language documentation](https://docs.cloud.google.com/logging/docs/view/logging-query-language)152* [Monitored resource types catalog](https://docs.cloud.google.com/logging/docs/api/v2/resource-list)153* [Cloud Logging query library](https://docs.cloud.google.com/logging/docs/view/query-library)