Observability - Ruby SDK
This page covers capabilities related to viewing the state of the application, including:
The observability guide covers the many ways to view the current state of your Temporal Application. This includes viewing Workflow Executions tracked by the Temporal Platform, as well as inspecting state at any point during execution.
Emit metrics
Each Temporal SDK can optionally emit metrics from either the Client or Worker process.
- Metrics can be scraped by systems like Prometheus.
- Graphs can be created using tools like Grafana.
- For a list of metrics, see the SDK metrics reference.
Setup Tracing
Tracing enables observability into the sequence of calls across your application, including Workflows and Activities.
Log from a Workflow
Logging enables you to capture and persist important execution details from your Workflow and Activity code.
Logging levels typically include:
| Level | Use |
|---|---|
TRACE | The most detailed level of logging, used for very fine-grained information. |
DEBUG | Detailed information, typically useful for debugging purposes. |
INFO | General information about the application's operation. |
WARN | Indicates potentially harmful situations or minor issues that don't prevent the application from working. |
ERROR | Indicates error conditions that might still allow the application to continue running. |
Use Visibility APIs
Visibility refers to Temporal features for listing, filtering, and inspecting Workflow Executions.
Use Search Attributes
- Default Search Attributes like
WorkflowType,StartTime, andExecutionStatusare automatically indexed. - Custom Search Attributes let you store domain-specific metadata for Workflows.