sidekiq

package
v1.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package sidekiq implements MCP tools for GitLab Sidekiq metrics API.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatCompoundMetricsMarkdown

func FormatCompoundMetricsMarkdown(out GetCompoundMetricsOutput) string

FormatCompoundMetricsMarkdown formats compound metrics as markdown.

func FormatJobStatsMarkdown

func FormatJobStatsMarkdown(out GetJobStatsOutput) string

FormatJobStatsMarkdown formats job statistics as markdown.

func FormatProcessMetricsMarkdown

func FormatProcessMetricsMarkdown(out GetProcessMetricsOutput) string

FormatProcessMetricsMarkdown formats process metrics as markdown.

func FormatQueueMetricsMarkdown

func FormatQueueMetricsMarkdown(out GetQueueMetricsOutput) string

FormatQueueMetricsMarkdown formats queue metrics as markdown.

func RegisterTools

func RegisterTools(server *mcp.Server, client *gitlabclient.Client)

RegisterTools registers all Sidekiq metrics MCP tools.

Types

type GetCompoundMetricsInput

type GetCompoundMetricsInput struct{}

GetCompoundMetricsInput is the input for the compound metrics tool.

type GetCompoundMetricsOutput

type GetCompoundMetricsOutput struct {
	toolutil.HintableOutput
	Queues    []QueueItem   `json:"queues"`
	Processes []ProcessItem `json:"processes"`
	Jobs      JobStatsItem  `json:"jobs"`
}

GetCompoundMetricsOutput is the output for the compound metrics tool.

func GetCompoundMetrics

GetCompoundMetrics retrieves all Sidekiq metrics in a single compound response.

type GetJobStatsInput

type GetJobStatsInput struct{}

GetJobStatsInput is the input for the job stats tool.

type GetJobStatsOutput

type GetJobStatsOutput struct {
	toolutil.HintableOutput
	Jobs JobStatsItem `json:"jobs"`
}

GetJobStatsOutput is the output for the job stats tool.

func GetJobStats

GetJobStats retrieves current Sidekiq job statistics.

type GetProcessMetricsInput

type GetProcessMetricsInput struct{}

GetProcessMetricsInput is the input for the process metrics tool.

type GetProcessMetricsOutput

type GetProcessMetricsOutput struct {
	toolutil.HintableOutput
	Processes []ProcessItem `json:"processes"`
}

GetProcessMetricsOutput is the output for the process metrics tool.

func GetProcessMetrics

GetProcessMetrics retrieves current Sidekiq process metrics.

type GetQueueMetricsInput

type GetQueueMetricsInput struct{}

GetQueueMetricsInput is the input for the queue metrics tool.

type GetQueueMetricsOutput

type GetQueueMetricsOutput struct {
	toolutil.HintableOutput
	Queues []QueueItem `json:"queues"`
}

GetQueueMetricsOutput is the output for the queue metrics tool.

func GetQueueMetrics

GetQueueMetrics retrieves current Sidekiq queue metrics.

type JobStatsItem

type JobStatsItem struct {
	Processed int64 `json:"processed"`
	Failed    int64 `json:"failed"`
	Enqueued  int64 `json:"enqueued"`
}

JobStatsItem represents Sidekiq job statistics.

type ProcessItem

type ProcessItem struct {
	Hostname    string   `json:"hostname"`
	Pid         int64    `json:"pid"`
	Tag         string   `json:"tag"`
	StartedAt   string   `json:"started_at"`
	Queues      []string `json:"queues"`
	Labels      []string `json:"labels"`
	Concurrency int64    `json:"concurrency"`
	Busy        int64    `json:"busy"`
}

ProcessItem represents a single Sidekiq process.

type QueueItem

type QueueItem struct {
	Name    string `json:"name"`
	Backlog int64  `json:"backlog"`
	Latency int64  `json:"latency"`
}

QueueItem represents a single Sidekiq queue with its metrics.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL