Skip to content

docs: Add README.md#19

Merged
thumbrise merged 1 commit into
mainfrom
14-need-readme-file
Mar 18, 2026
Merged

docs: Add README.md#19
thumbrise merged 1 commit into
mainfrom
14-need-readme-file

Conversation

@thumbrise

@thumbrise thumbrise commented Mar 18, 2026

Copy link
Copy Markdown
Owner

PR #19: Add README.md

Type: Documentation only (single new file)

What it adds

A comprehensive README.md for the otelext library — a set of extensions for the
OpenTelemetry Go SDK focused on telemetry filtering and sampling.

Key sections in the README

  1. Badges — CI status, Go Reference, Apache 2.0 license
  2. Features — Filter registry, FilterBasedSampler, CompositeSampler
  3. Installationgo get github.com/thumbrise/otelext (Go 1.25+, OTel SDK v1.42+)
  4. Quick Start — Code examples for registering filters and composing samplers
  5. API referencesignal.Filter interface (ShouldDrop, Key, Description),
    registry functions (RegisterFilter, RegisteredFilters, ClearFilters),
    and signal/trace types (FilterBasedSampler, CompositeSampler)
  6. TODO roadmap — Planned work across docs, functionality, tests, CI/CD, and infra
  7. Development — Prerequisites (Go 1.25+, Task, golangci-lint v2.4+) and commands
  8. License — Apache 2.0, Copyright 2026 thumbrise

@thumbrise thumbrise linked an issue Mar 18, 2026 that may be closed by this pull request

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@thumbrise thumbrise merged commit b785a90 into main Mar 18, 2026
6 checks passed
@thumbrise thumbrise deleted the 14-need-readme-file branch March 18, 2026 19: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.

Need README file

1 participant