Incidents

API Packages

Go Package Reference

This section provides comprehensive API documentation for all internal Go packages in the incident management platform. The documentation is automatically generated from source code comments and includes detailed information about types, functions, methods, and usage examples.

Package Categories

Core System Packages

  • models - Package models provides core data structures and types for the incident management platform.

  • server - Package server provides the HTTP server implementation for the incident management platform.

  • storage - Package storage provides comprehensive database abstraction and management for the incident management platform.

Authentication & Authorization

  • auth - Package auth provides comprehensive authentication and authorization services for the incident management platform.

  • policy - Package policy provides policy-based authorization and access control for the incident management platform.

  • scim - Package scim provides a comprehensive SCIM 2.0 server implementation for automated user provisioning and identity management.

External Integrations

  • chatops - Package chatops provides comprehensive ChatOps integration for the incident management platform.

  • connectors - Package connectors provides interfaces and implementations for external ITSM system integration.

  • notifications - Package notifications provides a unified, multi-channel notification dispatch system for the incident management platform.

  • push - Package push provides comprehensive push notification services for the incident management platform.

Event Processing

  • correlation - Package correlation provides intelligent incident correlation and deduplication for the incident management platform.

  • escalation - Package escalation provides automated incident escalation based on SLA breaches and configurable rules.

  • realtime - Package realtime provides comprehensive real-time event broadcasting and client connection management.

  • timeline - Package timeline provides comprehensive incident timeline management and event sourcing for the incident management platform.

Monitoring & Operations

  • metrics - Package metrics provides comprehensive business intelligence and analytics for the incident management platform.

  • observability - Package observability provides comprehensive OpenTelemetry instrumentation for the incident management platform.

  • redaction - Package redaction provides comprehensive data privacy and field redaction capabilities for the incident management platform.

  • sla - Package sla provides comprehensive Service Level Agreement monitoring and enforcement for the incident management platform.

All Packages

auth

Import: github.com/systmms/incidents/internal/auth

Package auth provides comprehensive authentication and authorization services for the incident management platform.

Package auth provides comprehensive authentication and authorization services for the incident management platform.

This package implements a flexible authentication system supporting multiple authen…

Contains:

  • 22 types
  • 8 functions
  • 1 variables
  • 1 constants

migrations

Import: github.com/systmms/incidents/internal/auth/migrations

API documentation for the migrations package.

Contains:

  • 2 types
  • 1 functions

providers

Import: github.com/systmms/incidents/internal/auth/providers

API documentation for the providers package.

Contains:

  • 17 types
  • 11 functions

types

Import: github.com/systmms/incidents/internal/auth/types

API documentation for the types package.

Contains:

  • 7 types

  • 1 functions

  • 2 constants

chatops

Import: github.com/systmms/incidents/internal/chatops

Package chatops provides comprehensive ChatOps integration for the incident management platform.

Package chatops provides comprehensive ChatOps integration for the incident management platform.

This package implements ChatOps (Chat Operations) functionality that enables incident management throu…

Contains:

  • 53 types

  • 1 variables

connectors

Import: github.com/systmms/incidents/internal/connectors

Package connectors provides interfaces and implementations for external ITSM system integration.

Package connectors provides interfaces and implementations for external ITSM system integration.

The connectors package enables bidirectional synchronization between the incident management platform …

Contains:

  • 61 types
  • 1 functions
  • 1 variables

correlation

Import: github.com/systmms/incidents/internal/correlation

Package correlation provides intelligent incident correlation and deduplication for the incident management platform.

Package correlation provides intelligent incident correlation and deduplication for the incident management platform.

This package implements the correlation system that automatically identifies rela…

Contains:

  • 15 types
  • 3 functions

escalation

Import: github.com/systmms/incidents/internal/escalation

Package escalation provides automated incident escalation based on SLA breaches and configurable rules.

Package escalation provides automated incident escalation based on SLA breaches and configurable rules.

This package implements intelligent incident escalation that automatically monitors incidents f…

Contains:

  • 7 types
  • 5 functions

metrics

Import: github.com/systmms/incidents/internal/metrics

Package metrics provides comprehensive business intelligence and analytics for the incident management platform.

Package metrics provides comprehensive business intelligence and analytics for the incident management platform.

This package implements the metrics collection and analysis system that transforms raw…

Contains:

  • 11 types
  • 3 functions

models

Import: github.com/systmms/incidents/internal/models

Package models provides core data structures and types for the incident management platform.

Package models provides core data structures and types for the incident management platform.

This package defines the fundamental data models used throughout the system, including:

  • Incident struc…

Contains:

  • 5 types

  • 2 constants

notifications

Import: github.com/systmms/incidents/internal/notifications

Package notifications provides a unified, multi-channel notification dispatch system for the incident management platform.

Package notifications provides a unified, multi-channel notification dispatch system for the incident management platform.

This package implements a sophisticated notification delivery system that in…

Contains:

  • 13 types
  • 3 functions

observability

Import: github.com/systmms/incidents/internal/observability

Package observability provides comprehensive OpenTelemetry instrumentation for the incident management platform.

Package observability provides comprehensive OpenTelemetry instrumentation for the incident management platform.

This package implements distributed tracing, metrics collection, and observability int…

Contains:

  • 4 types
  • 24 functions

policy

Import: github.com/systmms/incidents/internal/policy

Package policy provides policy-based authorization and access control for the incident management platform.

Package policy provides policy-based authorization and access control for the incident management platform.

This package implements a comprehensive authorization system using Open Policy Agent (OPA) …

Contains:

  • 24 types

  • 7 functions

  • 3 constants

bundle

Import: github.com/systmms/incidents/internal/policy/bundle

API documentation for the bundle package.

Contains:

  • 16 types
  • 6 functions

testing

Import: github.com/systmms/incidents/internal/policy/testing

API documentation for the testing package.

Contains:

  • 9 types
  • 3 functions

push

Import: github.com/systmms/incidents/internal/push

Package push provides comprehensive push notification services for the incident management platform.

Package push provides comprehensive push notification services for the incident management platform.

This package implements a flexible, multi-provider push notification system that delivers real-tim…

Contains:

  • 32 types
  • 1 functions

realtime

Import: github.com/systmms/incidents/internal/realtime

Package realtime provides comprehensive real-time event broadcasting and client connection management.

Package realtime provides comprehensive real-time event broadcasting and client connection management.

This package implements a high-performance real-time communication system that supports WebSocke…

Contains:

  • 16 types
  • 1 functions

centrifuge

Import: github.com/systmms/incidents/internal/realtime/centrifuge

API documentation for the centrifuge package.

Contains:

  • 13 types
  • 3 functions
  • 1 variables

redaction

Import: github.com/systmms/incidents/internal/redaction

Package redaction provides comprehensive data privacy and field redaction capabilities for the incident management platform.

Package redaction provides comprehensive data privacy and field redaction capabilities for the incident management platform.

This package implements sophisticated data redaction and privacy protectio…

Contains:

  • 8 types
  • 2 functions

scim

Import: github.com/systmms/incidents/internal/scim

Package scim provides a comprehensive SCIM 2.0 server implementation for automated user provisioning and identity management.

Package scim provides a comprehensive SCIM 2.0 server implementation for automated user provisioning and identity management.

This package implements a complete SCIM (System for Cross-domain Identity…

Contains:

  • 55 types

  • 8 functions

  • 3 constants

server

Import: github.com/systmms/incidents/internal/server

Package server provides the HTTP server implementation for the incident management platform.

Package server provides the HTTP server implementation for the incident management platform.

This package contains the main HTTP server that handles all REST API endpoints, WebSocket connections, Ser…

Contains:

  • 17 types
  • 6 functions

sla

Import: github.com/systmms/incidents/internal/sla

Package sla provides comprehensive Service Level Agreement monitoring and enforcement for the incident management platform.

Package sla provides comprehensive Service Level Agreement monitoring and enforcement for the incident management platform.

This package implements the SLA tracking system that monitors response time…

Contains:

  • 7 types
  • 1 functions

statemachine

Import: github.com/systmms/incidents/internal/statemachine

API documentation for the statemachine package.

Contains:

  • 5 types
  • 1 functions

storage

Import: github.com/systmms/incidents/internal/storage

Package storage provides comprehensive database abstraction and management for the incident management platform.

Package storage provides comprehensive database abstraction and management for the incident management platform.

This package implements the data persistence layer with support for multiple database …

Contains:

  • 5 types
  • 13 functions

testing

Import: github.com/systmms/incidents/internal/testing

API documentation for the testing package.

Contains:

  • 5 types

timeline

Import: github.com/systmms/incidents/internal/timeline

Package timeline provides comprehensive incident timeline management and event sourcing for the incident management platform.

Package timeline provides comprehensive incident timeline management and event sourcing for the incident management platform.

The timeline package implements the core event sourcing system that maint…

Contains:

  • 4 types

Development Notes

Documentation Standards

This API documentation follows Go documentation conventions:

  • Package Overview: General description and purpose
  • Types: Structs, interfaces, and custom types with their methods
  • Functions: Package-level functions and their usage
  • Examples: Code examples demonstrating common usage patterns
  • Constants/Variables: Package-level declarations

Source Code Integration

Documentation is automatically generated from Go source code using the go/doc package. To update documentation:

  1. Update GoDoc comments in the source code
  2. Run make docs-generate to regenerate documentation
  3. Hugo automatically rebuilds the documentation site

Cross-References

The API documentation includes cross-references between:

  • Related packages and their dependencies
  • HTTP endpoints and their corresponding Go types
  • CLI commands and their implementation packages

Package documentation generated automatically from Go source code. Last updated: 2025-08-25T07:51:05-04:00

Auth Package →
Bundle Package →
Centrifuge Package →
Chatops Package →
Connectors Package →
Correlation Package →
Escalation Package →
Metrics Package →
Migrations Package →
Models Package →
Notifications Package →
Observability Package →
Policy Package →
Providers Package →
Push Package →
Realtime Package →
Redaction Package →
Scim Package →
Server Package →
Sla Package →
Statemachine Package →
Storage Package →
Testing Package →
Timeline Package →
Types Package →