Skip to content

docs: add integration guide for instrument-hooks#24

Merged
not-matthias merged 2 commits intomainfrom
cod-2503-add-documentation-for-using-instrument-hooks
Apr 28, 2026
Merged

docs: add integration guide for instrument-hooks#24
not-matthias merged 2 commits intomainfrom
cod-2503-add-documentation-for-using-instrument-hooks

Conversation

@not-matthias
Copy link
Copy Markdown
Member

@not-matthias not-matthias commented Apr 9, 2026

Summary

  • Adds a comprehensive example/README.md targeting integration authors building CodSpeed support for new languages/frameworks
  • Covers the full integration lifecycle: initialization, benchmark control, URI conventions, flamegraph markers, and testing
  • Documents __codspeed_root_frame__ requirement with Rust and C examples
  • Includes simulation vs walltime differences and common pitfalls

@not-matthias not-matthias requested a review from art049 April 13, 2026 15:13
@not-matthias not-matthias marked this pull request as ready for review April 13, 2026 15:14
Copy link
Copy Markdown
Member

@art049 art049 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just missing a better name and a reference from the readme as "custom harness" or something like
that

@not-matthias not-matthias force-pushed the cod-2503-add-documentation-for-using-instrument-hooks branch from 8e5b307 to d10ac0a Compare April 28, 2026 16:53
Adds CUSTOM_HARNESS.md, a step-by-step guide for building a CodSpeed
integration for a new language or benchmarking framework using the
instrument-hooks C library. Includes a copy-paste prompt for scaffolding
the integration with an AI agent. Linked from the main README.
@not-matthias not-matthias force-pushed the cod-2503-add-documentation-for-using-instrument-hooks branch 2 times, most recently from 7b14501 to 433d5f6 Compare April 28, 2026 17:02
Wraps the benchmarked call in a noinline __codspeed_root_frame__ helper
so the example matches the pattern documented in the custom harness
guide.
@not-matthias not-matthias force-pushed the cod-2503-add-documentation-for-using-instrument-hooks branch from 433d5f6 to e30ac1f Compare April 28, 2026 17:04
@not-matthias not-matthias merged commit e30ac1f into main Apr 28, 2026
51 checks passed
@not-matthias not-matthias deleted the cod-2503-add-documentation-for-using-instrument-hooks branch April 28, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants