Temporal Go SDK (temporal-golang-pro)
Overview
Expert-level guide for building resilient, scalable, and deterministic distributed systems using the Temporal Go SDK. This skill transforms vague orchestration requirements into production-grade Go implementations, focusing on durable execution, strict determinism, and enterprise-scale worker configuration.
When to Use This Skill
- Designing Distributed Systems: When building microservices that require durable state and reliable orchestration.
- Implementing Complex Workflows: Using the Go SDK to handle long-running processes (days/months) or complex Saga patterns.
- Optimizing Performance: When workers need fine-tuned concurrency, mTLS security, or custom interceptors.
- Ensuring Reliability: Implementing idempotent activities, graceful error handling, and sophisticated retry policies.
- Maintenance & Evolution: Versioning running workflows or performing zero-downtime worker updates.
Do not use this skill when
- Using Temporal with other SDKs (Python, Java, TypeScript) - refer to their specific
-pro skills.
- The task is a simple request/response without durability or coordination needs.
- High-level design without implementation (use
workflow-orchestration-patterns).
Step-by-Step Guide
- Gather Context: Proactively ask for:
- Target Temporal Cluster (Cloud vs. Self-hosted) and Namespace.
- Task Queue names and expected throughput.
- Security requirements (mTLS paths, authentication).
- Failure modes and desired retry/timeout policies.
- Verify Determinism: Before suggesting workflow code, verify against these 5 Rules:
- No native Go concurrency (goroutines).
- No native time (
time.Now, time.Sleep).
- No non-deterministic map iteration (must sort keys).
- No direct external I/O or network calls.
- No non-deterministic random numbers.
- Implement Incrementally: Start with shared Protobuf/Data classes, then Activities, then Workflows, and finally Workers.
- Leverage Resources: If the implementation requires advanced patterns (Sagas, Interceptors, Replay Testing), explicitly refer to the implementation playbook and testing strategies.
Capabilities
Go SDK Implementation
- Worker Management: Deep knowledge of
worker.Options, including MaxConcurrentActivityTaskPollers, WorkerStopTimeout, and StickyScheduleToStartTimeout.
- Interceptors: Implementing Client, Worker, and Workflow interceptors for cross-cutting concerns (logging, tracing, auth).
- Custom Data Converters: Integrating Protobuf, encrypted payloads, or custom JSON marshaling.
Advanced Workflow Patterns
- Durable Concurrency: Using
workflow.Go, workflow.Channel, and workflow.Selector instead of native primitives.
- Versioning: Implementing safe code evolution using
workflow.GetVersion and workflow.GetReplaySafeLogger.
- Large-scale Processing: Pattern for
ContinueAsNew to manage history size limits (defaults: 50MB or 50K events).
- Child Workflows: Managing lifecycle, cancellation, and parent-child signal propagation.
Testing & Observability
- Testsuite Mastery: Using
WorkflowTestSuite for unit and functional testing with deterministic time control.
- Mocking: Sophisticated activity and child workflow mocking strategies.
- Replay Testing: Validating code changes against production event histories.
- Metrics: Configuring Prometheus/OpenTelemetry exporters for worker performance tracking.
Examples
Example 1: Versioned Workflow (Deterministic)
// Note: imports omitted. Requires 'go.temporal.io/sdk/workflow', 'go.temporal.io/sdk/temporal', and 'time'.
func SubscriptionWorkflow(ctx workflow.Context, userID string) error {
// 1. Versioning for logic evolution (v1 = DefaultVersion)
v := workflow.GetVersion(ctx, "billing_logic", workflow.DefaultVersion, 2)
for i := 0; i < 12; i++ {
ao := workflow.ActivityOptions{
StartToCloseTimeout: 5 * time.Minute,
RetryPolicy: &temporal.RetryPolicy{MaximumAttempts: 3},
}
ctx = workflow.WithActivityOptions(ctx, ao)
// 2. Activity Execution (Always handle errors)
err := workflow.ExecuteActivity(ctx, ChargePaymentActivity, userID).Get(ctx, nil)
if err != nil {
workflow.GetLogger(ctx).Error("Payment failed", "Error", err)
return err
}
// 3. Durable Sleep (Time-skipping safe)
sleepDuration := 30 * 24 * time.Hour
if v >= 2 {
sleepDuration = 28 * 24 * time.Hour
}
if err := workflow.Sleep(ctx, sleepDuration); err != nil {
return err
}
}
return nil
}
Example 2: Full mTLS Worker Setup
func RunSecureWorker() error {
// 1. Load Client Certificate and Key
cert, err := tls.LoadX509KeyPair("client.pem", "client.key")
if err != nil {
return fmt.Errorf("failed to load client keys: %w", err)
}
// 2. Load CA Certificate for Server verification (Proper mTLS)
caPem, err := os.ReadFile("ca.pem")
if err != nil {
return fmt.Errorf("failed to read CA cert: %w", err)
}
certPool := x509.NewCertPool()
if !certPool.AppendCertsFromPEM(caPem) {
return fmt.Errorf("failed to parse CA cert")
}
// 3. Dial Cluster with full TLS config
c, err := client.Dial(client.Options{
HostPort: "temporal.example.com:7233",
Namespace: "production",
ConnectionOptions: client.ConnectionOptions{
TLS: &tls.Config{
Certificates: []tls.Certificate{cert},
RootCAs: certPool,
},
},
})
if err != nil {
return fmt.Errorf("failed to dial temporal: %w", err)
}
defer c.Close()
w := worker.New(c, "payment-queue", worker.Options{})
w.RegisterWorkflow(SubscriptionWorkflow)
if err := w.Run(worker.InterruptCh()); err != nil {
return fmt.Errorf("worker run failed: %w", err)
}
return nil
}
Example 3: Selector & Signal Integration
func ApprovalWorkflow(ctx workflow.Context) (string, error) {
var approved bool
signalCh := workflow.GetSignalChannel(ctx, "approval-signal")
// Use Selector to wait for multiple async events
s := workflow.NewSelector(ctx)
s.AddReceive(signalCh, func(c workflow.ReceiveChannel, _ bool) {
c.Receive(ctx, &approved)
})
// Add 72-hour timeout timer
s.AddReceive(workflow.NewTimer(ctx, 72*time.Hour).GetChannel(), func(c workflow.ReceiveChannel, _ bool) {
approved = false
})
s.Select(ctx)
if !approved {
return "rejected", nil
}
return "approved", nil
}
Best Practices
- ✅ Do: Always handle errors from
ExecuteActivity and client.Dial.
- ✅ Do: Use
workflow.Go and workflow.Channel for concurrency.
- ✅ Do: Sort map keys before iteration to maintain determinism.
- ✅ Do: Use
activity.RecordHeartbeat for activities lasting > 1 minute.
- ✅ Do: Test logic compatibility using
replayer.ReplayWorkflowHistoryFromJSON.
- ❌ Don't: Swallow errors with
_ or log.Fatal in production workers.
- ❌ Don't: Perform direct Network/Disk I/O inside a Workflow function.
- ❌ Don't: Rely on native
time.Now() or rand.Int().
- ❌ Don't: Apply this to simple cron jobs that don't require durability.
Troubleshooting
- Panic: Determinism Mismatch: Usually caused by logic changes without
workflow.GetVersion or non-deterministic code (e.g., native maps).
- Error: History Size Exceeded: History limit reached (default 50K events). Ensure
ContinueAsNew is implemented.
- Worker Hang: Check
WorkerStopTimeout and ensure all activities handle context cancellation.
Limitations
- Does not cover Temporal Cloud UI navigation or TLS certificate provisioning workflows.
- Does not cover Temporal Java, Python, or TypeScript SDKs; refer to their dedicated
-pro skills.
- Assumes Temporal Server v1.20+ and Go SDK v1.25+; older SDK versions may have different APIs.
- Does not cover experimental Temporal features (e.g., Nexus, Multi-cluster Replication).
- Does not address global namespace configuration or multi-region failover setup.
- Does not cover Temporal Worker versioning via the
worker-versioning feature flag (experimental).
Resources
Related Skills
grpc-golang - Internal transport protocol and Protobuf design.
golang-pro - General Go performance tuning and advanced syntax.
workflow-orchestration-patterns - Language-agnostic orchestration strategy.
1---2name: temporal-golang-pro3description: Use when building durable distributed systems with Temporal Go SDK. Covers deterministic workflow rules, mTLS worker configs, and advanced patterns.4license: MIT5---6
7# Temporal Go SDK (temporal-golang-pro)
8
9## Overview
10
11Expert-level guide for building resilient, scalable, and deterministic distributed systems using the Temporal Go SDK. This skill transforms vague orchestration requirements into production-grade Go implementations, focusing on durable execution, strict determinism, and enterprise-scale worker configuration.
12
13## When to Use This Skill
14
15- **Designing Distributed Systems**: When building microservices that require durable state and reliable orchestration.
16- **Implementing Complex Workflows**: Using the Go SDK to handle long-running processes (days/months) or complex Saga patterns.
17- **Optimizing Performance**: When workers need fine-tuned concurrency, mTLS security, or custom interceptors.
18- **Ensuring Reliability**: Implementing idempotent activities, graceful error handling, and sophisticated retry policies.
19- **Maintenance & Evolution**: Versioning running workflows or performing zero-downtime worker updates.
20
21## Do not use this skill when
22
23- Using Temporal with other SDKs (Python, Java, TypeScript) - refer to their specific `-pro` skills.
24- The task is a simple request/response without durability or coordination needs.
25- High-level design without implementation (use `workflow-orchestration-patterns`).
26
27## Step-by-Step Guide
28
291. **Gather Context**: Proactively ask for:
30 - Target **Temporal Cluster** (Cloud vs. Self-hosted) and **Namespace**.
31 - **Task Queue** names and expected throughput.
32 - **Security requirements** (mTLS paths, authentication).
33 - **Failure modes** and desired retry/timeout policies.
342. **Verify Determinism**: Before suggesting workflow code, verify against these **5 Rules**:
35 - No native Go concurrency (goroutines).
36 - No native time (`time.Now`, `time.Sleep`).
37 - No non-deterministic map iteration (must sort keys).
38 - No direct external I/O or network calls.
39 - No non-deterministic random numbers.
403. **Implement Incrementally**: Start with shared Protobuf/Data classes, then Activities, then Workflows, and finally Workers.
414. **Leverage Resources**: If the implementation requires advanced patterns (Sagas, Interceptors, Replay Testing), explicitly refer to the implementation playbook and testing strategies.
42
43## Capabilities
44
45### Go SDK Implementation
46
47- **Worker Management**: Deep knowledge of `worker.Options`, including `MaxConcurrentActivityTaskPollers`, `WorkerStopTimeout`, and `StickyScheduleToStartTimeout`.
48- **Interceptors**: Implementing Client, Worker, and Workflow interceptors for cross-cutting concerns (logging, tracing, auth).
49- **Custom Data Converters**: Integrating Protobuf, encrypted payloads, or custom JSON marshaling.
50
51### Advanced Workflow Patterns
52
53- **Durable Concurrency**: Using `workflow.Go`, `workflow.Channel`, and `workflow.Selector` instead of native primitives.
54- **Versioning**: Implementing safe code evolution using `workflow.GetVersion` and `workflow.GetReplaySafeLogger`.
55- **Large-scale Processing**: Pattern for `ContinueAsNew` to manage history size limits (defaults: 50MB or 50K events).
56- **Child Workflows**: Managing lifecycle, cancellation, and parent-child signal propagation.
57
58### Testing & Observability
59
60- **Testsuite Mastery**: Using `WorkflowTestSuite` for unit and functional testing with deterministic time control.
61- **Mocking**: Sophisticated activity and child workflow mocking strategies.
62- **Replay Testing**: Validating code changes against production event histories.
63- **Metrics**: Configuring Prometheus/OpenTelemetry exporters for worker performance tracking.
64
65## Examples
66
67### Example 1: Versioned Workflow (Deterministic)
68
69```go
70// Note: imports omitted. Requires 'go.temporal.io/sdk/workflow', 'go.temporal.io/sdk/temporal', and 'time'.
71func SubscriptionWorkflow(ctx workflow.Context, userID string) error {
72 // 1. Versioning for logic evolution (v1 = DefaultVersion)
73 v := workflow.GetVersion(ctx, "billing_logic", workflow.DefaultVersion, 2)
74
75 for i := 0; i < 12; i++ {
76 ao := workflow.ActivityOptions{
77 StartToCloseTimeout: 5 * time.Minute,
78 RetryPolicy: &temporal.RetryPolicy{MaximumAttempts: 3},
79 }
80 ctx = workflow.WithActivityOptions(ctx, ao)
81
82 // 2. Activity Execution (Always handle errors)
83 err := workflow.ExecuteActivity(ctx, ChargePaymentActivity, userID).Get(ctx, nil)
84 if err != nil {
85 workflow.GetLogger(ctx).Error("Payment failed", "Error", err)
86 return err
87 }
88
89 // 3. Durable Sleep (Time-skipping safe)
90 sleepDuration := 30 * 24 * time.Hour
91 if v >= 2 {
92 sleepDuration = 28 * 24 * time.Hour
93 }
94
95 if err := workflow.Sleep(ctx, sleepDuration); err != nil {
96 return err
97 }
98 }
99 return nil
100}
101```
102
103### Example 2: Full mTLS Worker Setup
104
105```go
106func RunSecureWorker() error {
107 // 1. Load Client Certificate and Key
108 cert, err := tls.LoadX509KeyPair("client.pem", "client.key")
109 if err != nil {
110 return fmt.Errorf("failed to load client keys: %w", err)
111 }
112
113 // 2. Load CA Certificate for Server verification (Proper mTLS)
114 caPem, err := os.ReadFile("ca.pem")
115 if err != nil {
116 return fmt.Errorf("failed to read CA cert: %w", err)
117 }
118 certPool := x509.NewCertPool()
119 if !certPool.AppendCertsFromPEM(caPem) {
120 return fmt.Errorf("failed to parse CA cert")
121 }
122
123 // 3. Dial Cluster with full TLS config
124 c, err := client.Dial(client.Options{
125 HostPort: "temporal.example.com:7233",
126 Namespace: "production",
127 ConnectionOptions: client.ConnectionOptions{
128 TLS: &tls.Config{
129 Certificates: []tls.Certificate{cert},
130 RootCAs: certPool,
131 },
132 },
133 })
134 if err != nil {
135 return fmt.Errorf("failed to dial temporal: %w", err)
136 }
137 defer c.Close()
138
139 w := worker.New(c, "payment-queue", worker.Options{})
140 w.RegisterWorkflow(SubscriptionWorkflow)
141
142 if err := w.Run(worker.InterruptCh()); err != nil {
143 return fmt.Errorf("worker run failed: %w", err)
144 }
145 return nil
146}
147```
148
149### Example 3: Selector & Signal Integration
150
151```go
152func ApprovalWorkflow(ctx workflow.Context) (string, error) {
153 var approved bool
154 signalCh := workflow.GetSignalChannel(ctx, "approval-signal")
155
156 // Use Selector to wait for multiple async events
157 s := workflow.NewSelector(ctx)
158 s.AddReceive(signalCh, func(c workflow.ReceiveChannel, _ bool) {
159 c.Receive(ctx, &approved)
160 })
161
162 // Add 72-hour timeout timer
163 s.AddReceive(workflow.NewTimer(ctx, 72*time.Hour).GetChannel(), func(c workflow.ReceiveChannel, _ bool) {
164 approved = false
165 })
166
167 s.Select(ctx)
168
169 if !approved {
170 return "rejected", nil
171 }
172 return "approved", nil
173}
174```
175
176## Best Practices
177
178- ✅ **Do:** Always handle errors from `ExecuteActivity` and `client.Dial`.
179- ✅ **Do:** Use `workflow.Go` and `workflow.Channel` for concurrency.
180- ✅ **Do:** Sort map keys before iteration to maintain determinism.
181- ✅ **Do:** Use `activity.RecordHeartbeat` for activities lasting > 1 minute.
182- ✅ **Do:** Test logic compatibility using `replayer.ReplayWorkflowHistoryFromJSON`.
183- ❌ **Don't:** Swallow errors with `_` or `log.Fatal` in production workers.
184- ❌ **Don't:** Perform direct Network/Disk I/O inside a Workflow function.
185- ❌ **Don't:** Rely on native `time.Now()` or `rand.Int()`.
186- ❌ **Don't:** Apply this to simple cron jobs that don't require durability.
187
188## Troubleshooting
189
190- **Panic: Determinism Mismatch**: Usually caused by logic changes without `workflow.GetVersion` or non-deterministic code (e.g., native maps).
191- **Error: History Size Exceeded**: History limit reached (default 50K events). Ensure `ContinueAsNew` is implemented.
192- **Worker Hang**: Check `WorkerStopTimeout` and ensure all activities handle context cancellation.
193
194## Limitations
195
196- Does not cover Temporal Cloud UI navigation or TLS certificate provisioning workflows.
197- Does not cover Temporal Java, Python, or TypeScript SDKs; refer to their dedicated `-pro` skills.
198- Assumes Temporal Server v1.20+ and Go SDK v1.25+; older SDK versions may have different APIs.
199- Does not cover experimental Temporal features (e.g., Nexus, Multi-cluster Replication).
200- Does not address global namespace configuration or multi-region failover setup.
201- Does not cover Temporal Worker versioning via the `worker-versioning` feature flag (experimental).
202
203## Resources
204
205- [Implementation Playbook](resources/implementation-playbook.md) - Deep dive into Go SDK patterns.
206- [Testing Strategies](resources/testing-strategies.md) - Unit, Replay, and Integration testing for Go.
207- [Temporal Go SDK Reference](https://pkg.go.dev/go.temporal.io/sdk)
208- [Temporal Go Samples](https://github.com/temporalio/samples-go)
209
210## Related Skills
211
212- `grpc-golang` - Internal transport protocol and Protobuf design.
213- `golang-pro` - General Go performance tuning and advanced syntax.
214- `workflow-orchestration-patterns` - Language-agnostic orchestration strategy.