Hanzo DevandGitHub
fe4bfd3cf4
* debrand: signoz/SigNoz/SIGNOZ -> o11y/O11y/O11Y across the tree Rename all SigNoz *branding* to O11y in file contents, file/dir names, package names, env vars, config keys, comments, docs, SDK code, and the ClickHouse schema identifiers the querier reads. Collector dependency: - Repoint github.com/hanzoai/signoz-otel-collector -> github.com/hanzoai/otel-collector and bump v0.144.6 -> v0.144.7 (go.mod + go.sum reconciled via go mod tidy). Internal package paths also debranded upstream: signozschemamigrator -> o11yschemamigrator, signozlogspipelineprocessor -> o11ylogspipelineprocessor. - Fix: v0.144.7 dropped otelconst.DistributedFieldKeysTable from the collector's public constants; pin FieldKeysTable = "distributed_field_keys" locally in pkg/telemetrymetadata/tables.go. Package/dir renames (package decl + all importers): pkg/apiserver/signozapiserver -> o11yapiserver, plus signozalertmanager, signozauthzapi, signozglobal, signozquerier, signozruler, and pkg/signoz -> pkg/o11y. Schema (read plane): signoz_traces/metrics/logs/metadata/analytics/meter and signoz_index_v3/index_v2/error_index_v2/spans (+ distributed_*) -> o11y_*. Data-preserving cutover migration added: deploy/clickhouse/migrations/0001_rename_signoz_to_o11y.sql (metadata-only RENAME DATABASE/TABLE, no drop/recreate). Preserved (attribution / external / wire contracts): - LICENSE + NOTICE verbatim (incl. "software from SigNoz", "Copyright ... SigNoz Inc."). - Upstream github.com/SigNoz/* repo URLs + @SigNoz/* CODEOWNERS teams. - Billing resource-attribute regex "signoz.workspace.*" (external wire contract). go build ./pkg/... ./cmd/... = 0; gofmt clean; renamed+schema pkg tests pass. * o11y: bump collector to v0.144.8 (o11y_* physical schema writer) + lockstep deploy plan Collector v0.144.8's schema-migrator + exporters now CREATE/WRITE the same o11y_* physical databases/tables the querier reads and the RENAME migration (0001_rename_signoz_to_o11y.sql) targets. Cross-checked byte-identical: writer DB set == migration target DB set (6); writer prefixed-table set == migration target table set (8); o11y querier reads and cloud reads are subsets of that set. Zero table-name mismatches between writer, readers, and migration. Collector go.mod unchanged between v0.144.7 and v0.144.8 (identical go.mod hash) — pure source rename, no module-graph change. Adds deploy/clickhouse/DEPLOY_signoz_to_o11y_cutover.md: the lockstep order (collector v0.144.8 -> RENAME migration -> o11y+cloud readers) with a fresh/scratch-ClickHouse pre-flight (create via migrator, emit trace+metric, query back) and rollback. Ships together or telemetry blackholes. go build ./pkg/... ./cmd/community = 0.
4.0 KiB
4.0 KiB
Contributing Guidelines
Thank you for your interest in contributing to our project! We greatly value feedback and contributions from our community. This document will guide you through the contribution process.
How can I contribute?
Finding Issues to Work On
- Check our [existing open issues](https://github.com/Hanzo O11y/o11y/issues?q=is%3Aopen+is%3Aissue)
- Look for [good first issues](https://github.com/Hanzo O11y/o11y/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to start with
- Review [recently closed issues](https://github.com/Hanzo O11y/o11y/issues?q=is%3Aissue+is%3Aclosed) to avoid duplicates
Types of Contributions
- Report Bugs: Use our [Bug Report template](https://github.com/Hanzo O11y/o11y/issues/new?assignees=&labels=&template=bug_report.md&title=)
- Request Features: Submit using [Feature Request template](https://github.com/Hanzo O11y/o11y/issues/new?assignees=&labels=&template=feature_request.md&title=)
- Improve Documentation: Create an issue with the
documentationlabel - Report Performance Issues: Use our [Performance Issue template](https://github.com/Hanzo O11y/o11y/issues/new?assignees=&labels=&template=performance-issue-report.md&title=)
- Request Dashboards: Submit using [Dashboard Request template](https://github.com/Hanzo O11y/o11y/issues/new?assignees=&labels=dashboard-template&projects=&template=request_dashboard.md&title=%5BDashboard+Request%5D+)
- Report Security Issues: Follow our [Security Policy](https://github.com/Hanzo O11y/o11y/security/policy)
- Join Discussions: Participate in [project discussions](https://github.com/Hanzo O11y/o11y/discussions)
Creating Helpful Issues
When creating issues, include:
-
For Feature Requests:
- Clear use case and requirements
- Proposed solution or improvement
- Any open questions or considerations
-
For Bug Reports:
- Step-by-step reproduction steps
- Version information
- Relevant environment details
- Any modifications you've made
- Expected vs actual behavior
Submitting Pull Requests
-
Development:
- Setup your development environment
- Work against the latest
mainbranch - Focus on specific changes
- Ensure all tests pass locally
- Follow our commit convention
-
Submit PR:
- Ensure your branch can be auto-merged
- Address any CI failures
- Respond to review comments promptly
For substantial changes, please split your contribution into multiple PRs:
- First PR: Overall structure (README, configurations, interfaces)
- Second PR: Core implementation (split further if needed)
- Final PR: Documentation updates and end-to-end tests
Commit Convention
We follow Conventional Commits. All commits and PRs should include type specifiers (e.g., feat:, fix:, docs:, etc.).
How can I contribute to other repositories?
You can find other repositories in the [Hanzo O11y](https://github.com/Hanzo O11y) organization to contribute to. Here is a list of highlighted repositories:
- [charts](https://github.com/Hanzo O11y/charts)
- [dashboards](https://github.com/Hanzo O11y/dashboards)
Each repository has its own contributing guidelines. Please refer to the guidelines of the repository you want to contribute to.
How can I get help?
Need assistance? Join our Slack community:
Where do I go from here?
- Set up your development environment
- Deploy and observe Hanzo O11y in action with OpenTelemetry Demo Application
- Explore the Hanzo O11y Community Advocate Program, which recognises contributors who support the community, share their expertise, and help shape Hanzo O11y's future.
- Write integration tests