Antimetal Documentation

website·Indexed 34 days ago

https://docs.antimetal.com

Documentation for Antimetal, a platform that investigates, fixes, and prevents production infrastructure issues. Includes guides on the issue lifecycle, AI-powered search, and an API reference for managing issues and artifacts. Covers integrations with Azure, GCP, AWS CloudWatch, Datadog, GitHub, Sentry, Vercel, and others, as well as connectivity via a remote MCP server.

Tokens
11.2K
Snippets
36
Records
97
Agent score
64%

What's inside Antimetal

  1. Overview of Antimetal Skills for AI coding tools

    Antimetal Skills is an MCP-compatible plugin that integrates Antimetal's infrastructure investigation, search, and issue management capabilities directly into AI coding tools. It allows developers to perform the following tasks via natural language:

    • Infrastructure Search: Run queries across connected platforms.
    • Issue Investigation: Trigger root cause analysis and remediation steps.
    • Issue Management: Create, view, and update issues from an editor or terminal.
    • Data Querying: Pull logs, metrics, traces, and events from connected integrations.
  2. Overview of Antimetal capabilities

    Antimetal is a post-deployment tool designed to investigate, fix, and prevent production issues by connecting a developer's cloud platforms, observability tools, and codebase. It provides three primary capabilities:

    1. Diagnose: Aggregates data from logs, metrics, traces, code, and incident history to identify the root cause of alerts.
    2. Fix: Generates production-ready fixes based on evidence for team review and deployment.
    3. Prevent: Identifies blind spots and inefficiencies to stop incidents before they occur.
  3. Understand the Antimetal Issue Lifecycle

    Issues are the primary unit of work in Antimetal, representing incidents or questions that require investigation. They move through a lifecycle from initial alert/creation to resolution. Antimetal automatically handles the transition from 'Investigating' to 'Ready to fix' once the automated analysis is complete.
  4. Search infrastructure and architecture with Antimetal

    Antimetal allows users to ask broad questions regarding their infrastructure and architecture. The system leverages its internal understanding of the connected environment to provide answers based on the current state of the system.
  5. Connect Antimetal to self-hosted observability tools

    Antimetal uses a dedicated, read-only connector to query self-hosted observability tools (such as Grafana, Victoria Logs, Victoria Metrics, Prometheus, and Pyroscope) that reside within a private network or VPC. To establish a connection, you must provide the connector with an HTTPS Instance URL and a read-only bearer token or service account. The connector is restricted to a read-only allowlist and performs no write or ingestion operations.
  6. Understand Antimetal fix categories

    When an investigation finishes, Antimetal proposes fixes on the Fixes tab. Antimetal does not apply fixes automatically; they must be reviewed and shipped by an engineer. Fixes are categorized into two types:

    • Immediate: Solves the active symptom to stop the issue from compounding during investigation.
    • Comprehensive: Addresses the root cause to prevent the issue from recurring.
  7. Review and manage Antimetal PRs

    PRs generated by Antimetal are authored by antimetal[bot]. The bot automatically tags CODEOWNERS and assigns a responsible engineer based on contribution history for the affected code paths.

    Response Options:

    • Approve and merge: If the diff is correct.
    • Modify: Add commits, rebase, or rewrite the diff before merging.
    • Request changes: Leave inline comments to correct the approach; this feedback helps the agent learn.
    • Close: If the issue is no longer relevant or the agent misread the situation.
  8. Set up Vercel integration in Antimetal

    Follow these steps to connect Vercel to Antimetal:

    1. Create a Vercel access token: Navigate to Vercel Access Tokens and click Create.
      • Set the Token Name to Antimetal.
      • Set the Scope to Full Account (for all teams/projects) or a specific team.
      • Select an expiration date.
      • Save the token immediately as it will not be shown again.
    2. Enter the token: Paste the generated access token into the Vercel integration page in the Antimetal dashboard.
    3. Enter team slug (Optional): Provide your Vercel team slug (vercel.com/<team-slug>) to scope queries to the correct team.
  9. Create a Pull Request from Antimetal

    For fixes involving code changes, you can generate a PR directly from Antimetal. The agent uses AGENTS.md, CLAUDE.md, Cursor/Copilot rules files, and system memory to adhere to team code styles.

    Available PR Actions:

    • Create PR: Opens a pull request branching from the default branch (requires GitHub integration).
    • Create draft PR: Opens a draft PR to avoid pinging reviewers prematurely.
    • Open in [Agent]: Hands the fix and context to Codex, Cursor, Devin, or GitHub Copilot.
    • Copy fix as prompt: Copies the fix and context for use in any IDE or agent.

    Critical Caveats:

    • PR creation is experimental.
    • Antimetal does not run tests or builds against the fix. You must validate changes locally or in CI before merging.
  10. Integrate Azure DevOps with Antimetal

    To enable Antimetal to inspect repositories, pull requests, work items, pipelines, wikis, and test plans, you must create a read-only Personal Access Token (PAT) in Azure DevOps and provide it to the Antimetal dashboard. This integration is distinct from the Azure cloud integration and is only required if your team uses Azure DevOps for source control, work items, or pipelines.