mirror of
https://github.com/hanzoai/o11y.git
synced 2026-10-15 12:58:33 +00:00
* 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.
230 lines
5.9 KiB
Go
230 lines
5.9 KiB
Go
// Copyright (c) 2026 O11y, Inc.
|
|
// Copyright 2019 Prometheus Team
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package webhook
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
commoncfg "github.com/prometheus/common/config"
|
|
"github.com/prometheus/common/model"
|
|
"github.com/prometheus/common/promslog"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/hanzoai/o11y/pkg/alertmanager/alertmanagertemplate"
|
|
"github.com/prometheus/alertmanager/config"
|
|
"github.com/prometheus/alertmanager/notify"
|
|
"github.com/prometheus/alertmanager/notify/test"
|
|
"github.com/prometheus/alertmanager/types"
|
|
)
|
|
|
|
func TestWebhookRetry(t *testing.T) {
|
|
tmpl := test.CreateTmpl(t)
|
|
notifier, err := New(
|
|
&config.WebhookConfig{
|
|
URL: config.SecretTemplateURL("http://example.com"),
|
|
HTTPConfig: &commoncfg.HTTPClientConfig{},
|
|
},
|
|
tmpl,
|
|
promslog.NewNopLogger(),
|
|
alertmanagertemplate.New(tmpl, slog.Default()),
|
|
)
|
|
if err != nil {
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
t.Run("test retry status code", func(t *testing.T) {
|
|
for statusCode, expected := range test.RetryTests(test.DefaultRetryCodes()) {
|
|
actual, _ := notifier.retrier.Check(statusCode, nil)
|
|
require.Equal(t, expected, actual, "error on status %d", statusCode)
|
|
}
|
|
})
|
|
|
|
t.Run("test retry error details", func(t *testing.T) {
|
|
for _, tc := range []struct {
|
|
status int
|
|
body io.Reader
|
|
|
|
exp string
|
|
}{
|
|
{
|
|
status: http.StatusBadRequest,
|
|
body: bytes.NewBuffer([]byte(
|
|
`{"status":"invalid event"}`,
|
|
)),
|
|
|
|
exp: fmt.Sprintf(`unexpected status code %d: {"status":"invalid event"}`, http.StatusBadRequest),
|
|
},
|
|
{
|
|
status: http.StatusBadRequest,
|
|
|
|
exp: fmt.Sprintf(`unexpected status code %d`, http.StatusBadRequest),
|
|
},
|
|
} {
|
|
t.Run("", func(t *testing.T) {
|
|
_, err = notifier.retrier.Check(tc.status, tc.body)
|
|
require.Equal(t, tc.exp, err.Error())
|
|
})
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestWebhookTruncateAlerts(t *testing.T) {
|
|
alerts := make([]*types.Alert, 10)
|
|
|
|
truncatedAlerts, numTruncated := truncateAlerts(0, alerts)
|
|
require.Len(t, truncatedAlerts, 10)
|
|
require.EqualValues(t, 0, numTruncated)
|
|
|
|
truncatedAlerts, numTruncated = truncateAlerts(4, alerts)
|
|
require.Len(t, truncatedAlerts, 4)
|
|
require.EqualValues(t, 6, numTruncated)
|
|
|
|
truncatedAlerts, numTruncated = truncateAlerts(100, alerts)
|
|
require.Len(t, truncatedAlerts, 10)
|
|
require.EqualValues(t, 0, numTruncated)
|
|
}
|
|
|
|
func TestWebhookRedactedURL(t *testing.T) {
|
|
ctx, u, fn := test.GetContextWithCancelingURL()
|
|
defer fn()
|
|
|
|
secret := "secret"
|
|
tmpl := test.CreateTmpl(t)
|
|
templater := alertmanagertemplate.New(tmpl, slog.Default())
|
|
notifier, err := New(
|
|
&config.WebhookConfig{
|
|
URL: config.SecretTemplateURL(u.String()),
|
|
HTTPConfig: &commoncfg.HTTPClientConfig{},
|
|
},
|
|
tmpl,
|
|
promslog.NewNopLogger(),
|
|
templater,
|
|
)
|
|
require.NoError(t, err)
|
|
|
|
test.AssertNotifyLeaksNoSecret(ctx, t, notifier, secret)
|
|
}
|
|
|
|
func TestWebhookReadingURLFromFile(t *testing.T) {
|
|
ctx, u, fn := test.GetContextWithCancelingURL()
|
|
defer fn()
|
|
|
|
f, err := os.CreateTemp(t.TempDir(), "webhook_url")
|
|
require.NoError(t, err, "creating temp file failed")
|
|
_, err = f.WriteString(u.String() + "\n")
|
|
require.NoError(t, err, "writing to temp file failed")
|
|
|
|
tmpl := test.CreateTmpl(t)
|
|
notifier, err := New(
|
|
&config.WebhookConfig{
|
|
URLFile: f.Name(),
|
|
HTTPConfig: &commoncfg.HTTPClientConfig{},
|
|
},
|
|
tmpl,
|
|
promslog.NewNopLogger(),
|
|
alertmanagertemplate.New(tmpl, slog.Default()),
|
|
)
|
|
require.NoError(t, err)
|
|
|
|
test.AssertNotifyLeaksNoSecret(ctx, t, notifier, u.String())
|
|
}
|
|
|
|
func TestWebhookURLTemplating(t *testing.T) {
|
|
var calledURL string
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
calledURL = r.URL.Path
|
|
w.WriteHeader(http.StatusOK)
|
|
}))
|
|
defer srv.Close()
|
|
|
|
tests := []struct {
|
|
name string
|
|
url string
|
|
groupLabels model.LabelSet
|
|
alertLabels model.LabelSet
|
|
expectError bool
|
|
expectedErrMsg string
|
|
expectedPath string
|
|
}{
|
|
{
|
|
name: "templating with alert labels",
|
|
url: srv.URL + "/{{ .GroupLabels.alertname }}/{{ .CommonLabels.severity }}",
|
|
groupLabels: model.LabelSet{"alertname": "TestAlert"},
|
|
alertLabels: model.LabelSet{"alertname": "TestAlert", "severity": "critical"},
|
|
expectError: false,
|
|
expectedPath: "/TestAlert/critical",
|
|
},
|
|
{
|
|
name: "invalid template field",
|
|
url: srv.URL + "/{{ .InvalidField }}",
|
|
groupLabels: model.LabelSet{"alertname": "TestAlert"},
|
|
alertLabels: model.LabelSet{"alertname": "TestAlert"},
|
|
expectError: true,
|
|
expectedErrMsg: "failed to template webhook URL",
|
|
},
|
|
{
|
|
name: "template renders to empty string",
|
|
url: "{{ if .CommonLabels.nonexistent }}http://example.com{{ end }}",
|
|
groupLabels: model.LabelSet{"alertname": "TestAlert"},
|
|
alertLabels: model.LabelSet{"alertname": "TestAlert"},
|
|
expectError: true,
|
|
expectedErrMsg: "webhook URL is empty after templating",
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
calledURL = "" // Reset for each test
|
|
|
|
tmpl := test.CreateTmpl(t)
|
|
notifier, err := New(
|
|
&config.WebhookConfig{
|
|
URL: config.SecretTemplateURL(tc.url),
|
|
HTTPConfig: &commoncfg.HTTPClientConfig{},
|
|
},
|
|
tmpl,
|
|
promslog.NewNopLogger(),
|
|
alertmanagertemplate.New(tmpl, slog.Default()),
|
|
)
|
|
require.NoError(t, err)
|
|
|
|
ctx := context.Background()
|
|
ctx = notify.WithGroupKey(ctx, "test-group")
|
|
if tc.groupLabels != nil {
|
|
ctx = notify.WithGroupLabels(ctx, tc.groupLabels)
|
|
}
|
|
|
|
alerts := []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: tc.alertLabels,
|
|
StartsAt: time.Now(),
|
|
EndsAt: time.Now().Add(time.Hour),
|
|
},
|
|
},
|
|
}
|
|
|
|
_, err = notifier.Notify(ctx, alerts...)
|
|
|
|
if tc.expectError {
|
|
require.Error(t, err)
|
|
require.Contains(t, err.Error(), tc.expectedErrMsg)
|
|
} else {
|
|
require.NoError(t, err)
|
|
require.Equal(t, tc.expectedPath, calledURL)
|
|
}
|
|
})
|
|
}
|
|
}
|