Documentation
¶
Index ¶
- func RegisterDiagnostics(api huma.API, diag *diagnostics.DiagnosticsService)
- func RegisterStream(api huma.API, dashboardHandler *dashboard.DashboardHandler, ...)
- type DiagnosticsHandler
- func (h *DiagnosticsHandler) GetEnvironmentActorDiagnostics(ctx context.Context, _ *GetEnvironmentActorDiagnosticsInput) (*GetEnvironmentActorDiagnosticsOutput, error)
- func (h *DiagnosticsHandler) GetEnvironmentGoroutineDiagnostics(_ context.Context, _ *GetEnvironmentGoroutineDiagnosticsInput) (*GetEnvironmentGoroutineDiagnosticsOutput, error)
- type GetEnvironmentActorDiagnosticsInput
- type GetEnvironmentActorDiagnosticsOutput
- type GetEnvironmentGoroutineDiagnosticsInput
- type GetEnvironmentGoroutineDiagnosticsOutput
- type StreamClientInput
- type StreamHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterDiagnostics ¶
func RegisterDiagnostics(api huma.API, diag *diagnostics.DiagnosticsService)
RegisterDiagnostics registers the Huma diagnostics REST endpoints.
func RegisterStream ¶ added in v2.6.0
func RegisterStream( api huma.API, dashboardHandler *dashboard.DashboardHandler, activityHandler *activity.ActivityHandler, environmentHandler *environment.EnvironmentHandler, eventService *event.EventService, versionService *version.VersionService, )
RegisterStream registers the multiplexed client stream, reusing each domain's producer for its channel.
Types ¶
type DiagnosticsHandler ¶
type DiagnosticsHandler struct {
// contains filtered or unexported fields
}
DiagnosticsHandler serves the environment-scoped actor and goroutine diagnostics. The live diagnostics snapshots use the api/ws streams.
func (*DiagnosticsHandler) GetEnvironmentActorDiagnostics ¶ added in v2.15.0
func (h *DiagnosticsHandler) GetEnvironmentActorDiagnostics(ctx context.Context, _ *GetEnvironmentActorDiagnosticsInput) (*GetEnvironmentActorDiagnosticsOutput, error)
func (*DiagnosticsHandler) GetEnvironmentGoroutineDiagnostics ¶ added in v2.16.0
func (h *DiagnosticsHandler) GetEnvironmentGoroutineDiagnostics(_ context.Context, _ *GetEnvironmentGoroutineDiagnosticsInput) (*GetEnvironmentGoroutineDiagnosticsOutput, error)
type GetEnvironmentActorDiagnosticsInput ¶ added in v2.15.0
type GetEnvironmentActorDiagnosticsInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
}
type GetEnvironmentActorDiagnosticsOutput ¶ added in v2.15.0
type GetEnvironmentActorDiagnosticsOutput struct {
Body system.ActorDiagnostics
}
type GetEnvironmentGoroutineDiagnosticsInput ¶ added in v2.16.0
type GetEnvironmentGoroutineDiagnosticsInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
}
type GetEnvironmentGoroutineDiagnosticsOutput ¶ added in v2.16.0
type GetEnvironmentGoroutineDiagnosticsOutput struct {
Body system.GoroutineProfile
}
type StreamClientInput ¶ added in v2.6.0
type StreamClientInput struct {
Channels string `query:"channels" doc:"Comma-separated channels to subscribe to: environments, dashboard, activities, events, version"`
DebugAllGood bool `query:"debugAllGood" default:"false" doc:"Debug mode for the dashboard channel: force an empty action item list"`
Limit int `query:"limit" default:"0" doc:"Maximum activities to include in each activities-channel snapshot"`
}
type StreamHandler ¶ added in v2.6.0
type StreamHandler struct {
// contains filtered or unexported fields
}
StreamHandler multiplexes every live feed onto one connection.
func (*StreamHandler) StreamClient ¶ added in v2.6.0
func (h *StreamHandler) StreamClient(ctx context.Context, input *StreamClientInput, send sse.Sender)
Click to show internal directories.
Click to hide internal directories.