Skip to content

Release Notes: v0.1.0

Release Date: 2026-05-17

Highlights

  • Initial Release: Canonical data model for operational intelligence
  • Core Types: Signal, RootCause, Remediation, ValidationSignal
  • JSON Schema: Auto-generated schemas from Go types with enum constraints
  • XLSX Reports: Domain summary and root cause detail sheets
  • CLI Tool: Validation, schema generation, and report commands

Core Types

Signal

Atomic operational observations from external systems. Signals are the input layer - raw events normalized from various sources.

import "github.com/plexusone/signal-spec/pkg/signal"

sig := signal.Signal{
    ID:       "sig-2024-001234",
    Type:     signal.TypeSupportTicket,
    Status:   signal.StatusNew,
    Severity: common.SeverityHigh,
    Summary:  "OAuth refresh token failures",
    // ...
}

Signal Types:

  • support_ticket - Customer support tickets
  • cloud_incident - Cloud provider incidents
  • security_finding - Security scan findings
  • posture_drift - Configuration drift
  • alert - Monitoring alerts
  • outage - Service outages
  • vulnerability - Vulnerability scans
  • feedback - Customer feedback

RootCause

Persistent clustered operational issues with lifecycle tracking.

import "github.com/plexusone/signal-spec/pkg/rootcause"

rc := rootcause.RootCause{
    ID:     "rc-auth-001",
    Title:  "Redis session replication instability",
    Status: rootcause.StatusActive,
    // ...
}

Lifecycle States:

NEW → ACTIVE → MITIGATING → VALIDATING → STABLE → RESOLVED
                              ↓
                          REGRESSED

Remediation & ValidationSignal

Track corrective actions and measure efficacy.

import "github.com/plexusone/signal-spec/pkg/remediation"

rem := remediation.Remediation{
    ID:           "rem-001",
    Title:        "Implement Redis read-after-write consistency",
    Status:       remediation.StatusDeployed,
    RootCauseIDs: []string{"rc-auth-001"},
    // ...
}

Common Types

Shared types used across all entities:

Type Description
Severity Impact level: critical, high, medium, low, info
Domain Category/subcategory classification
Entity System components (services, endpoints, etc.)
SourceSystem Signal origin (ticketing, alerting, security)
Tag User-defined labels (kebab-case validated)

CLI Commands

Validate

signal-spec validate -t signal signal.json
signal-spec validate -t rootcause rootcause.json
signal-spec validate -t remediation remediation.json

Generate Schemas

signal-spec schema generate -o ./schemas/

Generate Reports

signal-spec report -i rootcauses.json -o summary.xlsx
signal-spec report -d ./rootcauses/ --leaders leaders.json -o summary.xlsx

XLSX Report

Generated reports include two sheets:

Domain Summary:

  • Domain/Subdomain aggregation
  • Issue count and total signals
  • Average priority score
  • Maximum severity
  • Area and execution leader assignments

Root Causes:

  • Full root cause listing
  • Status, severity, signal count
  • First/last seen dates
  • Owner team and tags

Installation

go get github.com/plexusone/signal-spec@v0.1.0

Install CLI:

go install github.com/plexusone/signal-spec/cmd/signal-spec@v0.1.0

Dependencies

  • github.com/spf13/cobra - CLI framework
  • github.com/xuri/excelize/v2 - XLSX generation
  • github.com/invopop/jsonschema - JSON Schema generation
  • github.com/grokify/mogo - Kebab-case validation

Documentation