Go SDKFeature Clients
Metrics Client
Accessed via client.Metrics() on the Hatchet client.
MetricsClient
MetricsClient provides methods for retrieving metrics for workflows, tasks, and tenant queue
Methods:
| Name | Description |
|---|---|
GetQueueMetrics | GetQueueMetrics retrieves tenant-wide queue metrics. |
GetTaskQueueMetrics | GetTaskQueueMetrics retrieves tenant-wide step run queue metrics. |
GetWorkflowMetrics | GetWorkflowMetrics retrieves metrics for a specific workflow. |
Functions
GetQueueMetrics
GetQueueMetrics retrieves tenant-wide queue metrics.
func (m *MetricsClient) GetQueueMetrics(ctx context.Context, opts *rest.TenantGetQueueMetricsParams) (*rest.TenantQueueMetrics, error)Parameters:
| Name | Type |
|---|---|
ctx | context.Context |
opts | *rest.TenantGetQueueMetricsParams |
Returns:
| Type |
|---|
*rest.TenantQueueMetrics |
error |
GetTaskQueueMetrics
GetTaskQueueMetrics retrieves tenant-wide step run queue metrics.
func (m *MetricsClient) GetTaskQueueMetrics(ctx context.Context) (*rest.TenantStepRunQueueMetrics, error)Parameters:
| Name | Type |
|---|---|
ctx | context.Context |
Returns:
| Type |
|---|
*rest.TenantStepRunQueueMetrics |
error |
GetWorkflowMetrics
GetWorkflowMetrics retrieves metrics for a specific workflow.
func (m *MetricsClient) GetWorkflowMetrics(ctx context.Context, workflowName string, opts *rest.WorkflowGetMetricsParams) (*rest.WorkflowMetrics, error)Parameters:
| Name | Type |
|---|---|
ctx | context.Context |
workflowName | string |
opts | *rest.WorkflowGetMetricsParams |
Returns:
| Type |
|---|
*rest.WorkflowMetrics |
error |
Last updated on August 24, 2026