oats: Instructions file for Codex

AGENTS.md

oats AGENTS.md is an instructions file for Codex, OpenCode from grafana/oats. It costs 890 tokens per session, scanned A, original, Apache-2.0.

A set of instructions for coding agents working on OATs, a Go framework for testing OpenTelemetry data such as traces, logs, metrics, and profiles. It explains the project and its build and test commands.

In plain words
What is it for?
Use it when building OATs, running its tests, or changing its YAML-based test cases and project files.
Why use it?
It gives an agent the repository context and helps it use the expected commands, including separate checks for regular tests and end-to-end tests.

Instructions file for CodexOpenCode ✓ vendor

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is grafana/oats's own configuration. It tells Codex and OpenCode how to work on oats itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything oats configures →

About the project

OpenTelemetry Acceptance Tests is a declarative testing framework for checking whether instrumented applications produce expected traces, logs, metrics, and profiles in real observability systems. Developers and platform teams use YAML test cases to drive applications or seed telemetry, then validate the results across supported telemetry backends. The catalogue instructions help coding agents work with this testing framework.

grafana/oats · 49 stars · on GitHub · grafana.com

Reuse

Borrowing it

Nothing to install: this file belongs to grafana/oats. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/grafana/oats/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/grafana/oats

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for oats AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/grafana/oats/agents-md/github.svg)](https://agentmods.dev/instructions/grafana/oats/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/grafana/oats/agents-md"><img src="https://agentmods.dev/badge/instructions/grafana/oats/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for oats AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/grafana/oats/agents-md"><img src="https://agentmods.dev/badge/instructions/grafana/oats/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 890 This file is loaded in full into every session.
When invoked 890 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00890 $0.00890
Opus 5.5 $0.00356 $0.00356
Sonnet 5.5 $0.00178 $0.00178
Haiku 4.5 $0.00089 $0.00089

Measured 2mo ago against content hash 73f13a2cfe19, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

oats AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 110 lines

How it starts

The opening of the file, as written. The whole thing — 110 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository.

For a broader contributor orientation, see CONTRIBUTING.md. For durable architecture and product decisions, see the architecture decision records.

Project Overview

OATs (OpenTelemetry Acceptance Tests) is a declarative test framework for OpenTelemetry written in Go. It enables full round-trip testing from instrumented applications to the observability stack (LGTM: Loki, Grafana, Tempo, Prometheus, Mimir, OpenTelemetry Collector).

Test cases are defined in YAML files, discovered through an oats-config.yaml whose meta.version: 3 is the single schema version (cases carry no version field of their own). They can validate traces (TraceQL), logs (LogQL), metrics (PromQL), and profiles (Pyroscope queries) using Docker Compose or Kubernetes backends.

Build Commands

# Build
mise run build

# Run non-e2e tests
mise run test

# Run e2e tests
mise run e2e-test

Mise task implementations live in .mise/tasks/ as executable file tasks. Keep task scripts there rather than adding new mise-invoked scripts under scripts/; shared helpers used directly by CI or release workflows may remain in scripts/.

Linting

# Auto-fix lint issues (recommended dev workflow)
mise run lint:fix

# Verify only (same command used in CI)
mise run lint

# Run all checks
mise run check

Linting is handled by flint. Flint runs shellcheck, shfmt, actionlint, hadolint, rumdl, taplo, ryl, biome, typos, editorconfig, lychee, renovate-deps, and gofmt. EditorConfig rules live in .editorconfig.

Architecture

Package Organization

  • main.go — Root oats CLI entry point
  • internal/cli/ — The gcx-driven CLI implementation used by the root binary
  • internal/legacyyaml/ — legacy (v1/v2) test-case parsing, execution, migration, models, response parsing, and signal-specific assertions (runner.go, traces.go, metrics.go, logs.go, profiles.go); used only by the migrate subpackage
  • testhelpers/ — Docker Compose management, Kubernetes (k3d), and HTTP request helpers
  • tests/ — Integration and e2e test fixtures

Read the full file on GitHub · 110 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 110 lines · 890 tokens per session scan A 73f13a2cfe19

Subscribe to this mod's changes

oats AGENTS.md is an instructions file published in the GitHub repository grafana/oats (49 stars, last pushed today), licensed Apache-2.0. It adds 890 tokens to every session, about $0.0036 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens