agentleFS
DataDogDataDog/dd-trace-java/.agents/skills/resolve-muzzle-ci/SKILL.md

resolve-muzzle-ci

Skill739 starsChanged 6 days agoApache-2.0View on GitHub

Diagnose and resolve dd-trace-java CI failures from a module's muzzle task or the runMuzzle aggregate. Use when CI names muzzle/runMuzzle, reports Muzzle validation or version-range resolution failures, or starts failing after a newly published library version. Distinguishes transient repository or MagicMirror failures from actionable compatibility, artifact, and validation-JDK defects; do not use for unrelated Gradle dependency or test failures.

The file

Show its rules and text

We split this skill into the rules it gives an agent

15 rules. About 0 are common, 9 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Treat the failing task and its first causal exception as the routing evidence.

    line 13
  2. Very specific:

    Read the CI job log far enough to identify the full Gradle task path and first causal exception, not only the final Muzzle validation …

    line 27
  3. Distinctive:

    If it is not a muzzle failure, say which task actually failed and stop using this skill.

    line 38
  4. Distinctive:

    Before changing a build file, read:

    line 40
  5. Distinctive:

    Use release age only to prioritize investigation.

    line 53
  6. Very specific:

    Add skipVersions only for isolated bad releases whose own POM, artifact, or version metadata is defective and where later releases can …

    line 108
  7. Very specific:

    Add excludeDependency 'group:module' only for a transitive dependency that is not referenced by the advice, helpers, matcher requirements, …

    line 110
  8. Distinctive:

    Prefer an exact coordinate.

    line 112
  9. Very specific:

    Add an exact extraDependency only when it belongs to the library's valid runtime/application classpath but is not present in the resolved …

    line 113
  10. Distinctive:

    Ensure a narrowly scoped Gradle repository entry exists when a valid target artifact or required application dependency is intentionally …

    line 115
  11. Distinctive:

    Ensure Gradle can also resolve the dependencies.

    line 136
  12. Very specific:

    Never broaden support, remove an inverse assertion, or exclude a dependency solely because it makes the task pass.

    line 140
  13. Distinctive:

    When a fix changes Muzzle configuration or adds a build-file workaround, leave a brief comment beside the affected directive or setting …

    line 158
  14. Very specific:

    Run the affected module's relevant tests when executable code, helper requirements, or claimed support changed.

    line 177
  15. Distinctive:

    Create a Jira follow-up only when muzzle exposes a compatibility gap in a newly published target library version and the completed change …

    line 184

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Resolve muzzle CI

Treat the failing task and its first causal exception as the routing evidence. A failed job that happens to download dependencies is not necessarily a muzzle failure.

Match the user's requested scope. For investigation-only requests, gather evidence and report the classification, root cause, and proposed remedy; stop before editing repository files, retrying CI, or creating Jira issues unless those actions are also authorized. Requests to fix or resolve the failure proceed through implementation and verification without another confirmation for already authorized work. Apply the separate CI-retry and Jira authorization rules below.

Confirm and chime in

For GitLab job logs, read CI log access when CLI authentication or job retrieval is needed; the GitHub PR's repository is not necessarily the GitLab CI project.

  1. Read the CI job log far enough to identify the full Gradle task path and first causal exception, not only the final Muzzle validation failed wrapper.
  2. Confirm that the task is a module :muzzle* task or the runMuzzle aggregate, or that the stack is from datadog.gradle.plugin.muzzle / MuzzleVersionScanPlugin.
  3. As soon as it is confirmed, tell the user briefly:

    This is a muzzle CI failure in <task/module>. I am checking whether it is repository
    infrastructure, an artifact/JDK issue, or a real compatibility regression.

    If it is not a muzzle failure, say which task actually failed and stop using this skill.

Before changing a build file, read:

  • docs/how_to_work_with_gradle.md
  • docs/how_instrumentations_work.md, especially its Muzzle and JApiCmp sections
  • .agents/skills/apm-integrations/references/muzzle.md
  • the affected module's build.gradle and adjacent versioned modules
  • failure signatures and remedies

Classify before editing

Preserve the complete relevant log and CI URL. Record the affected task, module, directive, artifact coordinates, tested version, repository host, and first causal exception.

Use release age only to prioritize investigation. An established version that previously passed suggests checking infrastructure and dependency-graph changes; a newly published version suggests comparing its API and publication with the last passing release. Neither age alone nor a green aggregate rerun justifies a retry, version cap, or skip. See the worked scenarios.

Classify the failure as exactly one of:

  • Transient platform/repository failure: timeouts, connection resets, TLS/DNS failures, HTTP 429/5xx, incomplete metadata from MagicMirror/Depot, or several unrelated artifacts failing to download. There is no concrete muzzle mismatch for an already resolved application classpath.
  • Defective or unavailable published artifact: the same version or one of its transitive coordinates is persistently absent, has a broken POM/archive, or cannot form a valid classpath, including when checked outside the transient proxy path.
  • Compatibility regression: muzzle resolved the application classpath and reports missing or changed classes, methods, fields, flags, or a class-loader mismatch.
  • Validation-JDK mismatch: UnsupportedClassVersionError occurs while loading a resolved root or transitive library class that requires a newer JDK than the Muzzle worker.
  • Declared-failure mismatch: MUZZLE PASSED ... BUT FAILURE WAS EXPECTED shows that a fail range or inverse expectation is false.
  • Helper injection failure: FAILED HELPER INJECTION shows incomplete, misordered, invisible, or incompatible helpers.
  • Muzzle tooling/JDK failure: worker, toolchain, module-access, bytecode-parser, or JVM failure; fix the tooling path without changing the library compatibility range.
  • Unresolved: the available log is truncated or contradictory. Gather the missing evidence; do not edit a version range merely to make CI green.

For a transient platform failure, do not change repository, version, skip, or exclusion settings. The muzzle resolver already retries range resolution with backoff. If authorized, retry the failed job once after repository recovery, then report an infrastructure incident if the repository remains unhealthy. Stop here; do not create a Jira ticket from this workflow.

For the other classifications, reproduce the smallest task with diagnostic output:

./gradlew :dd-java-agent:instrumentation:<path>:muzzle --stacktrace --info --rerun-tasks

Large ranges are reduced before execution, so a green rerun is not proof that a deterministic mid-range failure disappeared. Rerun the module muzzle task and confirm from its output or report that the exact generated version task ran. If necessary, temporarily narrow a local diagnostic copy of the directive to versions = "[<exact-version>]"; never commit that diagnostic narrowing.

Choose the smallest honest remedy

Choose directly from the observed cause and prove the remedy against the current artifact and API evidence.

The major remedies are:

  • Fix the instrumentation when the new release is intended to remain supported and a bounded code change can restore compatibility. Add or update version-specific tests.
  • Cap the pass range at the first incompatible version when that version introduces a real API or linkage boundary that this module does not support. Check whether a sibling module should take over; do not skipVersions around an ongoing incompatible line.
  • Add skipVersions only for isolated bad releases whose own POM, artifact, or version metadata is defective and where later releases can still be supported.
  • Add excludeDependency 'group:module' only for a transitive dependency that is not referenced by the advice, helpers, matcher requirements, explicit muzzle references, or class-loader matcher. Prefer an exact coordinate; use a group wildcard only when the entire group is proven irrelevant.
  • Add an exact extraDependency only when it belongs to the library's valid runtime/application classpath but is not present in the resolved graph.
  • Ensure a narrowly scoped Gradle repository entry exists when a valid target artifact or required application dependency is intentionally hosted outside the configured repositories. Add extraRepository to the Muzzle directive when version discovery also requires that repository. extraRepository configures Aether version discovery; it does not configure Gradle dependency resolution.
  • Correct the target artifact/module when the directive follows a relocated or obsolete coordinate.
  • Set per-directive javaVersion = "<N>" when a valid resolved dependency requires that JDK to load. Split at a known JDK boundary when useful and verify both sides of each boundary.
  • Change the expected compatibility outcome of a fail block or assertInverse only when MUZZLE PASSED ... BUT FAILURE WAS EXPECTED demonstrates that the expectation is false. Replacing generated inverses with equivalent explicit checks must preserve the expected outcomes and version coverage.
  • Repair helper completeness, ordering, linkage, or visibility for FAILED HELPER INJECTION; cap a range only when the helper failure proves a real target-library compatibility boundary.
  • Repair Muzzle tooling or CI toolchain provisioning for worker, parser, or JVM failures; do not change the dependency support range.

Generated assertInverse directives do not inherit javaVersion, extraDependency, or extraRepository. When inverse checks need these inputs, replace the generated inverse with explicit fail directives covering the same unsupported ranges, with suitable JDKs, dependencies, and repositories for those versions. Disable assertInverse only after providing equivalent coverage. Ensure Gradle can also resolve the dependencies. Verify that each negative check fails for the intended compatibility mismatch, not a missing classpath input or a repository/JDK failure. Sibling coverage alone does not establish the original module's expected compatibility outcome.

Never broaden support, remove an inverse assertion, or exclude a dependency solely because it makes the task pass. javaVersion changes only the worker JDK; it does not fix library linkage or change the agent, test, or bytecode baselines. Muzzle does not prove that a type named only in a matcher exists; use an explicit muzzle reference or runtime test when that fact matters.

For a symbol mismatch, run the module's printReferences task to trace the generated reference and compare the last passing and first failing artifacts when useful:

./gradlew :dd-java-agent:instrumentation:<path>:printReferences
./gradlew japicmp -Partifact=<group>:<module> -Pbaseline=<last-pass> -Ptarget=<first-fail>

Muzzle validates binary references and helper injection, not behavior. If code or supported runtime semantics change, add a behavior test and exercise a coherent library dependency stack.

Leave the reason beside the workaround

When a fix changes Muzzle configuration or adds a build-file workaround, leave a brief comment beside the affected directive or setting explaining the concrete failure and compatibility consequence. Include a removal condition or upstream issue when the workaround is temporary.

For a source-only fix, keep any necessary explanation beside the relevant code or regression test; no build.gradle edit is required. Record the affected version and changed linkage or runtime assumption where useful. Avoid comments that only say fix muzzle, CI failure, or broken version.

Verify

Rerun the module muzzle task and verify according to the selected remedy:

  • Restored support: confirm that the exact previously failing version ran and passed; use a temporary local diagnostic directive if range sampling omits it.
  • Containment by cap or skip: the original pass task is deliberately removed. Confirm the revised range or skip, exercise retained supported versions around the boundary or isolated skip, and run applicable inverse or explicit negative checks on resolvable classpaths. Report the excluded version as unsupported; an unavailable or defective publication cannot establish a binary mismatch.

Run the affected module's relevant tests when executable code, helper requirements, or claimed support changed. For javaVersion, confirm the selected worker JDK and test both sides of any split. Inspect the diff, then report the exact commands and results; do not call an infrastructure-only retry a code validation.

Hand off the follow-up in Jira

Create a Jira follow-up only when muzzle exposes a compatibility gap in a newly published target library version and the completed change leaves that version unsupported, normally by capping the current module below it. The ticket tracks restoring support for that new version. Do not create a ticket for transient platform/repository failures, defective or missing publications, irrelevant transitive artifacts, tooling/JDK failures, stale inverse assertions, or a change that already restores and verifies support.

For a qualifying new-version gap, read the Jira handoff after the analysis and local verification are complete. If the current request authorizes Jira creation, create the ticket. If it does not, ask whether the user wants the gap logged and, if so, which Jira project/board to use; continue safe local work while waiting. Do not guess the destination or claim the ticket was created when no Jira integration is available.

Finish with the classification, root cause, resolution and its compatibility consequence, validation, any owner or removal condition, and—only for a qualifying new-version support gap—the Jira disposition (key/link, copy-ready draft, declined, or not requested). Preserve authorization conditions, name the exact task/module, distinguish proposed, completed, and blocked checks, and retain remedy-specific validation requirements.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.