Add docs for Nexus circuit breaker #3220
+59
−46
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,4 +44,4 @@ Through a Temporal SDK, Temporal provides a wide range of features that enable d | |
| - **[Low Latency](/evaluate/development-production-features/low-latency)**: Making your applications faster, more performant, and more efficient. | ||
| - **[Multi-tenancy](/evaluate/development-production-features/multi-tenancy)**: Enhances efficiency and cost-effectiveness. | ||
|
|
||
| For detailed information on Temporal feature release stages and criteria, see this [Product Release Stages Guide](/evaluate/development-production-features/release-stages). | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,31 +50,31 @@ Unlike other forms of inter-service communication, Nexus combines a familiar pro | |
| ### Use cases | ||
|
|
||
| - **Cross-team, cross-domain, and cross-namespace** \- | ||
| Nexus is purpose-built to connect Temporal Applications within and across Namespaces. | ||
| It addresses the limitations of Child Workflows, Activity Wrappers, and bespoke APIs that target a remote Namespace; such as leaking implementation details, second-class observability, overly-permissive security, and error-prone boilerplate code. | ||
| Nexus has a streamlined Temporal developer experience, reliable execution, and integrated observability. | ||
|
|
||
| - **Share a subset of a Temporal Application** \- | ||
| Abstract and share a subset of an Application as a Nexus Service. | ||
| Nexus Operations can span any length of execution, be synchronous or asynchronous, and be implemented with Temporal primitives, like Workflows, Signals, or Updates. | ||
| Expose Services on a Nexus Endpoint for others to use and secure them with access control policies. | ||
| Nexus Endpoints decouple callers from handlers, so teams can operate more autonomously. | ||
|
|
||
| - **Modular design for growth** \- | ||
| Temporal Nexus enables a modular application design that can evolve as you grow. | ||
| Start with Nexus Services in a monolithic Namespace and move Services to separate Namespaces with small configuration changes. | ||
|
|
||
| - **Smaller failure domains** \- When teams operate in the same monolithic Namespace, everything is available to everyone, and mis-behaving Workers can trigger rate limits that affect all teams operating in that monolithic Namespace. | ||
| Nexus enables each team to have their own Namespace for improved security, troubleshooting, and fault isolation. | ||
|
|
||
| - **Multi-region** \- | ||
| Nexus requests in Temporal Cloud are routed across a global mTLS-secured Envoy mesh. | ||
| Built-in Nexus Machinery provides reliable at-least-once execution and Workflow policy can deduplicate requests for exactly-once execution, even across multi-region boundaries. | ||
|
|
||
| ### Key features | ||
|
|
||
| - **Familiar developer experience** \- | ||
| Temporal SDKs provide an integrated way to build and use Nexus Services. | ||
| - Use Nexus Services from a caller Workflow. | ||
| - Run Nexus Service handlers in a Worker, often the same Worker as underlying Temporal primitives. | ||
| - Implement long-running asynchronous Nexus Operations as Workflows. | ||
|
|
@@ -89,32 +89,32 @@ Temporal SDKs provide an integrated way to build and use Nexus Services. | |
| - Streamline operations by running Nexus Services in existing queue-based Workers. | ||
|
|
||
| - **Built-in Nexus Machinery** \- | ||
| Execution guarantees are provided with built-in Nexus Machinery. | ||
| - Execute Nexus Operations with reliable state-machine-based invocation and completion callbacks. | ||
| - Guarantee atomic handoff from Workflow Event History to Nexus Operation state machines. | ||
| - Ensure reliable execution with automatic retries, rate limiting, concurrency limiting, and circuit breaking. | ||
|
|
||
| - **Integrated observability** \- | ||
| Execution debugging and observability is integrated into the Temporal Platform. | ||
| - View Nexus Operation lifecycle and error info in Workflow Event History. | ||
| - Debug across Namespaces with bi-directional linking. | ||
| - Generate metrics, traces, and logs. | ||
|
|
||
| - **Improved blast radius isolation** \- | ||
| Separate Namespaces isolate underlying Workers and sensitive Workflow state. | ||
| - Limit direct access to a Namespace, while exposing Nexus Endpoints for others to use. | ||
| - Isolate misbehaving Workers that affect rate limits for all Workers in a Namespace. | ||
| - Avoid leaking Workflow implementation details to external callers. | ||
|
|
||
| - **Enhanced security and connectivity** \- | ||
| Temporal Cloud provides integrated Nexus access controls and multi-region routing. | ||
| - Connect Applications across Namespaces in an Account with Temporal's private mTLS-secured Envoy mesh. | ||
| - Restrict which callers can use a Nexus Endpoint, with built-in Endpoint access controls. | ||
| - Stream audit logs including Nexus Registry actions to create, update, or delete Endpoints. | ||
|
|
||
| ## Learn more | ||
|
|
||
| To connect with the Nexus community, join the [#nexus](https://temporalio.slack.com/archives/C07LQN0JK9B) channel in [Temporal Slack](https://t.mp/slack). | ||
|
|
||
| <RelatedReadContainer> | ||
| <RelatedReadItem path="https://youtu.be/qqc2vsv1mrU?feature=shared&t=2082" text="Nexus keynote & demo - Replay video" archetype="replay-talk" /> | ||
|
|
@@ -124,4 +124,4 @@ Temporal Cloud provides integrated Nexus access controls and multi-region routin | |
| <RelatedReadItem path="/develop/go/nexus" text="Go SDK - Nexus quick start and code sample" archetype="feature-guide" /> | ||
| <RelatedReadItem path="/develop/java/nexus" text="Java SDK - Nexus quick start and code sample" archetype="feature-guide" /> | ||
| <RelatedReadItem path="/nexus" text="Nexus" archetype="encyclopedia" /> | ||
| </RelatedReadContainer> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -160,9 +160,9 @@ We offer two Support tiers: Basic and Premium. | |
| Support costs are outlined in the table below. | ||
| A complete description of Support plans and response times can be found in our [Support](/cloud/support#support) documentation. | ||
|
|
||
| | | Basic | Premium | | ||
| | ------------------- | ------------------------------------------- | ----------------------------------------- | | ||
| | Pricing (per month) | Greater of $200 or 10% of monthly usage | Contact [Sales](mailto:[email protected]) | | ||
|
|
||
| ### Pricing options {#pricing-options} | ||
|
|
||
|
|
@@ -456,4 +456,3 @@ You will be assigned a new Temporal account and be treated as a new customer. | |
| **What happens to my credits if I cancel my account?** | ||
|
|
||
| Prepaid but unused credits purchased after June 17, 2024 will be refunded if the account is canceled. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,10 +52,10 @@ Temporal Cloud operates in several regions on Amazon Web Services (AWS): | |
|
|
||
| Temporal Cloud operates in two regions on Google Cloud (GCP): | ||
|
|
||
| | Area | Code | Region | | ||
| | ------------- | ----------- | ------ | | ||
| | North America | us-west1 | Oregon | | ||
| | Asia Pacific | asia-south1 | Mumbai | | ||
|
|
||
| ## Throughput expectations {#throughput} | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -405,14 +405,15 @@ If you have an existing User in Temporal Cloud, you can import it into Terraform | |
| ```yml | ||
| resource "temporalcloud_user" "user" { | ||
| } | ||
| ``` | ||
|
|
||
| ```` | ||
| 1. Run the `terraform import` command and pass in the User ID | ||
| Your User ID is available using the Temporal Cloud CLI `tcld u l` command. | ||
|
|
||
| ```bash | ||
| terraform import temporalcloud_user.user 72360058153949edb2f1d47019c1e85f | ||
| ```` | ||
|
|
||
| The User is now a part of the Terraform state and all changes to the User should be managed by Terraform. | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would explicitly call out request timeouts and how that may relate to when a worker is down.