grpc 1.69.0 → 1.70.1

data/src/core/load_balancing/pick_first/pick_first.cc

@@ -246,7 +246,7 @@ class PickFirst final : public LoadBalancingPolicy {
 
     SubchannelList(RefCountedPtr<PickFirst> policy,
                    EndpointAddressesIterator* addresses,
-                   const ChannelArgs& args);
+                   const ChannelArgs& args, absl::string_view resolution_note);
 
     ~SubchannelList() override;
 
@@ -269,6 +269,8 @@ class PickFirst final : public LoadBalancingPolicy {
       return true;
     }
 
+    void ReportTransientFailure(absl::Status status);
+
    private:
     // Returns true if all subchannels have seen their initial
     // connectivity state notifications.
@@ -293,6 +295,7 @@ class PickFirst final : public LoadBalancingPolicy {
     RefCountedPtr<PickFirst> policy_;
 
     ChannelArgs args_;
+    std::string resolution_note_;
 
     // The list of subchannels.
     std::vector<std::unique_ptr<SubchannelData>> subchannels_;
@@ -323,8 +326,9 @@ class PickFirst final : public LoadBalancingPolicy {
   class HealthWatcher final
       : public SubchannelInterface::ConnectivityStateWatcherInterface {
    public:
-    explicit HealthWatcher(RefCountedPtr<PickFirst> policy)
-        : policy_(std::move(policy)) {}
+    HealthWatcher(RefCountedPtr<PickFirst> policy,
+                  absl::string_view resolution_note)
+        : policy_(std::move(policy)), resolution_note_(resolution_note) {}
 
     ~HealthWatcher() override {
       policy_.reset(DEBUG_LOCATION, "HealthWatcher dtor");
@@ -339,6 +343,7 @@ class PickFirst final : public LoadBalancingPolicy {
 
    private:
     RefCountedPtr<PickFirst> policy_;
+    std::string resolution_note_;
   };
 
   class Picker final : public SubchannelPicker {
@@ -459,19 +464,16 @@ void PickFirst::AttemptToConnectUsingLatestUpdateArgsLocked() {
   }
   subchannel_list_ = MakeOrphanable<SubchannelList>(
       RefAsSubclass<PickFirst>(DEBUG_LOCATION, "SubchannelList"), addresses,
-      latest_update_args_.args);
+      latest_update_args_.args, latest_update_args_.resolution_note);
   // Empty update or no valid subchannels.  Put the channel in
   // TRANSIENT_FAILURE and request re-resolution.  Also unset the
   // current selected subchannel.
   if (subchannel_list_->size() == 0) {
     channel_control_helper()->RequestReresolution();
-    absl::Status status =
-        latest_update_args_.addresses.ok()
-            ? absl::UnavailableError(absl::StrCat(
-                  "empty address list: ", latest_update_args_.resolution_note))
-            : latest_update_args_.addresses.status();
-    UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                MakeRefCounted<TransientFailurePicker>(status));
+    absl::Status status = latest_update_args_.addresses.ok()
+                              ? absl::UnavailableError("empty address list")
+                              : latest_update_args_.addresses.status();
+    subchannel_list_->ReportTransientFailure(std::move(status));
     UnsetSelectedSubchannel();
   }
 }
@@ -611,7 +613,7 @@ void PickFirst::GoIdle() {
   // ExitIdleLocked() instead.
   channel_control_helper()->RequestReresolution();
   // Enter idle.
-  UpdateState(GRPC_CHANNEL_IDLE, absl::Status(),
+  UpdateState(GRPC_CHANNEL_IDLE, absl::OkStatus(),
               MakeRefCounted<QueuePicker>(Ref(DEBUG_LOCATION, "QueuePicker")));
 }
 
@@ -643,12 +645,17 @@ void PickFirst::HealthWatcher::OnConnectivityStateChange(
           new_state, absl::OkStatus(),
           MakeRefCounted<QueuePicker>(policy_->Ref()));
       break;
-    case GRPC_CHANNEL_TRANSIENT_FAILURE:
+    case GRPC_CHANNEL_TRANSIENT_FAILURE: {
+      std::string message = absl::StrCat("health watch: ", status.message());
+      if (!resolution_note_.empty()) {
+        absl::StrAppend(&message, " (", resolution_note_, ")");
+      }
       policy_->channel_control_helper()->UpdateState(
           GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-          MakeRefCounted<TransientFailurePicker>(absl::UnavailableError(
-              absl::StrCat("health watch: ", status.message()))));
+          MakeRefCounted<TransientFailurePicker>(
+              absl::UnavailableError(message)));
       break;
+    }
     case GRPC_CHANNEL_SHUTDOWN:
       Crash("health watcher reported state SHUTDOWN");
   }
@@ -700,7 +707,8 @@ void PickFirst::SubchannelList::SubchannelData::SubchannelState::Select() {
     GRPC_TRACE_LOG(pick_first, INFO)
         << "[PF " << pick_first_.get() << "] starting health watch";
     auto watcher = std::make_unique<HealthWatcher>(
-        pick_first_.Ref(DEBUG_LOCATION, "HealthWatcher"));
+        pick_first_.Ref(DEBUG_LOCATION, "HealthWatcher"),
+        subchannel_data_->subchannel_list_->resolution_note_);
     pick_first_->health_watcher_ = watcher.get();
     auto health_data_watcher = MakeHealthCheckWatcher(
         pick_first_->work_serializer(),
@@ -708,7 +716,7 @@ void PickFirst::SubchannelList::SubchannelData::SubchannelState::Select() {
     pick_first_->health_data_watcher_ = health_data_watcher.get();
     subchannel_->AddDataWatcher(std::move(health_data_watcher));
   } else {
-    pick_first_->UpdateState(GRPC_CHANNEL_READY, absl::Status(),
+    pick_first_->UpdateState(GRPC_CHANNEL_READY, absl::OkStatus(),
                              MakeRefCounted<Picker>(subchannel_));
   }
   // Report successful connection.
@@ -902,8 +910,7 @@ void PickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
                    ? ""
                    : "failed to connect to all addresses; last error: "),
               connectivity_status_.ToString()));
-          p->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                         MakeRefCounted<TransientFailurePicker>(status));
+          subchannel_list_->ReportTransientFailure(std::move(status));
         }
       }
       break;
@@ -921,7 +928,7 @@ void PickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
       // TRANSIENT_FAILURE.
       // TODO(roth): Squelch duplicate CONNECTING updates.
       if (p->state_ != GRPC_CHANNEL_TRANSIENT_FAILURE) {
-        p->UpdateState(GRPC_CHANNEL_CONNECTING, absl::Status(),
+        p->UpdateState(GRPC_CHANNEL_CONNECTING, absl::OkStatus(),
                        MakeRefCounted<QueuePicker>(nullptr));
       }
       break;
@@ -978,13 +985,15 @@ void PickFirst::SubchannelList::SubchannelData::RequestConnectionWithTimer() {
 
 PickFirst::SubchannelList::SubchannelList(RefCountedPtr<PickFirst> policy,
                                           EndpointAddressesIterator* addresses,
-                                          const ChannelArgs& args)
+                                          const ChannelArgs& args,
+                                          absl::string_view resolution_note)
     : InternallyRefCounted<SubchannelList>(
           GRPC_TRACE_FLAG_ENABLED(pick_first) ? "SubchannelList" : nullptr),
       policy_(std::move(policy)),
-      args_(args.Remove(GRPC_ARG_INTERNAL_PICK_FIRST_ENABLE_HEALTH_CHECKING)
-                .Remove(
-                    GRPC_ARG_INTERNAL_PICK_FIRST_OMIT_STATUS_MESSAGE_PREFIX)) {
+      args_(
+          args.Remove(GRPC_ARG_INTERNAL_PICK_FIRST_ENABLE_HEALTH_CHECKING)
+              .Remove(GRPC_ARG_INTERNAL_PICK_FIRST_OMIT_STATUS_MESSAGE_PREFIX)),
+      resolution_note_(resolution_note) {
   GRPC_TRACE_LOG(pick_first, INFO)
       << "[PF " << policy_.get() << "] Creating subchannel list " << this
       << " - channel args: " << args_.ToString();
@@ -1037,6 +1046,15 @@ void PickFirst::SubchannelList::ResetBackoffLocked() {
   }
 }
 
+void PickFirst::SubchannelList::ReportTransientFailure(absl::Status status) {
+  if (!resolution_note_.empty()) {
+    status = absl::Status(status.code(), absl::StrCat(status.message(), " (",
+                                                      resolution_note_, ")"));
+  }
+  policy_->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
+                       MakeRefCounted<TransientFailurePicker>(status));
+}
+
 void PickFirst::SubchannelList::StartConnectingNextSubchannel() {
   // Find the next subchannel not in state TRANSIENT_FAILURE.
   // We skip subchannels in state TRANSIENT_FAILURE to avoid a
@@ -1073,8 +1091,7 @@ void PickFirst::SubchannelList::MaybeFinishHappyEyeballsPass() {
                         ? ""
                         : "failed to connect to all addresses; last error: "),
                    last_failure_.ToString()));
-  policy_->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                       MakeRefCounted<TransientFailurePicker>(status));
+  ReportTransientFailure(std::move(status));
   // Drop the existing (working) connection, if any.  This may be
   // sub-optimal, but we can't ignore what the control plane told us.
   policy_->UnsetSelectedSubchannel();
@@ -1188,7 +1205,7 @@ class OldPickFirst final : public LoadBalancingPolicy {
 
     SubchannelList(RefCountedPtr<OldPickFirst> policy,
                    EndpointAddressesIterator* addresses,
-                   const ChannelArgs& args);
+                   const ChannelArgs& args, absl::string_view resolution_note);
 
     ~SubchannelList() override;
 
@@ -1211,6 +1228,8 @@ class OldPickFirst final : public LoadBalancingPolicy {
       return true;
     }
 
+    void ReportTransientFailure(absl::Status status);
+
    private:
     // Returns true if all subchannels have seen their initial
     // connectivity state notifications.
@@ -1235,6 +1254,7 @@ class OldPickFirst final : public LoadBalancingPolicy {
     RefCountedPtr<OldPickFirst> policy_;
 
     ChannelArgs args_;
+    std::string resolution_note_;
 
     // The list of subchannels.
     std::vector<SubchannelData> subchannels_;
@@ -1265,8 +1285,9 @@ class OldPickFirst final : public LoadBalancingPolicy {
   class HealthWatcher final
       : public SubchannelInterface::ConnectivityStateWatcherInterface {
    public:
-    explicit HealthWatcher(RefCountedPtr<OldPickFirst> policy)
-        : policy_(std::move(policy)) {}
+    HealthWatcher(RefCountedPtr<OldPickFirst> policy,
+                  absl::string_view resolution_note)
+        : policy_(std::move(policy)), resolution_note_(resolution_note) {}
 
     ~HealthWatcher() override {
       policy_.reset(DEBUG_LOCATION, "HealthWatcher dtor");
@@ -1281,6 +1302,7 @@ class OldPickFirst final : public LoadBalancingPolicy {
 
    private:
     RefCountedPtr<OldPickFirst> policy_;
+    std::string resolution_note_;
   };
 
   class Picker final : public SubchannelPicker {
@@ -1402,18 +1424,16 @@ void OldPickFirst::AttemptToConnectUsingLatestUpdateArgsLocked() {
               << latest_pending_subchannel_list_.get();
   }
   latest_pending_subchannel_list_ = MakeOrphanable<SubchannelList>(
-      RefAsSubclass<OldPickFirst>(), addresses, latest_update_args_.args);
+      RefAsSubclass<OldPickFirst>(), addresses, latest_update_args_.args,
+      latest_update_args_.resolution_note);
   // Empty update or no valid subchannels.  Put the channel in
   // TRANSIENT_FAILURE and request re-resolution.
   if (latest_pending_subchannel_list_->size() == 0) {
     channel_control_helper()->RequestReresolution();
-    absl::Status status =
-        latest_update_args_.addresses.ok()
-            ? absl::UnavailableError(absl::StrCat(
-                  "empty address list: ", latest_update_args_.resolution_note))
-            : latest_update_args_.addresses.status();
-    UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                MakeRefCounted<TransientFailurePicker>(status));
+    absl::Status status = latest_update_args_.addresses.ok()
+                              ? absl::UnavailableError("empty address list")
+                              : latest_update_args_.addresses.status();
+    latest_pending_subchannel_list_->ReportTransientFailure(std::move(status));
   }
   // If the new update is empty or we don't yet have a selected subchannel in
   // the current list, replace the current subchannel list immediately.
@@ -1551,12 +1571,17 @@ void OldPickFirst::HealthWatcher::OnConnectivityStateChange(
           new_state, absl::OkStatus(),
           MakeRefCounted<QueuePicker>(policy_->Ref()));
       break;
-    case GRPC_CHANNEL_TRANSIENT_FAILURE:
+    case GRPC_CHANNEL_TRANSIENT_FAILURE: {
+      std::string message = absl::StrCat("health watch: ", status.message());
+      if (!resolution_note_.empty()) {
+        absl::StrAppend(&message, " (", resolution_note_, ")");
+      }
       policy_->channel_control_helper()->UpdateState(
           GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-          MakeRefCounted<TransientFailurePicker>(absl::UnavailableError(
-              absl::StrCat("health watch: ", status.message()))));
+          MakeRefCounted<TransientFailurePicker>(
+              absl::UnavailableError(message)));
       break;
+    }
     case GRPC_CHANNEL_SHUTDOWN:
       Crash("health watcher reported state SHUTDOWN");
   }
@@ -1614,7 +1639,6 @@ void OldPickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
       << ", p->subchannel_list_=" << p->subchannel_list_.get()
       << ", p->latest_pending_subchannel_list_="
       << p->latest_pending_subchannel_list_.get();
-
   if (subchannel_list_->shutting_down_ || pending_watcher_ == nullptr) return;
   auto& stats_plugins = subchannel_list_->policy_->channel_control_helper()
                             ->GetStatsPluginGroup();
@@ -1658,10 +1682,9 @@ void OldPickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
             "selected subchannel failed; switching to pending update; "
             "last failure: ",
             p->subchannel_list_->last_failure_.ToString()));
-        p->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                       MakeRefCounted<TransientFailurePicker>(status));
+        subchannel_list_->ReportTransientFailure(std::move(status));
       } else if (p->state_ != GRPC_CHANNEL_TRANSIENT_FAILURE) {
-        p->UpdateState(GRPC_CHANNEL_CONNECTING, absl::Status(),
+        p->UpdateState(GRPC_CHANNEL_CONNECTING, absl::OkStatus(),
                        MakeRefCounted<QueuePicker>(nullptr));
       }
       return;
@@ -1670,7 +1693,7 @@ void OldPickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
     p->UnsetSelectedSubchannel();
     p->subchannel_list_.reset();
     p->UpdateState(
-        GRPC_CHANNEL_IDLE, absl::Status(),
+        GRPC_CHANNEL_IDLE, absl::OkStatus(),
         MakeRefCounted<QueuePicker>(p->Ref(DEBUG_LOCATION, "QueuePicker")));
     return;
   }
@@ -1767,8 +1790,7 @@ void OldPickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
                    ? ""
                    : "failed to connect to all addresses; last error: "),
               connectivity_status_.ToString()));
-          p->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                         MakeRefCounted<TransientFailurePicker>(status));
+          subchannel_list_->ReportTransientFailure(std::move(status));
         }
       }
       break;
@@ -1786,7 +1808,7 @@ void OldPickFirst::SubchannelList::SubchannelData::OnConnectivityStateChange(
       // already in TRANSIENT_FAILURE.
       if (subchannel_list_ == p->subchannel_list_.get() &&
           p->state_ != GRPC_CHANNEL_TRANSIENT_FAILURE) {
-        p->UpdateState(GRPC_CHANNEL_CONNECTING, absl::Status(),
+        p->UpdateState(GRPC_CHANNEL_CONNECTING, absl::OkStatus(),
                        MakeRefCounted<QueuePicker>(nullptr));
       }
       break;
@@ -1878,14 +1900,15 @@ void OldPickFirst::SubchannelList::SubchannelData::
     GRPC_TRACE_LOG(pick_first, INFO)
         << "[PF " << p << "] starting health watch";
     auto watcher = std::make_unique<HealthWatcher>(
-        p->RefAsSubclass<OldPickFirst>(DEBUG_LOCATION, "HealthWatcher"));
+        p->RefAsSubclass<OldPickFirst>(DEBUG_LOCATION, "HealthWatcher"),
+        subchannel_list_->resolution_note_);
     p->health_watcher_ = watcher.get();
     auto health_data_watcher = MakeHealthCheckWatcher(
         p->work_serializer(), subchannel_list_->args_, std::move(watcher));
     p->health_data_watcher_ = health_data_watcher.get();
     subchannel_->AddDataWatcher(std::move(health_data_watcher));
   } else {
-    p->UpdateState(GRPC_CHANNEL_READY, absl::Status(),
+    p->UpdateState(GRPC_CHANNEL_READY, absl::OkStatus(),
                    MakeRefCounted<Picker>(subchannel()->Ref()));
   }
   // Unref all other subchannels in the list.
@@ -1902,13 +1925,14 @@ void OldPickFirst::SubchannelList::SubchannelData::
 
 OldPickFirst::SubchannelList::SubchannelList(
     RefCountedPtr<OldPickFirst> policy, EndpointAddressesIterator* addresses,
-    const ChannelArgs& args)
+    const ChannelArgs& args, absl::string_view resolution_note)
     : InternallyRefCounted<SubchannelList>(
           GRPC_TRACE_FLAG_ENABLED(pick_first) ? "SubchannelList" : nullptr),
       policy_(std::move(policy)),
-      args_(args.Remove(GRPC_ARG_INTERNAL_PICK_FIRST_ENABLE_HEALTH_CHECKING)
-                .Remove(
-                    GRPC_ARG_INTERNAL_PICK_FIRST_OMIT_STATUS_MESSAGE_PREFIX)) {
+      args_(
+          args.Remove(GRPC_ARG_INTERNAL_PICK_FIRST_ENABLE_HEALTH_CHECKING)
+              .Remove(GRPC_ARG_INTERNAL_PICK_FIRST_OMIT_STATUS_MESSAGE_PREFIX)),
+      resolution_note_(resolution_note) {
   GRPC_TRACE_LOG(pick_first, INFO)
       << "[PF " << policy_.get() << "] Creating subchannel list " << this
       << " - channel args: " << args_.ToString();
@@ -1960,6 +1984,15 @@ void OldPickFirst::SubchannelList::ResetBackoffLocked() {
   }
 }
 
+void OldPickFirst::SubchannelList::ReportTransientFailure(absl::Status status) {
+  if (!resolution_note_.empty()) {
+    status = absl::Status(status.code(), absl::StrCat(status.message(), " (",
+                                                      resolution_note_, ")"));
+  }
+  policy_->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
+                       MakeRefCounted<TransientFailurePicker>(status));
+}
+
 void OldPickFirst::SubchannelList::StartConnectingNextSubchannel() {
   // Find the next subchannel not in state TRANSIENT_FAILURE.
   // We skip subchannels in state TRANSIENT_FAILURE to avoid a
@@ -2012,8 +2045,7 @@ void OldPickFirst::SubchannelList::MaybeFinishHappyEyeballsPass() {
                           ? ""
                           : "failed to connect to all addresses; last error: "),
                      last_failure_.ToString()));
-    policy_->UpdateState(GRPC_CHANNEL_TRANSIENT_FAILURE, status,
-                         MakeRefCounted<TransientFailurePicker>(status));
+    ReportTransientFailure(std::move(status));
   }
   // We now transition into a mode where we try to connect to all
   // subchannels in parallel.  For any subchannel currently in IDLE,
@@ -2025,6 +2057,7 @@ void OldPickFirst::SubchannelList::MaybeFinishHappyEyeballsPass() {
     }
   }
 }
+
 //
 // factory
 //