alot more changes
This commit is contained in:
1 parent
23243ddbdc
commit
0ed2935f04
40 files changed
+2889
-115
No files matched your search
@@ -0,0 +1,192 @@
|
||||
// Package abuseipdb proxies the AbuseIPDB API for authenticated operator actions.
|
||||
// The API key is deliberately kept on the server; browsers only receive the
|
||||
// selected IP's response data.
|
||||
package abuseipdb
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"net/url"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
const defaultBaseURL = "https://api.abuseipdb.com/api/v2"
|
||||
|
||||
type Config struct {
|
||||
Key string
|
||||
BaseURL string
|
||||
}
|
||||
|
||||
func ConfigFromEnv() Config {
|
||||
base := strings.TrimRight(os.Getenv("ABUSE_API_URL"), "/")
|
||||
if base == "" {
|
||||
base = defaultBaseURL
|
||||
}
|
||||
return Config{Key: strings.TrimSpace(os.Getenv("ABUSE_KEY")), BaseURL: base}
|
||||
}
|
||||
|
||||
type Handler struct {
|
||||
cfg Config
|
||||
client *http.Client
|
||||
}
|
||||
|
||||
func NewHandler(cfg Config) *Handler {
|
||||
return &Handler{cfg: cfg, client: &http.Client{Timeout: 10 * time.Second}}
|
||||
}
|
||||
|
||||
type Report struct {
|
||||
ReportedAt string `json:"reportedAt,omitempty"`
|
||||
Comment string `json:"comment,omitempty"`
|
||||
Categories []int `json:"categories,omitempty"`
|
||||
ReporterCountryCode string `json:"reporterCountryCode,omitempty"`
|
||||
}
|
||||
|
||||
type CheckData struct {
|
||||
IPAddress string `json:"ipAddress,omitempty"`
|
||||
IsPublic bool `json:"isPublic"`
|
||||
IPVersion int `json:"ipVersion,omitempty"`
|
||||
IsWhitelisted bool `json:"isWhitelisted"`
|
||||
AbuseConfidenceScore int `json:"abuseConfidenceScore"`
|
||||
CountryCode string `json:"countryCode,omitempty"`
|
||||
UsageType string `json:"usageType,omitempty"`
|
||||
ISP string `json:"isp,omitempty"`
|
||||
Domain string `json:"domain,omitempty"`
|
||||
TotalReports int `json:"totalReports"`
|
||||
NumDistinctUsers int `json:"numDistinctUsers"`
|
||||
LastReportedAt string `json:"lastReportedAt,omitempty"`
|
||||
Reports []Report `json:"reports,omitempty"`
|
||||
}
|
||||
|
||||
type checkResponse struct {
|
||||
Data CheckData `json:"data"`
|
||||
}
|
||||
|
||||
type reportResponse struct {
|
||||
Data struct {
|
||||
IPAddress string `json:"ipAddress,omitempty"`
|
||||
AbuseConfidenceScore int `json:"abuseConfidenceScore"`
|
||||
} `json:"data"`
|
||||
}
|
||||
|
||||
func (h *Handler) Check(w http.ResponseWriter, r *http.Request) {
|
||||
ip, ok := h.publicIP(w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
query := url.Values{"ipAddress": {ip.String()}, "maxAgeInDays": {"90"}}
|
||||
var out checkResponse
|
||||
if err := h.request(r.Context(), http.MethodGet, "/check?"+query.Encode(), nil, &out); err != nil {
|
||||
h.writeError(w, err)
|
||||
return
|
||||
}
|
||||
h.writeJSON(w, out.Data)
|
||||
}
|
||||
|
||||
type reportRequest struct {
|
||||
Categories []int `json:"categories"`
|
||||
Comment string `json:"comment"`
|
||||
}
|
||||
|
||||
func (h *Handler) Report(w http.ResponseWriter, r *http.Request) {
|
||||
ip, ok := h.publicIP(w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
var req reportRequest
|
||||
if err := json.NewDecoder(io.LimitReader(r.Body, 16<<10)).Decode(&req); err != nil {
|
||||
http.Error(w, "invalid report request", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
if len(req.Categories) == 0 {
|
||||
http.Error(w, "at least one category is required", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
if len(req.Comment) > 1000 {
|
||||
http.Error(w, "comment is too long", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
form := url.Values{"ip": {ip.String()}, "comment": {strings.TrimSpace(req.Comment)}}
|
||||
categories := make([]string, len(req.Categories))
|
||||
for i, category := range req.Categories {
|
||||
if category < 1 || category > 30 {
|
||||
http.Error(w, "category must be between 1 and 30", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
categories[i] = strconv.Itoa(category)
|
||||
}
|
||||
form.Set("categories", strings.Join(categories, ","))
|
||||
var out reportResponse
|
||||
if err := h.request(r.Context(), http.MethodPost, "/report", strings.NewReader(form.Encode()), &out); err != nil {
|
||||
h.writeError(w, err)
|
||||
return
|
||||
}
|
||||
h.writeJSON(w, out.Data)
|
||||
}
|
||||
|
||||
func (h *Handler) publicIP(w http.ResponseWriter, r *http.Request) (netip.Addr, bool) {
|
||||
if h.cfg.Key == "" {
|
||||
http.Error(w, "AbuseIPDB is not configured (set ABUSE_KEY)", http.StatusNotImplemented)
|
||||
return netip.Addr{}, false
|
||||
}
|
||||
ip, err := netip.ParseAddr(strings.TrimSpace(r.PathValue("ip")))
|
||||
if err != nil || !ip.IsGlobalUnicast() || ip.IsPrivate() || ip.IsLoopback() {
|
||||
http.Error(w, "only public unicast IPs can be checked or reported", http.StatusBadRequest)
|
||||
return netip.Addr{}, false
|
||||
}
|
||||
return ip, true
|
||||
}
|
||||
|
||||
func (h *Handler) request(ctx context.Context, method, path string, body io.Reader, dst any) error {
|
||||
req, err := http.NewRequestWithContext(ctx, method, h.cfg.BaseURL+path, body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.Header.Set("Accept", "application/json")
|
||||
req.Header.Set("Key", h.cfg.Key)
|
||||
if body != nil {
|
||||
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
|
||||
}
|
||||
resp, err := h.client.Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||
var apiErr struct {
|
||||
Errors []struct {
|
||||
Detail string `json:"detail"`
|
||||
} `json:"errors"`
|
||||
}
|
||||
_ = json.NewDecoder(io.LimitReader(resp.Body, 64<<10)).Decode(&apiErr)
|
||||
if len(apiErr.Errors) > 0 && apiErr.Errors[0].Detail != "" {
|
||||
return fmt.Errorf("AbuseIPDB: %s", apiErr.Errors[0].Detail)
|
||||
}
|
||||
return fmt.Errorf("AbuseIPDB returned HTTP %d", resp.StatusCode)
|
||||
}
|
||||
if err := json.NewDecoder(io.LimitReader(resp.Body, 2<<20)).Decode(dst); err != nil {
|
||||
return fmt.Errorf("invalid AbuseIPDB response: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (h *Handler) writeJSON(w http.ResponseWriter, value any) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("Cache-Control", "private, no-store")
|
||||
_ = json.NewEncoder(w).Encode(value)
|
||||
}
|
||||
|
||||
func (h *Handler) writeError(w http.ResponseWriter, err error) {
|
||||
status := http.StatusBadGateway
|
||||
if errors.Is(err, context.DeadlineExceeded) {
|
||||
status = http.StatusGatewayTimeout
|
||||
}
|
||||
http.Error(w, err.Error(), status)
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
package abuseipdb
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCheckAndReport(t *testing.T) {
|
||||
var gotKey string
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
gotKey = r.Header.Get("Key")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
if r.URL.Path == "/check" {
|
||||
if r.URL.Query().Get("ipAddress") != "8.8.8.8" || r.URL.Query().Get("maxAgeInDays") != "90" {
|
||||
t.Fatalf("unexpected check query: %s", r.URL.RawQuery)
|
||||
}
|
||||
_, _ = w.Write([]byte(`{"data":{"ipAddress":"8.8.8.8","abuseConfidenceScore":75,"totalReports":4}}`))
|
||||
return
|
||||
}
|
||||
if r.URL.Path != "/report" || r.Method != http.MethodPost {
|
||||
t.Fatalf("unexpected report request: %s %s", r.Method, r.URL.Path)
|
||||
}
|
||||
if err := r.ParseForm(); err != nil || r.Form.Get("ip") != "8.8.8.8" || r.Form.Get("categories") != "14,18" {
|
||||
t.Fatalf("unexpected report form: %v", r.Form)
|
||||
}
|
||||
_, _ = w.Write([]byte(`{"data":{"ipAddress":"8.8.8.8","abuseConfidenceScore":80}}`))
|
||||
}))
|
||||
defer server.Close()
|
||||
h := NewHandler(Config{Key: "test-key", BaseURL: server.URL})
|
||||
|
||||
check := httptest.NewRecorder()
|
||||
checkReq := httptest.NewRequest(http.MethodGet, "/api/source-ips/8.8.8.8/abuseipdb", nil).WithContext(t.Context())
|
||||
checkReq.SetPathValue("ip", "8.8.8.8")
|
||||
h.Check(check, checkReq)
|
||||
if check.Code != http.StatusOK || !strings.Contains(check.Body.String(), `"abuseConfidenceScore":75`) {
|
||||
t.Fatalf("check response: %d %s", check.Code, check.Body.String())
|
||||
}
|
||||
|
||||
report := httptest.NewRecorder()
|
||||
body, _ := json.Marshal(reportRequest{Categories: []int{14, 18}, Comment: "scanner activity"})
|
||||
reportReq := httptest.NewRequest(http.MethodPost, "/api/source-ips/8.8.8.8/abuseipdb/report", strings.NewReader(string(body))).WithContext(t.Context())
|
||||
reportReq.SetPathValue("ip", "8.8.8.8")
|
||||
h.Report(report, reportReq)
|
||||
if report.Code != http.StatusOK || !strings.Contains(report.Body.String(), `"abuseConfidenceScore":80`) {
|
||||
t.Fatalf("report response: %d %s", report.Code, report.Body.String())
|
||||
}
|
||||
if gotKey != "test-key" {
|
||||
t.Fatalf("key header = %q", gotKey)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRejectsPrivateAndUnconfigured(t *testing.T) {
|
||||
private := httptest.NewRecorder()
|
||||
privateReq := httptest.NewRequest(http.MethodGet, "/api/source-ips/192.168.1.2/abuseipdb", nil)
|
||||
privateReq.SetPathValue("ip", "192.168.1.2")
|
||||
NewHandler(Config{Key: "test-key", BaseURL: "http://invalid"}).Check(private, privateReq)
|
||||
if private.Code != http.StatusBadRequest {
|
||||
t.Fatalf("private status = %d", private.Code)
|
||||
}
|
||||
unconfigured := httptest.NewRecorder()
|
||||
unconfiguredReq := httptest.NewRequest(http.MethodGet, "/api/source-ips/8.8.8.8/abuseipdb", nil)
|
||||
unconfiguredReq.SetPathValue("ip", "8.8.8.8")
|
||||
NewHandler(Config{}).Check(unconfigured, unconfiguredReq)
|
||||
if unconfigured.Code != http.StatusNotImplemented {
|
||||
t.Fatalf("unconfigured status = %d", unconfigured.Code)
|
||||
}
|
||||
}
|
||||
@@ -166,6 +166,79 @@ type Status struct {
|
||||
Error string `json:"error,omitempty"`
|
||||
}
|
||||
|
||||
// Add manually adds one public IP to the blocker-managed set. It uses the
|
||||
// same expiry, allowlist, ConfigMap ownership, and dry-run rules as automatic
|
||||
// blocks.
|
||||
func (b *Blocker) Add(ctx context.Context, address string) (Status, error) {
|
||||
addr, err := netip.ParseAddr(strings.TrimSpace(address))
|
||||
if err != nil || honeypot.Untrackable(address) {
|
||||
return Status{}, fmt.Errorf("only public unicast IPs can be blocked")
|
||||
}
|
||||
for _, p := range b.cfg.Allow {
|
||||
if p.Contains(addr) {
|
||||
return Status{}, fmt.Errorf("IP is on the operator allowlist")
|
||||
}
|
||||
}
|
||||
|
||||
b.mu.Lock()
|
||||
defer b.mu.Unlock()
|
||||
now := b.now()
|
||||
cms := b.client.CoreV1().ConfigMaps(b.cfg.Namespace)
|
||||
cm, err := cms.Get(ctx, b.cfg.ConfigMap, metav1.GetOptions{})
|
||||
if err != nil {
|
||||
return Status{}, fmt.Errorf("get configmap: %w", err)
|
||||
}
|
||||
previous := map[string]int64{}
|
||||
if raw := cm.Annotations[AnnotationManaged]; raw != "" {
|
||||
_ = json.Unmarshal([]byte(raw), &previous)
|
||||
}
|
||||
managed := map[string]int64{}
|
||||
for ip, exp := range previous {
|
||||
if exp > now.Unix() {
|
||||
managed[ip] = exp
|
||||
}
|
||||
}
|
||||
if _, exists := managed[addr.String()]; !exists && len(managed) >= b.cfg.MaxEntries {
|
||||
return Status{}, fmt.Errorf("managed block list is full")
|
||||
}
|
||||
managed[addr.String()] = now.Add(b.cfg.BlockTTL).Unix()
|
||||
|
||||
status := Status{Enabled: true, DryRun: b.cfg.DryRun, Evaluated: now, Managed: managed, LastWrite: b.lastWrite}
|
||||
if b.cfg.DryRun {
|
||||
b.last = status
|
||||
return status, nil
|
||||
}
|
||||
if !b.lastWrite.IsZero() && now.Sub(b.lastWrite) < b.cfg.MinWrite {
|
||||
return status, fmt.Errorf("block list was recently updated; try again later")
|
||||
}
|
||||
|
||||
current := splitCIDRs(cm.Data[b.cfg.Key])
|
||||
manual := make([]string, 0, len(current))
|
||||
for _, entry := range current {
|
||||
if _, wasOurs := previous[entry]; !wasOurs {
|
||||
manual = append(manual, entry)
|
||||
}
|
||||
}
|
||||
desired := append(manual, managedList(managed)...)
|
||||
if cm.Annotations == nil {
|
||||
cm.Annotations = map[string]string{}
|
||||
}
|
||||
if cm.Data == nil {
|
||||
cm.Data = map[string]string{}
|
||||
}
|
||||
state, _ := json.Marshal(managed)
|
||||
cm.Annotations[AnnotationManaged] = string(state)
|
||||
cm.Data[b.cfg.Key] = strings.Join(dedupSorted(desired), ",")
|
||||
if _, err := cms.Update(ctx, cm, metav1.UpdateOptions{}); err != nil {
|
||||
return Status{}, fmt.Errorf("update configmap: %w", err)
|
||||
}
|
||||
b.lastWrite, b.lastErr = now, ""
|
||||
status.Wrote, status.LastWrite = true, now
|
||||
b.last = status
|
||||
log.Printf("blocker: manually added %s (expires %s)", addr, time.Unix(managed[addr.String()], 0).UTC().Format(time.RFC3339))
|
||||
return status, nil
|
||||
}
|
||||
|
||||
func New(cfg Config, client kubernetes.Interface, source Source) *Blocker {
|
||||
d := DefaultConfig()
|
||||
if cfg.Interval <= 0 {
|
||||
@@ -350,6 +423,25 @@ func (b *Blocker) HandleStatus(w http.ResponseWriter, r *http.Request) {
|
||||
_ = json.NewEncoder(w).Encode(s)
|
||||
}
|
||||
|
||||
// HandleAdd serves POST /api/blocker/ips/{ip}. Register it behind
|
||||
// authentication; it never permits private or allowlisted addresses.
|
||||
func (b *Blocker) HandleAdd(w http.ResponseWriter, r *http.Request) {
|
||||
status, err := b.Add(r.Context(), r.PathValue("ip"))
|
||||
if err != nil {
|
||||
code := http.StatusBadRequest
|
||||
if strings.Contains(err.Error(), "recently updated") {
|
||||
code = http.StatusTooManyRequests
|
||||
}
|
||||
http.Error(w, err.Error(), code)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
if status.DryRun {
|
||||
w.WriteHeader(http.StatusAccepted)
|
||||
}
|
||||
_ = json.NewEncoder(w).Encode(status)
|
||||
}
|
||||
|
||||
func splitCIDRs(v string) []string {
|
||||
var out []string
|
||||
for _, p := range strings.Split(v, ",") {
|
||||
|
||||
@@ -22,6 +22,7 @@ import (
|
||||
"git.tornberg.me/go-otel/internal/websocket"
|
||||
|
||||
"go.opentelemetry.io/collector/consumer"
|
||||
"go.opentelemetry.io/collector/pdata/pcommon"
|
||||
"go.opentelemetry.io/collector/pdata/plog"
|
||||
"go.opentelemetry.io/collector/pdata/pmetric"
|
||||
"go.opentelemetry.io/collector/pdata/ptrace"
|
||||
@@ -42,6 +43,7 @@ type Collector struct {
|
||||
|
||||
ingestLimiter *ipRateLimiter
|
||||
ingestKey string
|
||||
sourceMapKey string
|
||||
|
||||
notifyIssuesFn func()
|
||||
|
||||
@@ -49,6 +51,7 @@ type Collector struct {
|
||||
// The stats endpoints return 501 when it's nil so the UI can hide those
|
||||
// views instead of erroring.
|
||||
statsQuerier storage.StatsQuerier
|
||||
sourceIPs storage.SourceIPQuerier
|
||||
sourceMaps *sourcemaps.Resolver
|
||||
kubeWatcher *kube.Watcher
|
||||
prometheus *prometheus.Client
|
||||
@@ -111,6 +114,9 @@ func (c *Collector) SetIngestKey(key string) {
|
||||
c.ingestKey = key
|
||||
}
|
||||
|
||||
// SetSourceMapKey sets the shared key required to upload source maps.
|
||||
func (c *Collector) SetSourceMapKey(key string) { c.sourceMapKey = key }
|
||||
|
||||
// HoneypotRecorder receives suspicious request observations extracted from
|
||||
// telemetry. It is intentionally a small interface so the collector does not
|
||||
// depend on the HTTP honeypot implementation.
|
||||
@@ -390,7 +396,9 @@ func (c *Collector) ConsumeTraces(ctx context.Context, td ptrace.Traces) error {
|
||||
Data: buf,
|
||||
}
|
||||
|
||||
c.broadcaster.Broadcast(&entry)
|
||||
if c.broadcaster != nil {
|
||||
c.broadcaster.Broadcast(&entry)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -411,7 +419,9 @@ func (c *Collector) ConsumeMetrics(ctx context.Context, md pmetric.Metrics) erro
|
||||
Data: buf,
|
||||
}
|
||||
|
||||
c.broadcaster.Broadcast(&entry)
|
||||
if c.broadcaster != nil {
|
||||
c.broadcaster.Broadcast(&entry)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -436,11 +446,50 @@ func (c *Collector) ConsumeLogs(ctx context.Context, ld plog.Logs) error {
|
||||
Data: buf,
|
||||
}
|
||||
|
||||
c.broadcaster.Broadcast(&entry)
|
||||
if c.broadcaster != nil {
|
||||
c.broadcaster.Broadcast(&entry)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// EmitInternalLog records a diagnostic generated by this server as an OTLP
|
||||
// log. Keeping these in the same pipeline as customer telemetry makes deploy
|
||||
// and ingestion problems visible in the UI's Logs view. Values are deliberately
|
||||
// limited to scalar attributes so callers cannot accidentally attach payloads.
|
||||
func (c *Collector) EmitInternalLog(ctx context.Context, severity plog.SeverityNumber, body string, attrs map[string]any, traceID pcommon.TraceID, spanID pcommon.SpanID) error {
|
||||
logs := plog.NewLogs()
|
||||
rl := logs.ResourceLogs().AppendEmpty()
|
||||
rl.Resource().Attributes().PutStr("service.name", "go-otel")
|
||||
rl.Resource().Attributes().PutStr("telemetry.sdk.name", "go-otel-internal")
|
||||
sl := rl.ScopeLogs().AppendEmpty()
|
||||
sl.Scope().SetName("git.tornberg.me/go-otel/internal")
|
||||
record := sl.LogRecords().AppendEmpty()
|
||||
record.SetTimestamp(pcommon.NewTimestampFromTime(time.Now()))
|
||||
record.SetObservedTimestamp(pcommon.NewTimestampFromTime(time.Now()))
|
||||
record.SetSeverityNumber(severity)
|
||||
record.Body().SetStr(body)
|
||||
if !traceID.IsEmpty() {
|
||||
record.SetTraceID(traceID)
|
||||
}
|
||||
if !spanID.IsEmpty() {
|
||||
record.SetSpanID(spanID)
|
||||
}
|
||||
for key, value := range attrs {
|
||||
switch value := value.(type) {
|
||||
case string:
|
||||
record.Attributes().PutStr(key, value)
|
||||
case int:
|
||||
record.Attributes().PutInt(key, int64(value))
|
||||
case int64:
|
||||
record.Attributes().PutInt(key, value)
|
||||
case bool:
|
||||
record.Attributes().PutBool(key, value)
|
||||
}
|
||||
}
|
||||
return c.ConsumeLogs(ctx, logs)
|
||||
}
|
||||
|
||||
// Capabilities returns the capabilities of the collector.
|
||||
func (c *Collector) Capabilities() consumer.Capabilities {
|
||||
return consumer.Capabilities{MutatesData: false}
|
||||
|
||||
@@ -383,6 +383,21 @@ func TestHandleIssuesAndByID(t *testing.T) {
|
||||
t.Fatalf("expected 200 for known issue id, got %d", rec.Code)
|
||||
}
|
||||
|
||||
req = httptest.NewRequest(http.MethodPatch, "/api/issues/"+id, bytes.NewBufferString(`{"status":"resolved"}`))
|
||||
req.SetPathValue("id", id)
|
||||
rec = httptest.NewRecorder()
|
||||
coll.HandleIssueByID(rec, req)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("expected 200 when resolving known issue, got %d: %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
var updated map[string]any
|
||||
if err := json.Unmarshal(rec.Body.Bytes(), &updated); err != nil {
|
||||
t.Fatalf("failed to decode updated issue response: %v", err)
|
||||
}
|
||||
if updated["status"] != "resolved" {
|
||||
t.Fatalf("expected resolved issue, got %+v", updated["status"])
|
||||
}
|
||||
|
||||
req = httptest.NewRequest(http.MethodGet, "/api/issues/missing", nil)
|
||||
req.SetPathValue("id", "missing")
|
||||
rec = httptest.NewRecorder()
|
||||
@@ -530,6 +545,72 @@ func TestHandleLogsIngestKey(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleLogsPodGuardianIntegration(t *testing.T) {
|
||||
coll := New(noopBroadcaster{}, 10, nil)
|
||||
coll.SetIngestKey("ingest-secret")
|
||||
|
||||
// Payload matching what fervent-franklin (k8s-pod-guardian) sends
|
||||
payload := `{
|
||||
"resourceLogs": [
|
||||
{
|
||||
"resource": {
|
||||
"attributes": [
|
||||
{ "key": "service.name", "value": { "stringValue": "payment-service" } },
|
||||
{ "key": "service.environment", "value": { "stringValue": "production" } },
|
||||
{ "key": "telemetry.source", "value": { "stringValue": "k8s-pod-guardian" } },
|
||||
{ "key": "k8s.namespace.name", "value": { "stringValue": "default" } },
|
||||
{ "key": "k8s.pod.name", "value": { "stringValue": "payment-api-6789-xyz" } },
|
||||
{ "key": "k8s.container.name", "value": { "stringValue": "payment-api" } },
|
||||
{ "key": "host.name", "value": { "stringValue": "worker-1" } }
|
||||
]
|
||||
},
|
||||
"scopeLogs": [
|
||||
{
|
||||
"scope": { "name": "k8s-pod-guardian/crashloop-harvester" },
|
||||
"logRecords": [
|
||||
{
|
||||
"timeUnixNano": "1779362400000000000",
|
||||
"severityNumber": 17,
|
||||
"severityText": "ERROR",
|
||||
"body": {
|
||||
"stringValue": "panic: database connection failed: dial tcp 10.96.0.10:5432: i/o timeout"
|
||||
},
|
||||
"attributes": [
|
||||
{ "key": "k8s.container.restart_count", "value": { "stringValue": "5" } },
|
||||
{ "key": "crashloop.reason", "value": { "stringValue": "CrashLoopBackOff" } }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}`
|
||||
|
||||
req := httptest.NewRequest(http.MethodPost, "/v1/logs", bytes.NewReader([]byte(payload)))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
req.Header.Set("X-Otel-Ingest-Key", "ingest-secret")
|
||||
req.RemoteAddr = "192.0.2.1:12345"
|
||||
|
||||
rec := httptest.NewRecorder()
|
||||
coll.HandleLogs(rec, req)
|
||||
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("expected status 200, got %d (body=%s)", rec.Code, rec.Body.String())
|
||||
}
|
||||
|
||||
issues := coll.ListIssues(10)
|
||||
if len(issues) != 1 {
|
||||
t.Fatalf("expected 1 issue created from crash log, got %d", len(issues))
|
||||
}
|
||||
if issues[0].Service != "payment-service" {
|
||||
t.Errorf("expected issue service 'payment-service', got %q", issues[0].Service)
|
||||
}
|
||||
if !strings.Contains(issues[0].Title, "panic: database connection failed") {
|
||||
t.Errorf("unexpected issue title: %q", issues[0].Title)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleLogsIngestRateLimited(t *testing.T) {
|
||||
coll := New(noopBroadcaster{}, 10, nil)
|
||||
body := []byte(`{"resourceLogs":[]}`)
|
||||
|
||||
@@ -4,7 +4,9 @@ package collector
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/subtle"
|
||||
"encoding/base64"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"git.tornberg.me/go-otel/internal/sourcemaps"
|
||||
@@ -20,6 +22,7 @@ import (
|
||||
"git.tornberg.me/go-otel/internal/issues"
|
||||
"git.tornberg.me/go-otel/internal/storage"
|
||||
"git.tornberg.me/go-otel/internal/websocket"
|
||||
"go.opentelemetry.io/collector/pdata/pcommon"
|
||||
"go.opentelemetry.io/collector/pdata/plog"
|
||||
"go.opentelemetry.io/collector/pdata/pmetric"
|
||||
"go.opentelemetry.io/collector/pdata/ptrace"
|
||||
@@ -477,32 +480,116 @@ func encodeIssueCursor(lastSeen int64, id string) string {
|
||||
// HandleSourceMap accepts a JavaScript source map for a deployed release.
|
||||
// Multipart fields: release, source, file.
|
||||
func (c *Collector) HandleSourceMap(w http.ResponseWriter, r *http.Request) {
|
||||
traceID, spanID := traceContextFromRequest(r)
|
||||
logUpload := func(severity plog.SeverityNumber, body string, attrs map[string]any) {
|
||||
if err := c.EmitInternalLog(r.Context(), severity, body, attrs, traceID, spanID); err != nil {
|
||||
log.Printf("failed to emit sourcemap diagnostic: %v", err)
|
||||
}
|
||||
}
|
||||
logUpload(plog.SeverityNumberInfo, "sourcemap upload received", map[string]any{
|
||||
"event.name": "sourcemap.upload",
|
||||
"http.route": "/api/sourcemaps",
|
||||
"http.request.method": r.Method,
|
||||
})
|
||||
if r.Method != http.MethodPost {
|
||||
logUpload(plog.SeverityNumberWarn, "sourcemap upload rejected: method not allowed", map[string]any{
|
||||
"event.name": "sourcemap.upload.rejected",
|
||||
"sourcemap.failure_stage": "method",
|
||||
})
|
||||
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
if !c.checkSourceMapKey(r) {
|
||||
logUpload(plog.SeverityNumberWarn, "sourcemap upload rejected: invalid or missing key", map[string]any{
|
||||
"event.name": "sourcemap.upload.rejected",
|
||||
"sourcemap.failure_stage": "auth",
|
||||
"client.address": clientIP(r),
|
||||
})
|
||||
http.Error(w, "invalid or missing sourcemap key", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
if c.sourceMaps == nil {
|
||||
logUpload(plog.SeverityNumberError, "sourcemap upload failed: resolver is not configured", map[string]any{
|
||||
"event.name": "sourcemap.upload.failed",
|
||||
"sourcemap.failure_stage": "configuration",
|
||||
})
|
||||
http.Error(w, "source maps are not configured", http.StatusNotImplemented)
|
||||
return
|
||||
}
|
||||
if err := r.ParseMultipartForm(50 << 20); err != nil {
|
||||
logUpload(plog.SeverityNumberError, "sourcemap upload failed: invalid multipart body", map[string]any{
|
||||
"event.name": "sourcemap.upload.failed",
|
||||
"sourcemap.failure_stage": "multipart",
|
||||
"error.type": "multipart_parse",
|
||||
})
|
||||
http.Error(w, "invalid multipart body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
release, source := r.FormValue("release"), r.FormValue("source")
|
||||
file, _, err := r.FormFile("file")
|
||||
file, fileHeader, err := r.FormFile("file")
|
||||
if err != nil {
|
||||
logUpload(plog.SeverityNumberError, "sourcemap upload failed: file is missing", map[string]any{
|
||||
"event.name": "sourcemap.upload.failed",
|
||||
"sourcemap.failure_stage": "file",
|
||||
"sourcemap.release": release,
|
||||
"sourcemap.source": source,
|
||||
"error.type": "missing_file",
|
||||
})
|
||||
http.Error(w, "file is required", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
defer file.Close()
|
||||
if err := c.sourceMaps.Upload(release, source, file); err != nil {
|
||||
logUpload(plog.SeverityNumberError, "sourcemap upload failed", map[string]any{
|
||||
"event.name": "sourcemap.upload.failed",
|
||||
"sourcemap.failure_stage": "store",
|
||||
"sourcemap.release": release,
|
||||
"sourcemap.source": source,
|
||||
"sourcemap.size_bytes": fileHeader.Size,
|
||||
"error.type": "source_map_invalid_or_unwritable",
|
||||
"error.message": err.Error(),
|
||||
})
|
||||
http.Error(w, err.Error(), http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
logUpload(plog.SeverityNumberInfo, "sourcemap upload stored", map[string]any{
|
||||
"event.name": "sourcemap.upload.stored",
|
||||
"sourcemap.release": release,
|
||||
"sourcemap.source": source,
|
||||
"sourcemap.size_bytes": fileHeader.Size,
|
||||
})
|
||||
w.WriteHeader(http.StatusCreated)
|
||||
}
|
||||
|
||||
// checkSourceMapKey authenticates a source map upload against the shared
|
||||
// OTEL_SOURCEMAP_KEY (X-Sourcemap-Key header). Uploads are refused while no key
|
||||
// is configured so the endpoint is never open by accident.
|
||||
func (c *Collector) checkSourceMapKey(r *http.Request) bool {
|
||||
if c.sourceMapKey == "" {
|
||||
return false
|
||||
}
|
||||
got := r.Header.Get("X-Sourcemap-Key")
|
||||
return subtle.ConstantTimeCompare([]byte(got), []byte(c.sourceMapKey)) == 1
|
||||
}
|
||||
|
||||
// traceContextFromRequest preserves the caller's trace linkage for internal
|
||||
// logs when the upload came through an instrumented client or proxy.
|
||||
func traceContextFromRequest(r *http.Request) (pcommon.TraceID, pcommon.SpanID) {
|
||||
var traceID pcommon.TraceID
|
||||
var spanID pcommon.SpanID
|
||||
parts := strings.Split(r.Header.Get("Traceparent"), "-")
|
||||
if len(parts) != 4 || len(parts[1]) != 32 || len(parts[2]) != 16 {
|
||||
return traceID, spanID
|
||||
}
|
||||
if _, err := hex.Decode(traceID[:], []byte(parts[1])); err != nil {
|
||||
return pcommon.NewTraceIDEmpty(), pcommon.NewSpanIDEmpty()
|
||||
}
|
||||
if _, err := hex.Decode(spanID[:], []byte(parts[2])); err != nil {
|
||||
return pcommon.NewTraceIDEmpty(), pcommon.NewSpanIDEmpty()
|
||||
}
|
||||
return traceID, spanID
|
||||
}
|
||||
|
||||
// HandleListSourceMaps lists the release/source pairs currently loaded, so a
|
||||
// deploy can verify its uploads (and that they survived a restart).
|
||||
func (c *Collector) HandleListSourceMaps(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -518,6 +605,18 @@ func (c *Collector) HandleListSourceMaps(w http.ResponseWriter, r *http.Request)
|
||||
// uploaded source maps. Body: {"items":[{"release":"...","stacktrace":"..."}]};
|
||||
// the response has one resolved stacktrace per item, in order.
|
||||
func (c *Collector) HandleResolveStacks(w http.ResponseWriter, r *http.Request) {
|
||||
traceID, spanID := traceContextFromRequest(r)
|
||||
logResolve := func(severity plog.SeverityNumber, body string, attrs map[string]any) {
|
||||
if err := c.EmitInternalLog(r.Context(), severity, body, attrs, traceID, spanID); err != nil {
|
||||
log.Printf("failed to emit sourcemap diagnostic: %v", err)
|
||||
}
|
||||
}
|
||||
logResolve(plog.SeverityNumberInfo, "sourcemap resolution received", map[string]any{
|
||||
"event.name": "sourcemap.resolve",
|
||||
"http.route": "/api/sourcemaps/resolve",
|
||||
"http.request.method": r.Method,
|
||||
"sourcemap.resolver_ready": c.sourceMaps != nil,
|
||||
})
|
||||
var req struct {
|
||||
Items []struct {
|
||||
Release string `json:"release"`
|
||||
@@ -525,11 +624,17 @@ func (c *Collector) HandleResolveStacks(w http.ResponseWriter, r *http.Request)
|
||||
} `json:"items"`
|
||||
}
|
||||
if err := json.NewDecoder(http.MaxBytesReader(w, r.Body, 4<<20)).Decode(&req); err != nil {
|
||||
logResolve(plog.SeverityNumberError, "sourcemap resolution failed: invalid body", map[string]any{
|
||||
"event.name": "sourcemap.resolve.failed",
|
||||
"sourcemap.failure_stage": "decode",
|
||||
"error.type": "invalid_json",
|
||||
})
|
||||
http.Error(w, "invalid body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
out := make([]string, len(req.Items))
|
||||
frames := make([][]sourcemaps.Frame, len(req.Items))
|
||||
statusCounts := map[string]int{}
|
||||
for i, it := range req.Items {
|
||||
out[i] = it.Stacktrace
|
||||
frames[i] = []sourcemaps.Frame{}
|
||||
@@ -537,7 +642,20 @@ func (c *Collector) HandleResolveStacks(w http.ResponseWriter, r *http.Request)
|
||||
out[i] = c.sourceMaps.ResolveStack(it.Release, it.Stacktrace)
|
||||
frames[i] = c.sourceMaps.ResolveFrames(it.Release, it.Stacktrace)
|
||||
}
|
||||
for _, frame := range frames[i] {
|
||||
statusCounts[frame.Status]++
|
||||
}
|
||||
}
|
||||
logResolve(plog.SeverityNumberInfo, "sourcemap resolution completed", map[string]any{
|
||||
"event.name": "sourcemap.resolve.completed",
|
||||
"sourcemap.item_count": len(req.Items),
|
||||
"sourcemap.frame_count": statusCounts["mapped"] + statusCounts["no-release"] + statusCounts["no-map"] + statusCounts["unmapped"],
|
||||
"sourcemap.mapped": statusCounts["mapped"],
|
||||
"sourcemap.no_release": statusCounts["no-release"],
|
||||
"sourcemap.no_map": statusCounts["no-map"],
|
||||
"sourcemap.unmapped": statusCounts["unmapped"],
|
||||
"sourcemap.resolver_ready": c.sourceMaps != nil,
|
||||
})
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"resolved": out, "frames": frames})
|
||||
}
|
||||
|
||||
@@ -175,6 +175,28 @@ func (c *Collector) HandleIssueTraces(w http.ResponseWriter, r *http.Request) {
|
||||
}
|
||||
}
|
||||
|
||||
// HandleIssueSources returns all distinct source IPs recorded for an issue.
|
||||
// This is separate from /traces because trace pages intentionally bound the
|
||||
// number of raw samples returned per trace.
|
||||
func (c *Collector) HandleIssueSources(w http.ResponseWriter, r *http.Request) {
|
||||
id := r.PathValue("id")
|
||||
if c.occStore == nil {
|
||||
http.Error(w, "issue source history requires ClickHouse storage", http.StatusNotImplemented)
|
||||
return
|
||||
}
|
||||
sources, err := c.occStore.IssueSources(r.Context(), id)
|
||||
if err != nil {
|
||||
log.Printf("failed to load issue sources %s: %v", id, err)
|
||||
http.Error(w, "failed to load issue sources", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
if sources == nil {
|
||||
sources = []storage.IssueSource{}
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(sources)
|
||||
}
|
||||
|
||||
// groupInMemory builds the same shape from the tracker's bounded samples,
|
||||
// newest trace first.
|
||||
func groupInMemory(samples []issues.Sample) ([]issueTraceJSON, []issues.Sample) {
|
||||
|
||||
@@ -34,6 +34,10 @@ func (o *occStore) IssueTraces(context.Context, string, storage.IssueTracesOptio
|
||||
return o.page, nil
|
||||
}
|
||||
|
||||
func (o *occStore) IssueSources(context.Context, string) ([]storage.IssueSource, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (o *occStore) TraceEntries(context.Context, string, int) ([]websocket.HistoryEntry, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
package collector
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"log"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.tornberg.me/go-otel/internal/features"
|
||||
"git.tornberg.me/go-otel/internal/storage"
|
||||
"git.tornberg.me/go-otel/internal/triage"
|
||||
"git.tornberg.me/go-otel/internal/uaclass"
|
||||
)
|
||||
|
||||
// SetSourceIPQuerier enables the source address endpoints.
|
||||
func (c *Collector) SetSourceIPQuerier(q storage.SourceIPQuerier) { c.sourceIPs = q }
|
||||
|
||||
func (c *Collector) sourceIPsEnabled(w http.ResponseWriter) bool {
|
||||
if c.sourceIPs == nil {
|
||||
statsNotEnabled(w)
|
||||
return false
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
// HandleSourceIPs lists every unique source address ever recorded.
|
||||
// Query: q (substring), hours (only addresses seen within), limit.
|
||||
func (c *Collector) HandleSourceIPs(w http.ResponseWriter, r *http.Request) {
|
||||
if !c.sourceIPsEnabled(w) {
|
||||
return
|
||||
}
|
||||
var since time.Time
|
||||
if _, hours := parseStatsCommon(r); r.URL.Query().Get("hours") != "" {
|
||||
since = time.Now().Add(-time.Duration(hours) * time.Hour)
|
||||
}
|
||||
ips, err := c.sourceIPs.SourceIPs(r.Context(), strings.TrimSpace(r.URL.Query().Get("q")), since, parseLimit(r, 200))
|
||||
if err != nil {
|
||||
log.Printf("failed to list source ips: %v", err)
|
||||
http.Error(w, "failed to list source ips", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
// Judge scanning behaviour over the last week for the whole page in one
|
||||
// query. A failure only drops the hints; the list itself is still useful.
|
||||
addrs := make([]string, len(ips))
|
||||
for i := range ips {
|
||||
addrs[i] = ips[i].IP
|
||||
}
|
||||
if routes, err := c.sourceIPs.SourceIPRoutes(r.Context(), addrs, time.Now().Add(-7*24*time.Hour)); err != nil {
|
||||
log.Printf("failed to assess source ips: %v", err)
|
||||
} else {
|
||||
for i := range ips {
|
||||
ips[i].BadActor, ips[i].ProbePaths = assessSourceIP(ips[i].IP, routes[ips[i].IP])
|
||||
}
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"ips": ips})
|
||||
}
|
||||
|
||||
// HandleSourceIPActivity lists the recent requests made from one address.
|
||||
// Query: hours (default 168), limit.
|
||||
func (c *Collector) HandleSourceIPActivity(w http.ResponseWriter, r *http.Request) {
|
||||
if !c.sourceIPsEnabled(w) {
|
||||
return
|
||||
}
|
||||
addr, err := netip.ParseAddr(r.PathValue("ip"))
|
||||
if err != nil {
|
||||
http.Error(w, "invalid ip", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
_, hours := parseStatsCommon(r)
|
||||
if r.URL.Query().Get("hours") == "" {
|
||||
hours = 24 * 7
|
||||
}
|
||||
events, err := c.sourceIPs.SourceIPActivity(r.Context(), addr.String(), time.Now().Add(-time.Duration(hours)*time.Hour), parseLimit(r, 200))
|
||||
if err != nil {
|
||||
log.Printf("failed to load source ip activity: %v", err)
|
||||
http.Error(w, "failed to load source ip activity", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
reason, probes := assessSourceIP(addr.String(), events)
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||
"ip": addr.String(), "hours": hours, "events": events,
|
||||
// badActor is the first matching features.MarkBadActors rule over the
|
||||
// returned window; probePaths is how many distinct probe paths it hit.
|
||||
"badActor": reason, "probePaths": probes,
|
||||
})
|
||||
}
|
||||
|
||||
// assessSourceIP applies the same bad-actor rules the detector uses to one
|
||||
// address's requests, so the hint in the UI never disagrees with triage.
|
||||
func assessSourceIP(ip string, events []storage.SourceIPEvent) (reason string, probePaths int) {
|
||||
fe := make([]features.Event, len(events))
|
||||
probes := map[string]struct{}{}
|
||||
for i, e := range events {
|
||||
fe[i] = features.Event{Route: e.Route, StatusCode: int(e.StatusCode), ClientIP: ip, UAClass: uaclass.Of(e.UserAgent)}
|
||||
if triage.IsProbePath(e.Route) {
|
||||
probes[e.Route] = struct{}{}
|
||||
}
|
||||
}
|
||||
features.MarkBadActors(fe, features.BadActorConfig{})
|
||||
for _, e := range fe {
|
||||
if e.BadActor != "" {
|
||||
return e.BadActor, len(probes)
|
||||
}
|
||||
}
|
||||
return "", len(probes)
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
package collector
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"git.tornberg.me/go-otel/internal/storage"
|
||||
)
|
||||
|
||||
func TestAssessSourceIP(t *testing.T) {
|
||||
ev := func(route string, status uint16, ua string) storage.SourceIPEvent {
|
||||
return storage.SourceIPEvent{Route: route, StatusCode: status, UserAgent: ua}
|
||||
}
|
||||
browser := "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 Chrome/120 Safari/537.36"
|
||||
|
||||
if r, _ := assessSourceIP("1.2.3.4", []storage.SourceIPEvent{ev("/", 200, browser), ev("/cart", 200, browser)}); r != "" {
|
||||
t.Errorf("normal traffic flagged as %q", r)
|
||||
}
|
||||
probes := []storage.SourceIPEvent{ev("/.env", 404, browser), ev("/.git/config", 404, browser), ev("/wp-admin", 404, browser)}
|
||||
if r, n := assessSourceIP("1.2.3.4", probes); r != "probe-scanner" || n != 3 {
|
||||
t.Errorf("probes: got %q, %d", r, n)
|
||||
}
|
||||
var walk []storage.SourceIPEvent
|
||||
for i := 0; i < 15; i++ {
|
||||
walk = append(walk, ev(fmt.Sprintf("/missing-%d", i), 404, browser))
|
||||
}
|
||||
if r, _ := assessSourceIP("1.2.3.4", walk); r != "enumerator" {
|
||||
t.Errorf("enumeration: got %q", r)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,509 @@
|
||||
// Package investigation provides bounded, authenticated IP enrichment for the
|
||||
// operator UI. Passive lookups use PTR and RDAP. Active probing is deliberately
|
||||
// disabled unless the operator enables it explicitly.
|
||||
package investigation
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"os"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
type Config struct {
|
||||
NmapEnabled bool
|
||||
NmapBinary string
|
||||
// NmapTimeout bounds one whole scan (OTEL_IP_INVESTIGATION_NMAP_TIMEOUT,
|
||||
// a Go duration; default 5m). nmap's own --host-timeout is set below it.
|
||||
NmapTimeout time.Duration
|
||||
}
|
||||
|
||||
func ConfigFromEnv() Config {
|
||||
binary := os.Getenv("OTEL_IP_INVESTIGATION_NMAP_BINARY")
|
||||
if binary == "" {
|
||||
binary = "nmap"
|
||||
}
|
||||
timeout := 5 * time.Minute
|
||||
if d, err := time.ParseDuration(os.Getenv("OTEL_IP_INVESTIGATION_NMAP_TIMEOUT")); err == nil && d >= 30*time.Second {
|
||||
timeout = d
|
||||
}
|
||||
return Config{NmapEnabled: strings.EqualFold(os.Getenv("OTEL_IP_INVESTIGATION_NMAP"), "true"), NmapBinary: binary, NmapTimeout: timeout}
|
||||
}
|
||||
|
||||
type Service struct {
|
||||
Port uint16 `json:"port"`
|
||||
Protocol string `json:"protocol"`
|
||||
State string `json:"state"`
|
||||
Name string `json:"name,omitempty"`
|
||||
Product string `json:"product,omitempty"`
|
||||
Version string `json:"version,omitempty"`
|
||||
// Scripts holds selected NSE output keyed by script id (http-title, ssl-cert).
|
||||
Scripts map[string]string `json:"scripts,omitempty"`
|
||||
}
|
||||
|
||||
// Debug describes how an active scan ran, so the UI can explain failures.
|
||||
type Debug struct {
|
||||
Command string `json:"command"`
|
||||
DurationMs int64 `json:"durationMs"`
|
||||
ExitError string `json:"exitError,omitempty"`
|
||||
TimedOut bool `json:"timedOut,omitempty"`
|
||||
Stderr string `json:"stderr,omitempty"`
|
||||
HostState string `json:"hostState,omitempty"`
|
||||
Summary string `json:"summary,omitempty"`
|
||||
Partial bool `json:"partial,omitempty"`
|
||||
}
|
||||
|
||||
type errorBody struct {
|
||||
Error string `json:"error"`
|
||||
Debug *Debug `json:"debug,omitempty"`
|
||||
}
|
||||
|
||||
type PassiveResult struct {
|
||||
IP string `json:"ip"`
|
||||
Hostnames []string `json:"hostnames,omitempty"`
|
||||
RDAP *RDAP `json:"rdap,omitempty"`
|
||||
Warnings []string `json:"warnings,omitempty"`
|
||||
CompletedAt string `json:"completedAt"`
|
||||
}
|
||||
|
||||
type RDAP struct {
|
||||
Name string `json:"name,omitempty"`
|
||||
Handle string `json:"handle,omitempty"`
|
||||
Start string `json:"start,omitempty"`
|
||||
End string `json:"end,omitempty"`
|
||||
Country string `json:"country,omitempty"`
|
||||
Registry string `json:"registry,omitempty"`
|
||||
Organization string `json:"organization,omitempty"`
|
||||
AbuseEmail string `json:"abuseEmail,omitempty"`
|
||||
}
|
||||
|
||||
type ActiveResult struct {
|
||||
IP string `json:"ip"`
|
||||
Services []Service `json:"services,omitempty"`
|
||||
Debug *Debug `json:"debug,omitempty"`
|
||||
CompletedAt string `json:"completedAt"`
|
||||
}
|
||||
|
||||
// Record is one investigation of one address, as returned to the UI and
|
||||
// persisted. Status is running, done or failed; only finished records are
|
||||
// stored, so a restart drops in-flight jobs rather than leaving them running.
|
||||
type Record struct {
|
||||
IP string `json:"ip"`
|
||||
Mode string `json:"mode"`
|
||||
Status string `json:"status"`
|
||||
StartedAt time.Time `json:"startedAt"`
|
||||
FinishedAt *time.Time `json:"finishedAt,omitempty"`
|
||||
Error string `json:"error,omitempty"`
|
||||
Passive *PassiveResult `json:"passive,omitempty"`
|
||||
Active *ActiveResult `json:"active,omitempty"`
|
||||
// Debug is kept on failures, where there is no Active result to hold it.
|
||||
Debug *Debug `json:"debug,omitempty"`
|
||||
}
|
||||
|
||||
// Store persists finished records. Nil means in-memory only.
|
||||
type Store interface {
|
||||
Save(ctx context.Context, rec Record) error
|
||||
Load(ctx context.Context, ip string) ([]Record, error)
|
||||
}
|
||||
|
||||
type Handler struct {
|
||||
cfg Config
|
||||
client *http.Client
|
||||
store Store
|
||||
lastScan time.Time
|
||||
mu sync.Mutex
|
||||
jobs map[string]*Record // key: ip|mode; latest in-process record
|
||||
}
|
||||
|
||||
func NewHandler(cfg Config, store Store) *Handler {
|
||||
if cfg.NmapTimeout <= 0 {
|
||||
cfg.NmapTimeout = 5 * time.Minute
|
||||
}
|
||||
return &Handler{cfg: cfg, store: store, client: &http.Client{Timeout: 8 * time.Second}, jobs: map[string]*Record{}}
|
||||
}
|
||||
|
||||
func parsePublicIP(r *http.Request) (netip.Addr, bool) {
|
||||
ip, err := netip.ParseAddr(strings.TrimSpace(r.PathValue("ip")))
|
||||
return ip, err == nil && ip.IsGlobalUnicast() && !ip.IsPrivate() && !ip.IsLoopback()
|
||||
}
|
||||
|
||||
func writeJSON(w http.ResponseWriter, code int, v any) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("Cache-Control", "private, no-store")
|
||||
w.WriteHeader(code)
|
||||
json.NewEncoder(w).Encode(v)
|
||||
}
|
||||
|
||||
// Start (POST) queues an investigation and returns immediately; poll Get.
|
||||
func (h *Handler) Start(w http.ResponseWriter, r *http.Request) {
|
||||
ip, ok := parsePublicIP(r)
|
||||
if !ok {
|
||||
writeJSON(w, http.StatusBadRequest, errorBody{Error: "only public unicast IPs can be investigated"})
|
||||
return
|
||||
}
|
||||
var req struct {
|
||||
Mode string `json:"mode"`
|
||||
}
|
||||
if err := json.NewDecoder(io.LimitReader(r.Body, 256)).Decode(&req); err != nil {
|
||||
writeJSON(w, http.StatusBadRequest, errorBody{Error: "invalid investigation request"})
|
||||
return
|
||||
}
|
||||
if req.Mode != "passive" && req.Mode != "active" {
|
||||
writeJSON(w, http.StatusBadRequest, errorBody{Error: "mode must be passive or active"})
|
||||
return
|
||||
}
|
||||
if req.Mode == "active" && !h.cfg.NmapEnabled {
|
||||
writeJSON(w, http.StatusNotImplemented, errorBody{Error: "active investigation is disabled; set OTEL_IP_INVESTIGATION_NMAP=true"})
|
||||
return
|
||||
}
|
||||
key := ip.String() + "|" + req.Mode
|
||||
h.mu.Lock()
|
||||
if cur := h.jobs[key]; cur != nil && cur.Status == "running" {
|
||||
rec := *cur
|
||||
h.mu.Unlock()
|
||||
writeJSON(w, http.StatusAccepted, rec)
|
||||
return
|
||||
}
|
||||
if req.Mode == "active" && time.Since(h.lastScan) < 30*time.Second {
|
||||
h.mu.Unlock()
|
||||
writeJSON(w, http.StatusTooManyRequests, errorBody{Error: "active investigations are rate limited to one per 30s; retry shortly"})
|
||||
return
|
||||
}
|
||||
if req.Mode == "active" {
|
||||
h.lastScan = time.Now()
|
||||
}
|
||||
rec := &Record{IP: ip.String(), Mode: req.Mode, Status: "running", StartedAt: time.Now().UTC()}
|
||||
h.jobs[key] = rec
|
||||
snapshot := *rec
|
||||
h.mu.Unlock()
|
||||
|
||||
go h.run(key, ip, rec)
|
||||
writeJSON(w, http.StatusAccepted, snapshot)
|
||||
}
|
||||
|
||||
// Get returns the latest passive and active record for an address: running
|
||||
// jobs from memory, otherwise whatever was last stored.
|
||||
func (h *Handler) Get(w http.ResponseWriter, r *http.Request) {
|
||||
ip, ok := parsePublicIP(r)
|
||||
if !ok {
|
||||
writeJSON(w, http.StatusBadRequest, errorBody{Error: "only public unicast IPs can be investigated"})
|
||||
return
|
||||
}
|
||||
out := map[string]Record{}
|
||||
if h.store != nil {
|
||||
if recs, err := h.store.Load(r.Context(), ip.String()); err != nil {
|
||||
log.Printf("ip investigation: load %s: %v", ip, err)
|
||||
} else {
|
||||
for _, rec := range recs {
|
||||
out[rec.Mode] = rec
|
||||
}
|
||||
}
|
||||
}
|
||||
h.mu.Lock()
|
||||
for _, mode := range []string{"passive", "active"} {
|
||||
if cur := h.jobs[ip.String()+"|"+mode]; cur != nil {
|
||||
out[mode] = *cur
|
||||
}
|
||||
}
|
||||
h.mu.Unlock()
|
||||
writeJSON(w, http.StatusOK, map[string]any{"ip": ip.String(), "records": out})
|
||||
}
|
||||
|
||||
func (h *Handler) run(key string, ip netip.Addr, rec *Record) {
|
||||
timeout := 45 * time.Second
|
||||
if rec.Mode == "active" {
|
||||
timeout = h.cfg.NmapTimeout
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
||||
defer cancel()
|
||||
|
||||
var passive *PassiveResult
|
||||
var active *ActiveResult
|
||||
var err error
|
||||
if rec.Mode == "passive" {
|
||||
passive = h.passive(ctx, ip)
|
||||
} else {
|
||||
active, err = h.active(ctx, ip)
|
||||
}
|
||||
|
||||
now := time.Now().UTC()
|
||||
h.mu.Lock()
|
||||
rec.FinishedAt = &now
|
||||
rec.Passive, rec.Active = passive, active
|
||||
if err != nil {
|
||||
rec.Status, rec.Error = "failed", err.Error()
|
||||
if active != nil {
|
||||
rec.Debug = active.Debug
|
||||
}
|
||||
log.Printf("ip investigation: nmap %s: %v (debug=%+v)", ip, err, rec.Debug)
|
||||
} else {
|
||||
rec.Status = "done"
|
||||
}
|
||||
final := *rec
|
||||
h.mu.Unlock()
|
||||
|
||||
if h.store != nil {
|
||||
sctx, scancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||
defer scancel()
|
||||
if err := h.store.Save(sctx, final); err != nil {
|
||||
log.Printf("ip investigation: save %s/%s: %v", ip, final.Mode, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (h *Handler) passive(ctx context.Context, ip netip.Addr) *PassiveResult {
|
||||
result := &PassiveResult{IP: ip.String(), CompletedAt: time.Now().UTC().Format(time.RFC3339)}
|
||||
if names, err := net.DefaultResolver.LookupAddr(ctx, ip.String()); err == nil {
|
||||
for _, name := range names {
|
||||
result.Hostnames = append(result.Hostnames, strings.TrimSuffix(name, "."))
|
||||
}
|
||||
} else {
|
||||
result.Warnings = append(result.Warnings, "reverse DNS lookup returned no name")
|
||||
}
|
||||
if rdap, err := h.lookupRDAP(ctx, ip); err == nil {
|
||||
result.RDAP = rdap
|
||||
} else {
|
||||
result.Warnings = append(result.Warnings, "RDAP lookup unavailable")
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
// IANA's RDAP bootstrap format is an array of tuples, not an array of
|
||||
// objects: [ ["prefix", ...], ["https://rdap.example/", ...] ].
|
||||
type bootstrap struct {
|
||||
Services [][]json.RawMessage `json:"services"`
|
||||
}
|
||||
|
||||
func (b bootstrap) serviceFor(ip netip.Addr) (string, bool) {
|
||||
for _, service := range b.Services {
|
||||
if len(service) < 2 {
|
||||
continue
|
||||
}
|
||||
var prefixes, urls []string
|
||||
if json.Unmarshal(service[0], &prefixes) != nil || json.Unmarshal(service[1], &urls) != nil || len(urls) == 0 {
|
||||
continue
|
||||
}
|
||||
for _, prefix := range prefixes {
|
||||
p, err := netip.ParsePrefix(prefix)
|
||||
if err == nil && p.Contains(ip) {
|
||||
return urls[0], true
|
||||
}
|
||||
}
|
||||
}
|
||||
return "", false
|
||||
}
|
||||
|
||||
type rdapEntity struct {
|
||||
Roles []string `json:"roles"`
|
||||
VCard []any `json:"vcardArray"`
|
||||
Entities []rdapEntity `json:"entities"`
|
||||
}
|
||||
|
||||
type rdapResponse struct {
|
||||
Name string `json:"name"`
|
||||
Handle string `json:"handle"`
|
||||
Start string `json:"startAddress"`
|
||||
End string `json:"endAddress"`
|
||||
Country string `json:"country"`
|
||||
Entities []rdapEntity `json:"entities"`
|
||||
}
|
||||
|
||||
func (h *Handler) lookupRDAP(ctx context.Context, ip netip.Addr) (*RDAP, error) {
|
||||
bootstrapURL := "https://data.iana.org/rdap/ipv4.json"
|
||||
if ip.Is6() {
|
||||
bootstrapURL = "https://data.iana.org/rdap/ipv6.json"
|
||||
}
|
||||
var b bootstrap
|
||||
if err := h.getJSON(ctx, bootstrapURL, &b); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
serviceURL, ok := b.serviceFor(ip)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("no RDAP service for %s", ip)
|
||||
}
|
||||
var out rdapResponse
|
||||
if err := h.getJSON(ctx, strings.TrimRight(serviceURL, "/")+"/ip/"+ip.String(), &out); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
organization, abuseEmail := rdapContacts(out.Entities)
|
||||
return &RDAP{
|
||||
Name: out.Name, Handle: out.Handle, Start: out.Start, End: out.End,
|
||||
Country: out.Country, Registry: serviceURL, Organization: organization, AbuseEmail: abuseEmail,
|
||||
}, nil
|
||||
|
||||
}
|
||||
|
||||
func rdapContacts(entities []rdapEntity) (organization, abuseEmail string) {
|
||||
for _, entity := range entities {
|
||||
fn, email := vcardFields(entity.VCard)
|
||||
for _, role := range entity.Roles {
|
||||
switch role {
|
||||
case "registrant", "administrative", "technical":
|
||||
if organization == "" {
|
||||
organization = fn
|
||||
}
|
||||
case "abuse":
|
||||
if abuseEmail == "" {
|
||||
abuseEmail = email
|
||||
}
|
||||
}
|
||||
}
|
||||
if childOrg, childEmail := rdapContacts(entity.Entities); organization == "" {
|
||||
organization = childOrg
|
||||
if abuseEmail == "" {
|
||||
abuseEmail = childEmail
|
||||
}
|
||||
} else if abuseEmail == "" {
|
||||
_, abuseEmail = rdapContacts(entity.Entities)
|
||||
}
|
||||
}
|
||||
return organization, abuseEmail
|
||||
}
|
||||
|
||||
func (h *Handler) getJSON(ctx context.Context, url string, dst any) error {
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.Header.Set("Accept", "application/rdap+json, application/json")
|
||||
resp, err := h.client.Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode/100 != 2 {
|
||||
return fmt.Errorf("HTTP %s", resp.Status)
|
||||
}
|
||||
return json.NewDecoder(io.LimitReader(resp.Body, 1<<20)).Decode(dst)
|
||||
}
|
||||
|
||||
// vcardFields extracts fn and email from a jCard ["vcard", [[name, params, type, value], ...]].
|
||||
func vcardFields(card []any) (fn, email string) {
|
||||
if len(card) < 2 {
|
||||
return
|
||||
}
|
||||
props, _ := card[1].([]any)
|
||||
for _, p := range props {
|
||||
prop, _ := p.([]any)
|
||||
if len(prop) < 4 {
|
||||
continue
|
||||
}
|
||||
name, _ := prop[0].(string)
|
||||
val, _ := prop[3].(string)
|
||||
switch name {
|
||||
case "fn":
|
||||
fn = val
|
||||
case "email":
|
||||
if email == "" {
|
||||
email = val
|
||||
}
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
type nmapXML struct {
|
||||
Hosts []struct {
|
||||
Status struct {
|
||||
State string `xml:"state,attr"`
|
||||
Reason string `xml:"reason,attr"`
|
||||
} `xml:"status"`
|
||||
Ports struct {
|
||||
ExtraPorts []struct {
|
||||
State string `xml:"state,attr"`
|
||||
Count int `xml:"count,attr"`
|
||||
} `xml:"extraports"`
|
||||
Ports []struct {
|
||||
Protocol string `xml:"protocol,attr"`
|
||||
Port uint16 `xml:"portid,attr"`
|
||||
State struct {
|
||||
Value string `xml:"state,attr"`
|
||||
} `xml:"state"`
|
||||
Service struct {
|
||||
Name string `xml:"name,attr"`
|
||||
Product string `xml:"product,attr"`
|
||||
Version string `xml:"version,attr"`
|
||||
} `xml:"service"`
|
||||
Scripts []struct {
|
||||
ID string `xml:"id,attr"`
|
||||
Output string `xml:"output,attr"`
|
||||
} `xml:"script"`
|
||||
} `xml:"port"`
|
||||
} `xml:"ports"`
|
||||
} `xml:"host"`
|
||||
Finished struct {
|
||||
Summary string `xml:"summary,attr"`
|
||||
} `xml:"runstats>finished"`
|
||||
}
|
||||
|
||||
func (h *Handler) active(ctx context.Context, ip netip.Addr) (*ActiveResult, error) {
|
||||
// --host-timeout makes nmap stop itself and emit valid XML with whatever it
|
||||
// found; the context deadline is only a backstop and stays well above it.
|
||||
hostTimeout := fmt.Sprintf("%ds", int((h.cfg.NmapTimeout - 15*time.Second).Seconds()))
|
||||
args := []string{"-Pn", "-n", "-T4", "--max-retries", "1", "--host-timeout", hostTimeout, "--version-light", "-sV",
|
||||
"--script", "ssl-cert,http-title", "--top-ports", "100", "--open", "-oX", "-", ip.String()}
|
||||
result := &ActiveResult{IP: ip.String(), Debug: &Debug{Command: h.cfg.NmapBinary + " " + strings.Join(args, " ")}}
|
||||
start := time.Now()
|
||||
cmd := exec.CommandContext(ctx, h.cfg.NmapBinary, args...)
|
||||
var stdout, stderr bytes.Buffer
|
||||
cmd.Stdout, cmd.Stderr = &stdout, &stderr
|
||||
err := cmd.Run()
|
||||
result.Debug.DurationMs = time.Since(start).Milliseconds()
|
||||
result.Debug.Stderr = truncate(strings.TrimSpace(stderr.String()), 2000)
|
||||
result.CompletedAt = time.Now().UTC().Format(time.RFC3339)
|
||||
if err != nil {
|
||||
result.Debug.ExitError = err.Error()
|
||||
result.Debug.TimedOut = ctx.Err() != nil
|
||||
if result.Debug.TimedOut {
|
||||
return result, fmt.Errorf("nmap exceeded the %s scan deadline and was killed", h.cfg.NmapTimeout)
|
||||
}
|
||||
return result, fmt.Errorf("nmap failed: %w", err)
|
||||
}
|
||||
var parsed nmapXML
|
||||
if err := xml.Unmarshal(stdout.Bytes(), &parsed); err != nil {
|
||||
result.Debug.ExitError = "unparseable nmap XML: " + err.Error()
|
||||
return result, fmt.Errorf("could not parse nmap output: %w", err)
|
||||
}
|
||||
result.Debug.Summary = parsed.Finished.Summary
|
||||
for _, host := range parsed.Hosts {
|
||||
result.Debug.HostState = host.Status.State
|
||||
if host.Status.Reason != "" {
|
||||
result.Debug.HostState += " (" + host.Status.Reason + ")"
|
||||
}
|
||||
for _, x := range host.Ports.ExtraPorts {
|
||||
result.Debug.Summary += fmt.Sprintf("; %d ports %s", x.Count, x.State)
|
||||
}
|
||||
for _, p := range host.Ports.Ports {
|
||||
svc := Service{Port: p.Port, Protocol: p.Protocol, State: p.State.Value, Name: p.Service.Name, Product: p.Service.Product, Version: p.Service.Version}
|
||||
for _, sc := range p.Scripts {
|
||||
if svc.Scripts == nil {
|
||||
svc.Scripts = map[string]string{}
|
||||
}
|
||||
svc.Scripts[sc.ID] = truncate(sc.Output, 600)
|
||||
}
|
||||
result.Services = append(result.Services, svc)
|
||||
}
|
||||
}
|
||||
if strings.Contains(result.Debug.Summary, "timed out") || len(parsed.Hosts) == 0 {
|
||||
result.Debug.Partial = true
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func truncate(s string, n int) string {
|
||||
if len(s) <= n {
|
||||
return s
|
||||
}
|
||||
return s[:n] + "…"
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
package investigation
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/netip"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestBootstrapServiceFor(t *testing.T) {
|
||||
var b bootstrap
|
||||
err := json.Unmarshal([]byte(`{
|
||||
"services": [
|
||||
[["8.0.0.0/8"], ["https://rdap.example.test/"]],
|
||||
[["2001:db8::/32"], ["https://rdap6.example.test/"]]
|
||||
]
|
||||
}`), &b)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if got, ok := b.serviceFor(netip.MustParseAddr("8.8.8.8")); !ok || got != "https://rdap.example.test/" {
|
||||
t.Fatalf("IPv4 service = %q, %v", got, ok)
|
||||
}
|
||||
if got, ok := b.serviceFor(netip.MustParseAddr("2001:db8::1")); !ok || got != "https://rdap6.example.test/" {
|
||||
t.Fatalf("IPv6 service = %q, %v", got, ok)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRdapContacts(t *testing.T) {
|
||||
entities := []rdapEntity{
|
||||
{Roles: []string{"registrant"}, VCard: []any{"vcard", []any{[]any{"fn", map[string]any{}, "text", "Example Org"}}}},
|
||||
{Roles: []string{"abuse"}, VCard: []any{"vcard", []any{[]any{"email", map[string]any{}, "text", "abuse@example.test"}}}},
|
||||
}
|
||||
org, email := rdapContacts(entities)
|
||||
if org != "Example Org" || email != "abuse@example.test" {
|
||||
t.Fatalf("contacts = %q, %q", org, email)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
package investigation
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/ClickHouse/clickhouse-go/v2/lib/driver"
|
||||
)
|
||||
|
||||
// ClickHouseStore keeps the latest finished record per (ip, mode) as JSON.
|
||||
// No TTL: what an address turned out to be is worth keeping.
|
||||
type ClickHouseStore struct {
|
||||
conn driver.Conn
|
||||
db string
|
||||
}
|
||||
|
||||
func NewClickHouseStore(ctx context.Context, conn driver.Conn, db string) (*ClickHouseStore, error) {
|
||||
err := conn.Exec(ctx, fmt.Sprintf(`CREATE TABLE IF NOT EXISTS %s.ip_investigations (
|
||||
ip String,
|
||||
mode LowCardinality(String),
|
||||
status LowCardinality(String),
|
||||
started_at DateTime64(3, 'UTC'),
|
||||
finished_at DateTime64(3, 'UTC'),
|
||||
record String
|
||||
) ENGINE = ReplacingMergeTree(finished_at)
|
||||
ORDER BY (ip, mode)`, db))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &ClickHouseStore{conn: conn, db: db}, nil
|
||||
}
|
||||
|
||||
func (s *ClickHouseStore) Save(ctx context.Context, rec Record) error {
|
||||
body, err := json.Marshal(rec)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
finished := time.Now().UTC()
|
||||
if rec.FinishedAt != nil {
|
||||
finished = *rec.FinishedAt
|
||||
}
|
||||
return s.conn.Exec(ctx, fmt.Sprintf(`INSERT INTO %s.ip_investigations (ip, mode, status, started_at, finished_at, record) VALUES (?, ?, ?, ?, ?, ?)`, s.db),
|
||||
rec.IP, rec.Mode, rec.Status, rec.StartedAt.UTC(), finished, string(body))
|
||||
}
|
||||
|
||||
func (s *ClickHouseStore) Load(ctx context.Context, ip string) ([]Record, error) {
|
||||
rows, err := s.conn.Query(ctx, fmt.Sprintf(`SELECT record FROM %s.ip_investigations FINAL WHERE ip = ?`, s.db), ip)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
var out []Record
|
||||
for rows.Next() {
|
||||
var body string
|
||||
if err := rows.Scan(&body); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var rec Record
|
||||
if err := json.Unmarshal([]byte(body), &rec); err == nil {
|
||||
out = append(out, rec)
|
||||
}
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package sourcemaps
|
||||
|
||||
import (
|
||||
"container/list"
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
"io"
|
||||
@@ -17,10 +18,30 @@ import (
|
||||
|
||||
var frameRE = regexp.MustCompile(`(.*?)(https?://[^ )]+|[^ )]+):(\d+):(\d+)(\)?\s*)$`)
|
||||
|
||||
// defaultCacheBytes bounds the on-disk size of the maps kept parsed in memory.
|
||||
// A parsed map costs several times its file size, so this is a heap budget of
|
||||
// roughly 4-5x. Override with OTEL_SOURCEMAP_CACHE_MB.
|
||||
const defaultCacheBytes = 64 << 20
|
||||
|
||||
// Resolver indexes uploaded maps by file name at startup and parses them lazily
|
||||
// on first use, keeping the most recently used ones within a size budget. A
|
||||
// release ships hundreds of chunks, so parsing them all up front does not fit
|
||||
// in memory.
|
||||
type Resolver struct {
|
||||
dir string
|
||||
mu sync.RWMutex
|
||||
maps map[string]*sm.Consumer
|
||||
dir string
|
||||
|
||||
mu sync.Mutex
|
||||
index map[string]string // key(release, source) -> file name
|
||||
cache map[string]*list.Element
|
||||
lru *list.List // front = most recently used; values are *cacheEntry
|
||||
cacheBytes int64
|
||||
maxBytes int64
|
||||
}
|
||||
|
||||
type cacheEntry struct {
|
||||
key string
|
||||
consumer *sm.Consumer
|
||||
size int64
|
||||
}
|
||||
|
||||
func New(dir string) (*Resolver, error) {
|
||||
@@ -30,8 +51,18 @@ func New(dir string) (*Resolver, error) {
|
||||
if err := os.MkdirAll(dir, 0750); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
r := &Resolver{dir: dir, maps: make(map[string]*sm.Consumer)}
|
||||
r.load()
|
||||
maxBytes := int64(defaultCacheBytes)
|
||||
if mb, err := strconv.Atoi(os.Getenv("OTEL_SOURCEMAP_CACHE_MB")); err == nil && mb > 0 {
|
||||
maxBytes = int64(mb) << 20
|
||||
}
|
||||
r := &Resolver{
|
||||
dir: dir,
|
||||
index: make(map[string]string),
|
||||
cache: make(map[string]*list.Element),
|
||||
lru: list.New(),
|
||||
maxBytes: maxBytes,
|
||||
}
|
||||
r.scan()
|
||||
return r, nil
|
||||
}
|
||||
|
||||
@@ -55,8 +86,9 @@ func parseFileName(name string) (release, source string, ok bool) {
|
||||
return string(rel), string(src), true
|
||||
}
|
||||
|
||||
// load restores previously uploaded maps; unreadable or legacy-named files are skipped.
|
||||
func (r *Resolver) load() {
|
||||
// scan indexes previously uploaded maps by file name without reading them;
|
||||
// legacy-named files are skipped.
|
||||
func (r *Resolver) scan() {
|
||||
entries, err := os.ReadDir(r.dir)
|
||||
if err != nil {
|
||||
return
|
||||
@@ -66,15 +98,51 @@ func (r *Resolver) load() {
|
||||
if !ok || e.IsDir() {
|
||||
continue
|
||||
}
|
||||
b, err := os.ReadFile(filepath.Join(r.dir, e.Name()))
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
consumer, err := sm.Parse(source+".map", b)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
r.maps[key(release, source)] = consumer
|
||||
r.index[key(release, source)] = e.Name()
|
||||
}
|
||||
}
|
||||
|
||||
// get returns the parsed map for k, loading it from disk on a cache miss. It
|
||||
// returns nil when no map is indexed or the file is unreadable.
|
||||
func (r *Resolver) get(k string) *sm.Consumer {
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
if el, ok := r.cache[k]; ok {
|
||||
r.lru.MoveToFront(el)
|
||||
return el.Value.(*cacheEntry).consumer
|
||||
}
|
||||
name, ok := r.index[k]
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
b, err := os.ReadFile(filepath.Join(r.dir, name))
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
_, source, _ := parseFileName(name)
|
||||
consumer, err := sm.Parse(source+".map", b)
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
r.put(k, consumer, int64(len(b)))
|
||||
return consumer
|
||||
}
|
||||
|
||||
// put caches a parsed map and evicts least recently used ones over budget,
|
||||
// always keeping the newest entry. Callers hold r.mu.
|
||||
func (r *Resolver) put(k string, consumer *sm.Consumer, size int64) {
|
||||
if el, ok := r.cache[k]; ok {
|
||||
r.cacheBytes -= el.Value.(*cacheEntry).size
|
||||
r.lru.Remove(el)
|
||||
}
|
||||
r.cache[k] = r.lru.PushFront(&cacheEntry{key: k, consumer: consumer, size: size})
|
||||
r.cacheBytes += size
|
||||
for r.cacheBytes > r.maxBytes && r.lru.Len() > 1 {
|
||||
last := r.lru.Back()
|
||||
e := last.Value.(*cacheEntry)
|
||||
r.lru.Remove(last)
|
||||
delete(r.cache, e.key)
|
||||
r.cacheBytes -= e.size
|
||||
}
|
||||
}
|
||||
|
||||
@@ -86,10 +154,10 @@ type Entry struct {
|
||||
|
||||
// List returns every loaded map, sorted by release then source.
|
||||
func (r *Resolver) List() []Entry {
|
||||
r.mu.RLock()
|
||||
defer r.mu.RUnlock()
|
||||
out := make([]Entry, 0, len(r.maps))
|
||||
for k := range r.maps {
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
out := make([]Entry, 0, len(r.index))
|
||||
for k := range r.index {
|
||||
release, source, _ := strings.Cut(k, "\x00")
|
||||
out = append(out, Entry{Release: release, Source: source})
|
||||
}
|
||||
@@ -128,8 +196,10 @@ func (r *Resolver) Upload(release, source string, body io.Reader) error {
|
||||
if err := os.WriteFile(name, b, 0600); err != nil {
|
||||
return err
|
||||
}
|
||||
k := key(release, source)
|
||||
r.mu.Lock()
|
||||
r.maps[key(release, source)] = consumer
|
||||
r.index[k] = fileName(release, source)
|
||||
r.put(k, consumer, int64(len(b)))
|
||||
r.mu.Unlock()
|
||||
return nil
|
||||
}
|
||||
@@ -149,8 +219,6 @@ func (r *Resolver) ResolveStack(release, stack string) string {
|
||||
if release == "" || stack == "" {
|
||||
return stack
|
||||
}
|
||||
r.mu.RLock()
|
||||
defer r.mu.RUnlock()
|
||||
lines := strings.Split(stack, "\n")
|
||||
for i, line := range lines {
|
||||
m := frameRE.FindStringSubmatch(line)
|
||||
@@ -159,7 +227,7 @@ func (r *Resolver) ResolveStack(release, stack string) string {
|
||||
}
|
||||
genLine, _ := strconv.Atoi(m[3])
|
||||
genCol, _ := strconv.Atoi(m[4])
|
||||
consumer := r.maps[key(release, m[2])]
|
||||
consumer := r.get(key(release, m[2]))
|
||||
if consumer == nil {
|
||||
continue
|
||||
}
|
||||
@@ -202,8 +270,6 @@ const frameContext = 6
|
||||
// uploaded source maps, including surrounding original source when the map
|
||||
// embeds sourcesContent.
|
||||
func (r *Resolver) ResolveFrames(release, stack string) []Frame {
|
||||
r.mu.RLock()
|
||||
defer r.mu.RUnlock()
|
||||
var frames []Frame
|
||||
for _, line := range strings.Split(stack, "\n") {
|
||||
m := frameRE.FindStringSubmatch(line)
|
||||
@@ -214,7 +280,7 @@ func (r *Resolver) ResolveFrames(release, stack string) []Frame {
|
||||
col, _ := strconv.Atoi(m[4])
|
||||
fn := strings.TrimSpace(strings.TrimSuffix(strings.TrimPrefix(strings.TrimSpace(m[1]), "at "), "("))
|
||||
f := Frame{Raw: strings.TrimSpace(line), Function: fn, File: m[2], Line: ln, Column: col, Status: "mapped"}
|
||||
switch consumer := r.maps[key(release, m[2])]; {
|
||||
switch consumer := r.get(key(release, m[2])); {
|
||||
case release == "":
|
||||
f.Status = "no-release"
|
||||
case consumer == nil:
|
||||
|
||||
@@ -22,3 +22,29 @@ func TestReloadFromDisk(t *testing.T) {
|
||||
t.Fatalf("frames = %+v", frames)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLazyLoadAndEviction(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
r, _ := New(dir)
|
||||
for _, f := range []string{"a", "b", "c"} {
|
||||
if err := r.Upload("rel", "/assets/"+f+".js", strings.NewReader(testMap)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
r2, _ := New(dir)
|
||||
if len(r2.cache) != 0 || len(r2.List()) != 3 {
|
||||
t.Fatalf("startup should index without parsing: cached=%d listed=%d", len(r2.cache), len(r2.List()))
|
||||
}
|
||||
r2.maxBytes = int64(len(testMap)) * 2 // room for two parsed maps
|
||||
for _, f := range []string{"a", "b", "c"} {
|
||||
if fr := r2.ResolveFrames("rel", "at f (https://h/assets/"+f+".js:2:1)"); len(fr) != 1 || fr[0].Status != "mapped" {
|
||||
t.Fatalf("%s not resolved: %+v", f, fr)
|
||||
}
|
||||
}
|
||||
if len(r2.cache) != 2 {
|
||||
t.Fatalf("cache should hold 2 entries, has %d", len(r2.cache))
|
||||
}
|
||||
if r2.get(key("rel", "/assets/a.js")) == nil { // evicted, reloads from disk
|
||||
t.Fatal("evicted map did not reload")
|
||||
}
|
||||
}
|
||||
@@ -156,6 +156,9 @@ func (s *ClickHouseStore) initSchema(ctx context.Context) error {
|
||||
if err := EnsureNormalizedSchema(ctx, s.conn, s.db); err != nil {
|
||||
return fmt.Errorf("normalized schema: %w", err)
|
||||
}
|
||||
if err := EnsureSourceIPSchema(ctx, s.conn, s.db); err != nil {
|
||||
return fmt.Errorf("source ip schema: %w", err)
|
||||
}
|
||||
if err := s.conn.Exec(ctx, fmt.Sprintf(`CREATE TABLE IF NOT EXISTS %s.entries (
|
||||
timestamp DateTime64(9, 'UTC') NOT NULL,
|
||||
type LowCardinality(String) NOT NULL,
|
||||
|
||||
@@ -334,3 +334,49 @@ func (s *ClickHouseStore) IssueTraces(ctx context.Context, issueID string, opts
|
||||
}
|
||||
return page, nil
|
||||
}
|
||||
|
||||
// IssueSources returns every distinct source IP recorded for an issue. Source
|
||||
// addresses may be in the derived occurrence sample, or on any normalized span
|
||||
// belonging to one of the issue's traces (for example, an ingress span's
|
||||
// net.peer.ip when the failing child span has no client attributes).
|
||||
func (s *ClickHouseStore) IssueSources(ctx context.Context, issueID string) ([]IssueSource, error) {
|
||||
rows, err := s.conn.Query(ctx, fmt.Sprintf(`
|
||||
SELECT ip, min(seen_at), max(seen_at), count()
|
||||
FROM (
|
||||
-- Logs and older occurrences keep their source address in the
|
||||
-- derived sample. Keep this path for data that has no trace.
|
||||
SELECT JSONExtractString(sample, 'sourceIp') AS ip, timestamp AS seen_at
|
||||
FROM %s.issue_occurrences
|
||||
WHERE issue_id = ? AND ip != ''
|
||||
|
||||
UNION ALL
|
||||
|
||||
-- A span error's sample describes the failing span, but the public
|
||||
-- peer is commonly recorded on the ingress span in the same trace.
|
||||
-- Include every normalized span peer for the issue's traces.
|
||||
SELECT peer_ip AS ip, timestamp AS seen_at
|
||||
FROM %s.normalized_events
|
||||
WHERE peer_ip != ''
|
||||
AND trace_id IN (
|
||||
SELECT DISTINCT trace_id
|
||||
FROM %s.issue_occurrences
|
||||
WHERE issue_id = ? AND trace_id != ''
|
||||
)
|
||||
)
|
||||
WHERE ip != ''
|
||||
GROUP BY ip
|
||||
ORDER BY count() DESC, max(seen_at) DESC`, s.db, s.db, s.db), issueID, issueID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("clickhouse issue sources: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
var out []IssueSource
|
||||
for rows.Next() {
|
||||
var source IssueSource
|
||||
if err := rows.Scan(&source.IP, &source.FirstSeen, &source.LastSeen, &source.Count); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out = append(out, source)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
@@ -0,0 +1,198 @@
|
||||
package storage
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/ClickHouse/clickhouse-go/v2/lib/driver"
|
||||
|
||||
"git.tornberg.me/go-otel/internal/honeypot"
|
||||
"git.tornberg.me/go-otel/internal/uaclass"
|
||||
)
|
||||
|
||||
// SourceIP is one unique client address ever seen on ingest, with lifetime
|
||||
// totals. The address is the edge peer when the trace has one (the real
|
||||
// client behind ingress), otherwise the span's own peer.
|
||||
type SourceIP struct {
|
||||
IP string `json:"ip"`
|
||||
FirstSeen time.Time `json:"firstSeen"`
|
||||
LastSeen time.Time `json:"lastSeen"`
|
||||
Requests uint64 `json:"requests"`
|
||||
Errors uint64 `json:"errors"`
|
||||
Services []string `json:"services"`
|
||||
UserAgent string `json:"userAgent,omitempty"`
|
||||
UAClass string `json:"uaClass,omitempty"`
|
||||
// Public is false for loopback/private/reserved addresses, which are
|
||||
// usually a proxy hop rather than a real client.
|
||||
Public bool `json:"public"`
|
||||
// BadActor is the features.MarkBadActors rule the recent requests match
|
||||
// ("" if none); ProbePaths counts the distinct probe paths they hit. Set by
|
||||
// the caller from SourceIPRoutes, not by SourceIPs.
|
||||
BadActor string `json:"badActor,omitempty"`
|
||||
ProbePaths int `json:"probePaths,omitempty"`
|
||||
}
|
||||
|
||||
// SourceIPEvent is one request attributed to a source address.
|
||||
type SourceIPEvent struct {
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
Service string `json:"service"`
|
||||
Method string `json:"method,omitempty"`
|
||||
Host string `json:"host,omitempty"`
|
||||
Route string `json:"route,omitempty"`
|
||||
SpanName string `json:"spanName,omitempty"`
|
||||
StatusCode uint16 `json:"statusCode"`
|
||||
IsError bool `json:"isError"`
|
||||
TraceID string `json:"traceId"`
|
||||
SpanID string `json:"spanId"`
|
||||
UserAgent string `json:"userAgent,omitempty"`
|
||||
}
|
||||
|
||||
// SourceIPQuerier is implemented by stores that keep the global source
|
||||
// address list (ClickHouseStore).
|
||||
type SourceIPQuerier interface {
|
||||
// SourceIPs lists unique addresses, most recently seen first. search is
|
||||
// a substring match on the address; since (zero = all time) drops
|
||||
// addresses last seen earlier.
|
||||
SourceIPs(ctx context.Context, search string, since time.Time, limit int) ([]SourceIP, error)
|
||||
// SourceIPActivity lists the requests attributed to one address, newest first.
|
||||
SourceIPActivity(ctx context.Context, ip string, since time.Time, limit int) ([]SourceIPEvent, error)
|
||||
// SourceIPRoutes returns, per address, the distinct (route, status, user
|
||||
// agent) combinations requested since the given time - enough to judge
|
||||
// scanning behaviour for many addresses in one query.
|
||||
SourceIPRoutes(ctx context.Context, ips []string, since time.Time) (map[string][]SourceIPEvent, error)
|
||||
}
|
||||
|
||||
// sourceIPClient is the client-address expression shared by the rollup and
|
||||
// the activity query, so both agree on who a request "came from".
|
||||
const sourceIPClient = "if(edge_peer_ip != '', edge_peer_ip, peer_ip)"
|
||||
|
||||
// sourceIPRequest keeps one row per request: a request produces several
|
||||
// spans (ingress, upstream, ...) that all carry the same edge peer, so only
|
||||
// the edge span itself is counted.
|
||||
const sourceIPRequest = "kind = 'span' AND ip != '' AND (edge_peer_ip = '' OR span_id = edge_span_id)"
|
||||
|
||||
const sourceIPSelect = `SELECT %s AS ip, min(timestamp) AS first_seen, max(timestamp) AS last_seen,
|
||||
count() AS requests, sum(is_error) AS errors, groupUniqArray(service) AS services,
|
||||
anyLast(user_agent) AS user_agent, anyLast(ua_class) AS ua_class
|
||||
FROM %s.normalized_events WHERE %s GROUP BY ip`
|
||||
|
||||
// EnsureSourceIPSchema creates the lifetime source_ips table and the
|
||||
// materialized view feeding it from normalized_events. Unlike
|
||||
// normalized_events it has no TTL: the list is meant to outlive raw data.
|
||||
// An empty table is backfilled once from whatever normalized_events holds.
|
||||
// Idempotent.
|
||||
func EnsureSourceIPSchema(ctx context.Context, conn driver.Conn, db string) error {
|
||||
if err := conn.Exec(ctx, fmt.Sprintf(`CREATE TABLE IF NOT EXISTS %s.source_ips (
|
||||
ip String,
|
||||
first_seen SimpleAggregateFunction(min, DateTime64(9, 'UTC')),
|
||||
last_seen SimpleAggregateFunction(max, DateTime64(9, 'UTC')),
|
||||
requests SimpleAggregateFunction(sum, UInt64),
|
||||
errors SimpleAggregateFunction(sum, UInt64),
|
||||
services SimpleAggregateFunction(groupUniqArrayArray, Array(String)),
|
||||
user_agent SimpleAggregateFunction(anyLast, String),
|
||||
ua_class SimpleAggregateFunction(anyLast, String)
|
||||
) ENGINE = AggregatingMergeTree
|
||||
ORDER BY ip`, db)); err != nil {
|
||||
return err
|
||||
}
|
||||
sel := fmt.Sprintf(sourceIPSelect, sourceIPClient, db, sourceIPRequest)
|
||||
|
||||
var existing uint64
|
||||
if err := conn.QueryRow(ctx, fmt.Sprintf("SELECT count() FROM %s.source_ips", db)).Scan(&existing); err != nil {
|
||||
return err
|
||||
}
|
||||
if existing == 0 {
|
||||
if err := conn.Exec(ctx, fmt.Sprintf("INSERT INTO %s.source_ips %s", db, sel)); err != nil {
|
||||
return fmt.Errorf("backfill: %w", err)
|
||||
}
|
||||
}
|
||||
return conn.Exec(ctx, fmt.Sprintf("CREATE MATERIALIZED VIEW IF NOT EXISTS %s.source_ips_mv TO %s.source_ips AS %s", db, db, sel))
|
||||
}
|
||||
|
||||
func (s *ClickHouseStore) SourceIPs(ctx context.Context, search string, since time.Time, limit int) ([]SourceIP, error) {
|
||||
if limit <= 0 || limit > 1000 {
|
||||
limit = 200
|
||||
}
|
||||
where, args := "1", []interface{}{}
|
||||
if search != "" {
|
||||
where += " AND position(ip, ?) > 0"
|
||||
args = append(args, search)
|
||||
}
|
||||
having := ""
|
||||
if !since.IsZero() {
|
||||
having = "HAVING last_seen >= ?"
|
||||
args = append(args, since.UTC())
|
||||
}
|
||||
args = append(args, limit)
|
||||
rows, err := s.conn.Query(ctx, fmt.Sprintf(`SELECT ip, min(first_seen), max(last_seen) AS last_seen, sum(requests), sum(errors),
|
||||
groupUniqArrayArray(services), anyLast(user_agent), anyLast(ua_class)
|
||||
FROM %s.source_ips WHERE %s GROUP BY ip %s ORDER BY last_seen DESC LIMIT ?`, s.db, where, having), args...)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("clickhouse source ips: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []SourceIP{}
|
||||
for rows.Next() {
|
||||
var v SourceIP
|
||||
if err := rows.Scan(&v.IP, &v.FirstSeen, &v.LastSeen, &v.Requests, &v.Errors, &v.Services, &v.UserAgent, &v.UAClass); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if v.UAClass == "" && v.UserAgent != "" {
|
||||
v.UAClass = uaclass.Of(v.UserAgent)
|
||||
}
|
||||
v.Public = !honeypot.Untrackable(v.IP)
|
||||
out = append(out, v)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
func (s *ClickHouseStore) SourceIPActivity(ctx context.Context, ip string, since time.Time, limit int) ([]SourceIPEvent, error) {
|
||||
if limit <= 0 || limit > 1000 {
|
||||
limit = 200
|
||||
}
|
||||
if since.IsZero() {
|
||||
since = time.Now().Add(-7 * 24 * time.Hour)
|
||||
}
|
||||
rows, err := s.conn.Query(ctx, fmt.Sprintf(`SELECT timestamp, service, method, host, route, span_name, status_code, is_error, trace_id, span_id, user_agent
|
||||
FROM (SELECT *, %s AS ip FROM %s.normalized_events WHERE timestamp >= ?)
|
||||
WHERE %s AND ip = ? ORDER BY timestamp DESC LIMIT ?`, sourceIPClient, s.db, sourceIPRequest), since.UTC(), ip, limit)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("clickhouse source ip activity: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
out := []SourceIPEvent{}
|
||||
for rows.Next() {
|
||||
var v SourceIPEvent
|
||||
var isErr uint8
|
||||
if err := rows.Scan(&v.Timestamp, &v.Service, &v.Method, &v.Host, &v.Route, &v.SpanName, &v.StatusCode, &isErr, &v.TraceID, &v.SpanID, &v.UserAgent); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
v.IsError = isErr != 0
|
||||
out = append(out, v)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
|
||||
func (s *ClickHouseStore) SourceIPRoutes(ctx context.Context, ips []string, since time.Time) (map[string][]SourceIPEvent, error) {
|
||||
out := map[string][]SourceIPEvent{}
|
||||
if len(ips) == 0 {
|
||||
return out, nil
|
||||
}
|
||||
rows, err := s.conn.Query(ctx, fmt.Sprintf(`SELECT ip, route, status_code, anyLast(user_agent)
|
||||
FROM (SELECT *, %s AS ip FROM %s.normalized_events WHERE timestamp >= ? AND kind = 'span')
|
||||
WHERE %s AND ip IN ? GROUP BY ip, route, status_code`, sourceIPClient, s.db, sourceIPRequest), since.UTC(), ips)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("clickhouse source ip routes: %w", err)
|
||||
}
|
||||
defer rows.Close()
|
||||
for rows.Next() {
|
||||
var ip string
|
||||
var v SourceIPEvent
|
||||
if err := rows.Scan(&ip, &v.Route, &v.StatusCode, &v.UserAgent); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out[ip] = append(out[ip], v)
|
||||
}
|
||||
return out, rows.Err()
|
||||
}
|
||||
@@ -135,4 +135,16 @@ type IssueTracesPage struct {
|
||||
type OccurrenceStore interface {
|
||||
AppendOccurrence(ctx context.Context, occ Occurrence) error
|
||||
IssueTraces(ctx context.Context, issueID string, opts IssueTracesOptions) (IssueTracesPage, error)
|
||||
IssueSources(ctx context.Context, issueID string) ([]IssueSource, error)
|
||||
}
|
||||
|
||||
// IssueSource is one source address observed for an issue across all persisted
|
||||
// occurrences. It is deliberately an aggregate: the issue detail already
|
||||
// has the recent occurrence samples, while this answers "which sources ever
|
||||
// produced this issue?" without returning every raw occurrence.
|
||||
type IssueSource struct {
|
||||
IP string `json:"ip"`
|
||||
FirstSeen time.Time `json:"firstSeen"`
|
||||
LastSeen time.Time `json:"lastSeen"`
|
||||
Count uint64 `json:"count"`
|
||||
}
|
||||
Reference in new issue
Block a user