Skip to content

Commit b93074e

Browse files
authored
Merge pull request #6826 from JSONbored/docs/selfhost-loopover-selfhost-defaults
docs(selfhost): fix stale gittensory-selfhost self-host doc defaults
2 parents 8e2f967 + 3578e00 commit b93074e

3 files changed

Lines changed: 26 additions & 3 deletions

File tree

apps/loopover-ui/content/docs/self-hosting-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Tune `MAINTENANCE_ADMISSION_MAX_LIVE_PENDING` (default `5`), `MAINTENANCE_ADMISS
216216

217217
## Tracing and telemetry env
218218

219-
`OTEL_EXPORTER_OTLP_ENDPOINT` overrides the OpenTelemetry collector target only if you're routing to an external collector instead of the bundled one (default `http://otel-collector:4318` under the `observability` profile). `OTEL_SERVICE_NAME` (default `gittensory-selfhost`) is the service name traces and metrics are tagged with — set a distinct value per instance if you run more than one and want to tell them apart in Grafana/Tempo. `OTEL_TRACES_SAMPLER` (default `parentbased_traceidratio`) picks the sampling strategy for app job/provider traces; pair it with `OTEL_TRACES_SAMPLER_ARG` (for example `0.05` to sample 5% of root traces).
219+
`OTEL_EXPORTER_OTLP_ENDPOINT` overrides the OpenTelemetry collector target only if you're routing to an external collector instead of the bundled one (default `http://otel-collector:4318` under the `observability` profile). `OTEL_SERVICE_NAME` (default `loopover-selfhost`) is the service name traces and metrics are tagged with — set a distinct value per instance if you run more than one and want to tell them apart in Grafana/Tempo. `OTEL_TRACES_SAMPLER` (default `parentbased_traceidratio`) picks the sampling strategy for app job/provider traces; pair it with `OTEL_TRACES_SAMPLER_ARG` (for example `0.05` to sample 5% of root traces).
220220

221221
## Generated env reference
222222

apps/loopover-ui/content/docs/self-hosting-operations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -611,8 +611,8 @@ captures use a `kind` or review `operation` tag instead.
611611
/>
612612

613613
Cron monitor slugs follow
614-
`gittensory-selfhost-{environment}-{loop}` (for example
615-
`gittensory-selfhost-production-scheduled-loop`). Pair monitor alerts with queue
614+
`loopover-selfhost-{environment}-{loop}` (for example
615+
`loopover-selfhost-production-scheduled-loop`). Pair monitor alerts with queue
616616
depth, dead-job counts, and the matching structured log event.
617617

618618
## Sentry alert classes and runbook

test/unit/self-host-ops-rename-residue.test.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ const SELF_HOSTING_OPS_DOC = join(
1010
process.cwd(),
1111
"apps/loopover-ui/content/docs/self-hosting-operations.mdx",
1212
);
13+
const SELF_HOSTING_CONFIGURATION_DOC = join(
14+
process.cwd(),
15+
"apps/loopover-ui/content/docs/self-hosting-configuration.mdx",
16+
);
1317
const TERRAFORM_MAIN = join(process.cwd(), "packages/loopover-miner/terraform/main.tf");
1418
const CAPABILITY_AUDIT_DOC = join(process.cwd(), "src/review/repo-agnostic-capability-audit.md");
1519

@@ -20,6 +24,25 @@ describe("self-host ops docs rename residue (#5937)", () => {
2024
expect(doc).toContain("loopover-docker-prune");
2125
});
2226

27+
it("documents the real loopover-selfhost-{environment}-{loop} cron monitor slug, not the pre-rename prefix", () => {
28+
// resolveSentryMonitorSlug (src/selfhost/sentry.ts) has emitted "loopover-selfhost-..." slugs since the
29+
// Sentry monitor-naming rebrand; this doc paragraph was left describing the pre-rename "gittensory-selfhost-..."
30+
// pattern. Unlike the SENTRY_RELEASE default (scripts/deploy-selfhost-prebuilt.sh, deliberately still
31+
// "gittensory-selfhost@..." per test/unit/selfhost-sentry-release.test.ts), the monitor slug has no such
32+
// pinned exception -- it's a plain doc/code mismatch.
33+
const doc = readFileSync(SELF_HOSTING_OPS_DOC, "utf8");
34+
expect(doc).not.toContain("gittensory-selfhost-{environment}-{loop}");
35+
expect(doc).toContain("loopover-selfhost-{environment}-{loop}");
36+
});
37+
38+
it("documents the real loopover-selfhost OTEL_SERVICE_NAME default, not the pre-rename value", () => {
39+
// src/selfhost/otel.ts falls back to "loopover-selfhost" when OTEL_SERVICE_NAME is unset; this doc line
40+
// still described the pre-rename default.
41+
const doc = readFileSync(SELF_HOSTING_CONFIGURATION_DOC, "utf8");
42+
expect(doc).not.toContain("`OTEL_SERVICE_NAME` (default `gittensory-selfhost`)");
43+
expect(doc).toContain("`OTEL_SERVICE_NAME` (default `loopover-selfhost`)");
44+
});
45+
2346
it("points the terraform module's header comment at the real env filename, not .gittensory-miner.env", () => {
2447
const tf = readFileSync(TERRAFORM_MAIN, "utf8");
2548
expect(tf).not.toContain(".gittensory-miner.env");

0 commit comments

Comments
 (0)