Latest upstream author date included at this registry's pinned revision.

agent-platform-alert-configuration

Synced v1.0.0 License: Apache-2.0 Source: google/skills/skills/cloud/agent-platform-alert-configuration Commit: 99c871e Latest included change:

Configures best-practice alerting policies for AI agents using OpenTelemetry (OTel) metrics, generating output as Terraform (.tf) configuration files. Use when analyzing, writing, or deploying alerting policies to monitor agent latency, error rates, token usage, and quality metrics. Don't use for standard infrastructure monitoring unrelated to AI agents, or when the agent is not instrumented with OpenTelemetry (for Reliability, Cost, Safety, Security alerts). NOTE: Reliability, Cost, Safety, and Security alerts use generic OTel metrics and work across runtimes (such as Cloud Run, Vertex AI). Quality alerts rely on Vertex AI Online Monitors and are strictly bound to Vertex AI deployments.

Summary

Purpose
It structures agent alerting around reliability, cost, safety, security, and Vertex AI evaluation quality.
When to use
Use it when reliability, cost, safety, or security alerts must cover multiple agent runtimes, or when quality alerts are needed for a Vertex AI deployment using Online Monitors; the former depend on OTel metrics.
Outputs
It generates Terraform (.tf) alert-policy configurations for reliability, cost, safety, security, and Vertex AI quality, with dynamic agent grouping by default.
Upstream changes (16, latest included 2026-09-23)
efcb6f0 Add semantic versions to the hand-authored agent-platform-* skills. Added `metadata.version: "1.0.0"` to the skill's front matter.
7072dc4 Eliminate Latin abbreviations (e.g., i.e., etc.) from agent-platform-alert-configuration skill. Replaced occurrences of the Latin example abbreviation `e.g.` with plain-language alternatives such as `such as` and `for example` throughout the skill.
5027f39 Change weak language to a stronger set of verbs for agent-platform-alert-configuration for consistency. Reworded discovery, metric-scope, duplicate-policy, and background-task instructions to emphasize verification and stronger mandatory actions.
62a8a85 Apply GCP language corrections to agent-platform-alert-configuration skill. Updated the telemetry billing warning to specify Cloud Trace/Cloud Logging export and renamed SQL alerting descriptions from Log Analytics to Observability Analytics.
9d9a10f Update documentation links to use docs.cloud.google.com domain. Changed the Alerting Policies and PromQL supporting links to use the `docs.cloud.google.com` domain.
a39f283 - Updated `SKILL.md` front matter description and added good/bad examples for dynamic grouping. - Clarified pinning rules in `reliability_alert_policies.md` to avoid conflicts. Expanded the skill description with Terraform-output and applicability details, and added good and bad PromQL and SQL examples for dynamic grouping versus hardcoded filters.
92aa428 No public description Added guidance not to rerun the log- or trace-table lookup scripts when `gather_agent_info.py` has already returned or written those table names.
8229c1e Update SKILL.md to clarify gather_agent_info usage and fallbacks so that the agent will not call Gcloud for Metric Scopes if it already has enough information. Clarified that metric-scope fallback checks run only when streamlined discovery lacks the scope, while successful discovery proceeds directly to the pre-existing-policy check.
3ea747f Split validate_config.py into single-responsibility scripts: lint_syntax.py and scan_duplicates.py. Updated duplicate-checking and linting instructions to use `scan_duplicates.py` and `lint_syntax.py` instead of `validate_config.py` modes.
12f4821 Renamed flags in `validate_config.py` to be more semantic (`--scan-duplicates` instead of `--directory`, `--lint-syntax` instead of `--file`) to reduce agent confusion, and updated `SKILL.md` expectations. Made streamlined discovery mandatory and renamed the documented `validate_config.py` flags and commands to `--scan-duplicates` and `--lint-syntax`.
984673e - Added gather_agent_info.py script with Fast lookup via Cloud Asset Inventory (CAIS) as the primary track. - Added --regions flag to allow custom region scanning. - Capped printed lists (Linked Datasets, Channels, Scopes, Evaluators) to 5 items to prevent context window overflow. - Updated SKILL.md to guide agents on using the script and handling potential failures. Updated the skill to classify `gather_agent_info.py` as read-only, add its discovery flow and usage instructions, and broaden utility-script failure guidance.
26f2b89 Minor fixes for the agent-platform-alert-configuration skill: - Update the SKILL.md instruction example to use single quotes ('${var.gen_ai_agent_name}') so that bash passes the string literal directly without attempting variable expansion. - In analyze_traffic.py, update argparse so that using `--metric-type` is required. Changed the duplicate-check example to enclose the `${var.gen_ai_agent_name}` argument in single quotes.
f20e4b6 Update skill for agent-platform-alert-configuration Reworked the skill from Agent Runtime-specific alerting guidance into broader OTel alerting guidance, adding safety, discovery, alert-type, Terraform-only, dynamic-grouping, and validation rules while removing detailed algorithm and provisioning sections.
439d729 Correct allowed-tools field for agent-platform-alert-configuration Changed the `allowed-tools` front matter from a YAML list to the inline value `terraform gcloud python`.
c75b500 Restructure the YAML frontmatter in all SKILL.md files to nest the 'category' field under the 'metadata:' block. The 'category' field is used to organize the skills in the README.md Moved `category: AiAndMachineLearning` into a new nested `metadata` block in the front matter.
40e40d7 Introduce the agent-platform-alert-configuration skill Introduced the skill with guidance for Vertex AI / Agent Platform alerting, safety tiers, policy selection, dynamic grouping and scope, telemetry and quality monitoring, and Terraform validation.
npx skills add "lettucebo/Skills#v2.2.0@agent-platform-alert-configuration" --full-depth

⚠ Available after v2.2.0 is published

Agent Platform Alert Configuration

Critical Steps

1. Safety & Confirmation Tiers (CRITICAL)

Before executing any commands or writing configurations on behalf of the user, you MUST adhere to the following safety tiers based on the action requested:

  1. Tier R: Read-only (check_telemetry.py / gather_agent_info.py)
    • Rule: No confirmation needed. You may execute these scripts immediately to inspect telemetry status or gather agent configuration details.
  2. Tier B: Billing & Resource Creation (create_online_monitor.py / provisioning)
    • Rule: Explicit User Confirmation Required. These actions incur additional billing charges and create cloud resources. The agent MUST ALWAYS warn the user explicitly about the potential extra billing costs of BOTH the Online Monitor (specifically mentioning LLM evaluations) and Telemetry (specifically mentioning Cloud Trace/Cloud Logging export). You MUST STOP and ask for explicit approval before proceeding with provisioning or providing setup commands.

2. Prerequisites & Dependencies

Agent Telemetry

  • Disclaimer: For Reliability, Cost, Safety, and Security alerts to function, the underlying agent MUST be instrumented to emit OpenTelemetry (OTel) metrics. If the agent does not emit these metrics, the alerting policies will have no data stream to evaluate.

Python Environment

Before executing any python script in this skill you MUST install the required dependencies in your environment. Run this command first:

pip install -r scripts/requirements.txt

3. Input Assumptions

  • Explicit Project Adherence: You must ONLY configure alerts, query telemetry, or interact with the Google Cloud Project(s) explicitly provided by the user in the prompt. Do NOT assume or use other projects from your environment or history unless the user explicitly directs you to do so.
  • Sequential File Transformations: If the user explicitly asks to copy a file and then modify it, you MUST perform these actions sequentially (copy first, then modify) rather than writing the final content directly.

4. Execution Steps

  1. Mandatory Prerequisite Execution Protocol (SEQUENTIAL): Before generating or writing ANY configuration, you MUST execute these steps in order:

    1. Step 1: Streamlined Discovery (Mandatory): Run gather_agent_info.py to automatically identify agent runtime, verify telemetry, metric scopes, linked datasets, and more. This script covers most of the manual verifications listed in subsequent steps.
      • Command: python3 scripts/gather_agent_info.py --project-id {project_id} --agent-name {agent_name}
      • Note: If this script fails, returns partial data, or doesn't produce everything you need, you MUST satisfy requirements by running the manual fallback steps listed in Step 2 and then perform Step 3 below. If Step 1 succeeds and provides all info, SKIP to Step 3 (Pre-existing Policies Verification).
    2. Step 2: Metric Scope Verification (Fallback): Run this ONLY if Step 1 failed to determine the metric scope.
      • Action A (CLI): Run gcloud beta monitoring metrics-scopes list projects/{project_id}. If a scoping project is returned, you MUST deploy policies there.
      • Action B (Code Scan): Search Terraform configurations for google_monitoring_monitored_project resources to extract the scoping project.
      • Action C (Fallback): If ambiguous, ASK the user: "Are you using a multi-project Cloud Monitoring Metric Scope? If so, what is the scoping project ID?"
    3. Step 3: Pre-existing Policies Verification: Avoid duplicates.
      • Action: Scan the target directory to see if aggregated policies already exist targeting the same metrics (grouped by reasoning_engine_id or gen_ai_agent_name). Use scan_duplicates.py to verify.
  2. Alert Policy Type Resource Files: You MUST list and read files under references/ with names ending in _alert_policies.md to learn how to configure alert policies based on type. By default you MUST configure all of the following alert types UNLESS the user requests to generate explicit alert policies and/or types. Follow their tables of content to help you find the reference sections you need to read:

5. Outputs & Formats

  • Always configure the supported alerting policies for the target agent:

    • For Reliability Monitoring: You MUST configure exactly five alerting policies:
      1. Latency (anomaly monitoring)
      2. Error Rate - Fast Burn SLO (1-Hour Window)
      3. Error Rate - Slow Burn SLO (3-Day Window)
      4. Model Call Error Rate (SQL-based Observability Analytics Alerting)
      5. Tool Call Error Rate (SQL-based Observability Analytics Alerting)
    • For Quality Monitoring: You MUST configure exactly three alerting policies (Requires Vertex AI Online Monitors):
      1. Final Response Quality
      2. Tool Use Quality
      3. Hallucination
    • For Cost Monitoring: You MUST configure exactly one cost alerting policy:
      1. Rapid Token Burn Rate (anomaly monitoring)
    • For Safety Monitoring: You MUST configure exactly one safety alerting policy:
      1. High Model Armor Safety Policy Trigger Rate (SQL-based Observability Analytics Alerting)
    • For Security Monitoring: You MUST configure exactly one security alerting policy:
      1. High IAM Permission Denied Trigger Rate (SQL-based Observability Analytics Alerting)
  • Terraform Only: Write the generated observability configuration ONLY as Terraform (.tf) files (such as alerts.tf, variables.tf).

    • You ONLY need to install Terraform if you're asked to deploy the alerts AND there is no valid Terraform install. SQL-based alerting using condition_sql requires the provider version >= 6.0.0 (or late 5.x versions supporting the feature).
    • If you are NOT asked to deploy the alerts you do not need to install terraform.
  • Dynamic Multi-Resource Alerting (No Single-Resource Pinning): You MUST NOT hardcode specific agent IDs or resource name filters (for example, {gen_ai_agent_name="{agent_name}"} or metric.labels.agent_resource_name="{agent_name}") in alerting conditions unless explicitly requested (for example, "ONLY for this agent"). Merely mentioning a specific agent name or ID in the request does NOT constitute an explicit request to pin/filter; you MUST still default to dynamic grouping to cover all agents. To cover all active agents in the project dynamically:

    Good Example (PromQL Grouping):

    sum(rate(workload_googleapis_com:gen_ai_invoke_agent_duration_count{monitored_resource="generic_node"}[5m])) by (gen_ai_agent_name)
    

    Bad Example (PromQL Hardcoded Filter):

    sum(rate(workload_googleapis_com:gen_ai_invoke_agent_duration_count{monitored_resource="generic_node", gen_ai_agent_name="support-bot"}[5m]))
    
    • For Reliability Metrics using PromQL: ALWAYS use grouping aggregations. Group by gen_ai_agent_name (for example, by (gen_ai_agent_name)). Avoid filtering to a single ID/Name unless requested.
    • For Quality Metrics using Standard Threshold Filters: Omit the agent_resource_name filter entirely. Configure the condition filter to only target the monitored resource type (aiplatform.googleapis.com/OnlineEvaluator) and metric type (aiplatform.googleapis.com/online_evaluator/scores) globally for the project.

    Good Example (SQL Grouping):

    SELECT
      JSON_VALUE(resource.attributes, '$."cloud.resource_id"') as agent_id,
      ...
    FROM ...
    GROUP BY agent_id
    

    Bad Example (SQL Hardcoded Filter):

    SELECT ...
    FROM ...
    WHERE JSON_VALUE(resource.attributes, '$."cloud.resource_id"') = 'support-bot'
    
    • For Downstream Calls using SQL: Omit the ENDS_WITH filter targeting a specific agent name. Instead, extract the agent identifier (for example, JSON_VALUE(resource.attributes, '$."cloud.resource_id"')) and add it to the GROUP BY clause alongside the model or tool name.
  • Directory Inference: Prefer the path explicitly provided by the user (if any). Otherwise, deploy configuration files to target Terraform or SRE folders (such as monitoring/, ops/, sre/). Use tools to locate where alert policies or state pointers exist in the project, rather than blindly writing to the root.

  • Notification Channels: By default, never configure any notification channels without user input. If the user explicitly provides a notification channel in their prompt, configure the alerts to use it. If no notification channel is provided, you MUST explicitly ask the user in your final response if they would like to configure notification channels. This is a mandatory question and you MUST NOT omit it from your response. IMPORTANT Do NOT make assumptions about notification channels. If you search the codebase for a notification channel you must ALWAYS confirm with the user before using it.

  • Plain English Response: You MUST include a plain English explanation for what the alerts do in your response. This must explain in plain English what the alert measures, how the algorithm works, and what a trigger indicates.

6. Output Verification

  • Background Task Cleanup: You MUST verify the status of all background tasks that you spawn. Before completing your execution and returning your final response, you MUST terminate or kill any active or hanging background tasks (using the manage_task tool with action kill).
  • Validate Configuration: Run the Config Linting tool to make sure all the output files are written with the correct grammar and structure. See details about the tool in the Tooling Scripts section below.

Tooling Scripts

Use the following scripts to discover agents, gather configuration details, resolve duplicates, and validate configs:

  1. Agent Information Gathering: Streamlines discovery, environment auditing (Metric Scopes, BQ Datasets, Notification Channels), table derivations (Log & Trace), and Online Evaluator verifications.
    • Command: python3 scripts/gather_agent_info.py --project-id {project_id} --agent-name {agent_name}
  2. Duplicate Verification & Merge: Verifies pre-existing alerts in the target folder to ensure changes are merged in-place rather than appended:
    • Command: python3 scripts/scan_duplicates.py {target_tf_dir} --engine-var '${var.gen_ai_agent_name}'
  3. Config Linting: Validates PromQL grammar, matching engine labels, and HCL structure:
    • Command: python3 scripts/lint_syntax.py {path_to_tf_file}
    • Self-Correction Loop: If validation fails (exits non-zero or outputs errors), you MUST read the command output, locate the line/file containing the lint error, analyze the PromQL syntax or Terraform HCL issue, apply adjustments in-place, and re-run the lint_syntax.py validation. Repeat this loop until the validation script passes successfully.

Gotchas & Behavioral Corrections

  • Raw Error Boundaries: Explain that raw error counts or absolute failed request count boundaries do not scale under changing traffic throughput. Recommend ratio-based error rate alerts instead.
  • Safe Threshold Modulation E2E Validation: When verifying a dynamic metric threshold policy end-to-end, do NOT attempt to force real platform errors. Instead, deploy the alert policy with standard safe bounds (Z-score multiplier > 15), then temporarily update standard deviation Z-score limits to a negative value (for example, > -3) to trigger/verify the "Firing" state before reverting. Always get confirmation before taking this action proactively.
  • Expected Script Failures:
    • scan_duplicates.py exiting with code 1: Parse the JSON output for duplicate resource targets. Perform in-place upgrade edits, then re-check until it passes with 0.
    • Avoid Redundant Discovery Calls: If gather_agent_info.py successfully returns the Trace or Log table names (or writes them to variables file), do NOT redundantly call list_trace_scope_table_names.py or list_log_scope_table_names.py. These scripts are run internally by gather_agent_info.py and are provided as external Fallbacks only.
    • Script Execution Failures & Self-Correction: If the execution of utility scripts (such as gather_agent_info.py, check_telemetry.py, create_online_monitor.py, analyze_traffic.py, list_log_scope_table_names.py, or list_trace_scope_table_names.py) fails unexpectedly, you MUST read and inspect the stdout/stderr logs or error output. Analyze the error message and attempt to dynamically correct parameters and retry execution before escalating or falling back to manual plans. Consult the relevant domain-specific reference file for detailed troubleshooting steps for specific scripts.
  • Distribution Metric Aligner Constraint: Standard ALIGN_MEAN cannot be applied to DELTA distribution metrics like online_evaluator/scores. You MUST use percentile-based aligners (like ALIGN_PERCENTILE_50) to reduce the score distribution into a comparable numeric stream.
  • HCL Heredoc Interpolation: When referencing Terraform variables inside PromQL or SQL queries (which are defined as strings), you MUST use the ${var.variable_name} syntax. Bare references like var.variable_name will fail at deployment time.
  • Avoid Recursive Directory Operations: You MUST NOT run recursive listing or search commands (such as ls -R, find ., or raw recursive grep) from the repository root if it contains a very large number of files, as this will freeze your session. Always target specific subdirectories.

Supporting Links

History

v1.0.0 mapping-added 99c871e