o11y/pkg/templating/markdownrenderer/html_test.go at main

mirror of https://github.com/hanzoai/o11y.git synced 2026-10-15 12:58:33 +00:00

Files

T

zeekayandGitHub babbdec4b8 debrand: SigNoz -> O11y across the tree (+ otel-collector v0.144.7, schema cutover migration) (#28 )

* 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.

2026-07-09 13:08:55 -07:00

167 lines

7.1 KiB

Go

Raw Permalink Blame History

 package markdownrenderer
 import (
 	"testing"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 var testMarkdown = `# 🔥 FIRING: High CPU Usage on api-gateway
 https://o11y.example.com/alerts/123
 https://runbooks.example.com/cpu-high
 ## Alert Details
 **Status:** **FIRING** | *api-gateway* service is experiencing high CPU usage. ~~resolved~~ previously.
 Alert triggered because ` + "`cpu_usage_percent`" + ` exceeded threshold ` + "`90`" + `.
 [View Alert in O11y](https://o11y.example.com/alerts/123) | [View Logs](https://o11y.example.com/logs?service=api-gateway) | [View Traces](https://o11y.example.com/traces?service=api-gateway)
 ![critical](https://o11y.example.com/badges/critical.svg "Critical Alert")
 ## Alert Labels
 | Label    | Value       |
 | -------- | ----------- |
 | service  | api-gateway |
 | instance | pod-5a8b3c  |
 | severity | critical    |
 | region   | us-east-1   |
 ## Remediation Steps
 . Check current CPU usage on the pod
 . Review recent deployments for regressions
 . Scale horizontally if load-related
 . Increase replica count
 . Verify HPA configuration
 ## Affected Services
 * api-gateway
 * auth-service
 * payment-service
     * payment-processor
     * payment-validator
 ## Incident Checklist
 - [x] Alert acknowledged
 - [x] On-call notified
 - [ ] Root cause identified
 - [ ] Fix deployed
 ## Alert Rule Description
 > This alert fires when CPU usage exceeds 90% for more than 5 minutes on any pod in the api-gateway service.
 >
 >> For capacity planning guidelines, see the infrastructure runbook section on horizontal pod autoscaling.
 ## Triggered Query
 ` + "```promql\navg(rate(container_cpu_usage_seconds_total{service=\"api-gateway\"}[5m])) by (pod) > 0.9\n```" + `
 ## Inline Details
 This alert was generated by O11y using ` + "`alertmanager`" + ` rules engine.
 `
 func TestRenderHTML_Composite(t *testing.T) {
 	html, err := RenderHTML(testMarkdown)
 	require.NoError(t, err)
 	expected := "<h1>🔥 FIRING: High CPU Usage on api-gateway</h1>\n" +
 		"<p><a href=\"https://o11y.example.com/alerts/123\">https://o11y.example.com/alerts/123</a>\n<a href=\"https://runbooks.example.com/cpu-high\">https://runbooks.example.com/cpu-high</a></p>\n" +
 		"<h2>Alert Details</h2>\n" +
 		"<p><strong>Status:</strong> <strong>FIRING</strong> | <em>api-gateway</em> service is experiencing high CPU usage. <del>resolved</del> previously.</p>\n" +
 		"<p>Alert triggered because <code>cpu_usage_percent</code> exceeded threshold <code>90</code>.</p>\n" +
 		"<p><a href=\"https://o11y.example.com/alerts/123\">View Alert in O11y</a> | <a href=\"https://o11y.example.com/logs?service=api-gateway\">View Logs</a> | <a href=\"https://o11y.example.com/traces?service=api-gateway\">View Traces</a></p>\n" +
 		"<p><img src=\"https://o11y.example.com/badges/critical.svg\" alt=\"critical\" title=\"Critical Alert\"></p>\n" +
 		"<h2>Alert Labels</h2>\n" +
 		"<table>\n<thead>\n<tr>\n<th>Label</th>\n<th>Value</th>\n</tr>\n</thead>\n" +
 		"<tbody>\n<tr>\n<td>service</td>\n<td>api-gateway</td>\n</tr>\n" +
 		"<tr>\n<td>instance</td>\n<td>pod-5a8b3c</td>\n</tr>\n" +
 		"<tr>\n<td>severity</td>\n<td>critical</td>\n</tr>\n" +
 		"<tr>\n<td>region</td>\n<td>us-east-1</td>\n</tr>\n</tbody>\n</table>\n" +
 		"<h2>Remediation Steps</h2>\n" +
 		"<ol>\n<li>Check current CPU usage on the pod</li>\n<li>Review recent deployments for regressions</li>\n<li>Scale horizontally if load-related\n" +
 		"<ol>\n<li>Increase replica count</li>\n<li>Verify HPA configuration</li>\n</ol>\n</li>\n</ol>\n" +
 		"<h2>Affected Services</h2>\n" +
 		"<ul>\n<li>api-gateway</li>\n<li>auth-service</li>\n<li>payment-service\n" +
 		"<ul>\n<li>payment-processor</li>\n<li>payment-validator</li>\n</ul>\n</li>\n</ul>\n" +
 		"<h2>Incident Checklist</h2>\n" +
 		"<ul>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> Alert acknowledged</li>\n" +
 		"<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> On-call notified</li>\n" +
 		"<li><input disabled=\"\" type=\"checkbox\"> Root cause identified</li>\n" +
 		"<li><input disabled=\"\" type=\"checkbox\"> Fix deployed</li>\n</ul>\n" +
 		"<h2>Alert Rule Description</h2>\n" +
 		"<blockquote>\n<p>This alert fires when CPU usage exceeds 90% for more than 5 minutes on any pod in the api-gateway service.</p>\n" +
 		"<blockquote>\n<p>For capacity planning guidelines, see the infrastructure runbook section on horizontal pod autoscaling.</p>\n</blockquote>\n</blockquote>\n" +
 		"<h2>Triggered Query</h2>\n" +
 		"<pre><code class=\"language-promql\">avg(rate(container_cpu_usage_seconds_total{service=&quot;api-gateway&quot;}[5m])) by (pod) &gt; 0.9\n</code></pre>\n" +
 		"<h2>Inline Details</h2>\n" +
 		"<p>This alert was generated by O11y using <code>alertmanager</code> rules engine.</p>\n"
 	assert.Equal(t, expected, html)
 }
 func TestRenderHTML_InlineFormatting(t *testing.T) {
 	input := `# 🔥 FIRING: High CPU on api-gateway
 ## Alert Status
 **FIRING** alert for *api-gateway* service — ~~resolved~~ previously.
 Metric ` + "`cpu_usage_percent`" + ` exceeded threshold. [View in O11y](https://o11y.example.com/alerts/123)
 ![critical](https://o11y.example.com/badges/critical.svg "Critical Alert")`
 	html, err := RenderHTML(input)
 	require.NoError(t, err)
 	expected := "<h1>🔥 FIRING: High CPU on api-gateway</h1>\n<h2>Alert Status</h2>\n" +
 		"<p><strong>FIRING</strong> alert for <em>api-gateway</em> service — <del>resolved</del> previously.</p>\n" +
 		"<p>Metric <code>cpu_usage_percent</code> exceeded threshold. <a href=\"https://o11y.example.com/alerts/123\">View in O11y</a></p>\n" +
 		"<p><img src=\"https://o11y.example.com/badges/critical.svg\" alt=\"critical\" title=\"Critical Alert\"></p>\n"
 	assert.Equal(t, expected, html)
 }
 func TestRenderHTML_BlockElements(t *testing.T) {
 	input := `1. Check CPU usage on the pod
 . Review recent deployments
 . Scale horizontally if needed
 * api-gateway
 * auth-service
 * payment-service
 - [x] Alert acknowledged
 - [ ] Root cause identified
 > This alert fires when CPU usage exceeds 90% for more than 5 minutes.
 | Label    | Value       |
 | -------- | ----------- |
 | service  | api-gateway |
 | severity | <no value>    |
 ` + "```promql\navg(rate(container_cpu_usage_seconds_total{service=\"api-gateway\"}[5m])) by (pod) > 0.9\n```"
 	html, err := RenderHTML(input)
 	require.NoError(t, err)
 	expected := "<ol>\n<li>Check CPU usage on the pod</li>\n<li>Review recent deployments</li>\n<li>Scale horizontally if needed</li>\n</ol>\n" +
 		"<ul>\n<li>api-gateway</li>\n<li>auth-service</li>\n<li>payment-service</li>\n</ul>\n" +
 		"<ul>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> Alert acknowledged</li>\n" +
 		"<li><input disabled=\"\" type=\"checkbox\"> Root cause identified</li>\n</ul>\n" +
 		"<blockquote>\n<p>This alert fires when CPU usage exceeds 90% for more than 5 minutes.</p>\n</blockquote>\n" +
 		"<table>\n<thead>\n<tr>\n<th>Label</th>\n<th>Value</th>\n</tr>\n</thead>\n" +
 		"<tbody>\n<tr>\n<td>service</td>\n<td>api-gateway</td>\n</tr>\n" +
 		"<tr>\n<td>severity</td>\n<td>&lt;no value&gt;</td>\n</tr>\n</tbody>\n</table>\n" +
 		"<pre><code class=\"language-promql\">avg(rate(container_cpu_usage_seconds_total{service=&quot;api-gateway&quot;}[5m])) by (pod) &gt; 0.9\n</code></pre>\n"
 	assert.Equal(t, expected, html)
 }

167 lines 7.1 KiB Go Raw Permalink Blame History

167 lines

7.1 KiB

Go

Raw Permalink Blame History