Aleksei Sviridkin
0e99ec012a
## What this PR does Adds `docs/observability/distributed-tracing.md`, the operator and tenant guide for distributed tracing (epic #3761, design cozystack/community `design-proposals/distributed-tracing`). The guide covers the per-tenant backend and collector (#3762, #3763): the in-namespace OTLP endpoints, the standard `OTEL_*` variables to point an instrumented workload at them, sampling, redaction and tenancy, and a per-engine table of what each managed engine can emit itself. Verification against the engines (#3766) showed that none of them pushes OTLP spans server-side, so the guide's answer for every engine is client-side instrumentation, with the ClickHouse span table as the one partial exception. It also covers shared-central tracing (#3775, with the per-tenant write rate in #4648): hosting the store in tenant-root, opting a tenant in, the shared disk and the write rate with its limits (counted before sampling, a 3 MiB request cap, the allowance a pod start lets through, at most 10 collector replicas), the trust boundary with the collector's write-only and Grafana's read-only logins, the lifecycle windows on enabling and disabling, and the order to stop hosting in. Those details used to live in the `tracingCentral` field description, which #3775 cut to a few sentences because it ships as field help in the dashboard. Both #3775 and #4648 are merged, and every figure and refusal the guide quotes was checked against the charts on `main`. ### Screenshots No UI changes. ### Downstream repositories - [x] No downstream repository is affected by this change - [ ] [cozystack/website](https://github.com/cozystack/website) - follow-up: - [ ] [cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack) - follow-up: - [ ] [cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack) - follow-up: - [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up: - [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up: - [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) - follow-up: - [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) - follow-up: - [ ] [cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server) - follow-up: - [ ] [cozystack/external-apps-example](https://github.com/cozystack/external-apps-example) - follow-up: - [ ] [cozystack/examples](https://github.com/cozystack/examples) - follow-up: - [ ] [cozystack/community](https://github.com/cozystack/community) - follow-up: The guide is a file under `docs/` in this repository and changes no package, values key or API, so no trigger in the downstream map applies. ### Release note ```release-note docs(observability): add a distributed tracing guide covering the per-tenant collector, client-side instrumentation per managed engine, and shared-central tracing in tenant-root. ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a distributed-tracing guide covering tenant-local VictoriaTraces storage, OTLP collectors, workload configuration, engine tracing limitations, sampling, and optional attribute redaction. * Documented shared-central tracing prerequisites, including tenant-root hosting and tenant opt-in, plus write-rate, request-size, and replica limits; credentials and network rules; tenant isolation and lifecycle behavior; and conditions that stop hosting. * Clarified that cross-signal correlation is not configured. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Cozystack
Cozystack is a free and open-source platform and framework for building clouds.
Cozystack is a CNCF Sandbox project that was originally built and sponsored by Ænix.
With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.
Use Cozystack to build your own cloud or provide a cost-effective development environment.
Use-Cases
-
Using Cozystack to build a public cloud
You can use Cozystack as a backend for a public cloud -
Using Cozystack to build a private cloud
You can use Cozystack as a platform to build a private cloud powered by Infrastructure-as-Code approach -
Using Cozystack as a Kubernetes distribution
You can use Cozystack as a Kubernetes distribution for Bare Metal
Documentation
The documentation is located on the cozystack.io website.
Read the Getting Started section for a quick start.
If you encounter any difficulties, start with the troubleshooting guide and work your way through the process that we've outlined.
Versioning
Versioning adheres to the Semantic Versioning principles.
A full list of the available releases is available in the GitHub repository's Release section.
Contributions
Contributions are highly appreciated and very welcomed!
In case of bugs, please check if the issue has already been opened by checking the GitHub Issues section. If it isn't, you can open a new one. A detailed report will help us replicate it, assess it, and work on a fix.
You are welcome to take on the fix yourself. Commits are used to generate the changelog, and their author will be referenced in it.
If you have a concrete feature request, open an issue. For a cross-cutting or architectural change, open a design proposal in the community repo. For questions or early ideas, use GitHub Discussions. See CONTRIBUTING.md for the full routing.
Community
You are welcome to join us in #cozystack, on either CNCF Slack (get an invite) or Kubernetes Slack (get an invite), in our Telegram group, and at our community meetings. Add them to your Google Calendar or iCal for convenience.
Project documents
| Document | What it covers |
|---|---|
| Governance | How decisions are made and who makes them |
| Contributor Ladder | How to grow from contributor to maintainer |
| Maintainers | Who maintains the project |
| Code of Conduct | What we expect of each other |
| Security Policy | Reporting a vulnerability, and which releases get fixes |
| Adopters | Who runs Cozystack in production |
| Roadmap | Where the project is going |
License
Cozystack is licensed under Apache 2.0.
The code is provided as-is with no warranties.
Commercial Support
A list of companies providing commercial support for this project can be found on official site.