Skip to main content

41 docs tagged with "Ruby SDK"

View all tags

Activities

Activity Definitions, Activity Execution, Timeouts, Standalone Activities, Dynamic Activities, and benign exceptions in the Temporal Ruby SDK.

Activity basics

Define an Activity as a class that extends Temporalio::Activity::Definition, name it, and pick the executor that controls Activity concurrency.

Activity Execution

Call an Activity from a Ruby Workflow with Temporalio::Workflow.execute_activity and set the required Schedule-To-Close or Start-To-Close Timeout.

Activity Timeouts

Set the Schedule-To-Close, Start-To-Close, and Heartbeat Timeouts on a Ruby Activity, tune its Retry Policy, and override the next retry delay.

Asynchronous Activity Completion

Asynchronously complete an Activity in Temporal using the Ruby SDK. Follow simple steps to allow an Activity Function to return without the Activity Execution completing.

Benign exceptions

Mark expected or non-severe Activity errors as benign in Ruby to reduce noise in logs, metrics, and OpenTelemetry traces.

Best practices

This section explains how to implement best practices with the Ruby SDK

Cancellation

Handle Cancellation in Ruby Workflows and Activities, request Cancellation from a Client, and choose between Cancellation, termination, and reset.

Child Workflows

Start a Child Workflow Execution and set a Parent Close Policy using Temporal Ruby SDK.

Client

Connect a Temporal Client, start Workflow Executions, and get Workflow results with the Temporal Ruby SDK.

Continue-As-New

Use Continue-As-New in Ruby to close a Workflow Execution and start a new one with the same Workflow Id and a fresh Event History.

Data handling

Learn how Temporal handles data through the Data Converter, including payload conversion, encryption, and large payload storage.

Debugging

Debug Workflows in development and production environments using Temporal Ruby SDK. Use logging, debugger, CLI, replay, tracing, and more.

Dynamic Activity

Register one Dynamic Activity per Worker with activity_dynamic to handle Activity Types that match no other registered Activity.

Integrations

This section covers integrations with the Ruby SDK

Observability

Explore Temporal SDK observability features for Metrics, Tracing, Logging, and Visibility using the Ruby SDK.

Payload conversion

Customize how Temporal serializes application objects using Payload Converters in the Ruby SDK.

Payload encryption

Encrypt data sent to and from the Temporal Service using a custom Payload Codec in the Ruby SDK.

Platform

This section explains how to implement platform with the Ruby SDK

Rails integration

Use the Temporal Ruby SDK with Ruby on Rails, including conventions for ActiveRecord, ActiveModel, and handling lazy/eager loading.

Ruby SDK developer guide

Use the Temporal Ruby SDK to develop Temporal Applications, connect to the Temporal Service, test Workflows and Activities, handle failures, send messages, and more.

Run a Worker

Create and run a Temporal Worker using the Ruby SDK.

Schedules

Manage and optimize Scheduled Workflows using the Temporal Ruby SDK; Schedule, Create, Backfill, Update, Delete, Describe, List, Pause, Trigger, and more.

Serverless Workers

Write Temporal Workers that run on serverless compute using the Ruby SDK.

Temporal Client

Connect to a development Temporal Service or Temporal Cloud from Ruby, set a Task Queue and Workflow Id, and get Workflow Execution results.

Testing

The Ruby test-suite guide covers Workflow and integration testing for Temporal. It includes end-to-end, integration, and unit testing, emphasizing the use of the test server to optimize test execution.

Timers

Set a Durable Timer using the Temporal Ruby SDK. Pause Workflow execution for days or months. Timers are persisted and efficient.

Versioning

Use the Ruby SDK Patching API to safely deploy new code versions, handle deprecated patches, and manage Workflow activities using Temporal for long-running tasks.

Workers

This section explains how to implement Workers with the Ruby SDK

Workflow Timeouts

Optimize Workflow Execution with Temporal Ruby SDK - Set Workflow Timeouts and Retry Policies efficiently.

Workflows

This section explains how to implement Workflows with the Ruby SDK