Add support for multiple formats of ORCA headers. (#35894)

Commit Message: Add support for multiple formats of ORCA headers. Additional Description: Add support for multiple formats of ORCA headers. ORCA parsing introduced in #35422 [Original Design Proposal](#6614) [Using ORCA load reports in Envoy](https://docs.google.com/document/d/1gb_2pcNnEzTgo1EJ6w1Ol7O-EH-O_Ysu5o215N9MTAg/edit#heading=h.bi4e79pb39fe) Risk Level: Low Testing: See included unit tests. Docs Changes: N/A Release Notes: N/A Platform Specific Features: JSON format unsupported on Mobile. CC @efimki @adisuissa @wbpcode --------- Signed-off-by: blake-snyder <[email protected]>
envoyproxy · Oct 5, 2024 · 33679e4 · 33679e4
1 parent 16cd72e
commit 33679e4
Show file tree

Hide file tree

Showing 4 changed files with 354 additions and 15 deletions.
diff --git a/source/common/orca/BUILD b/source/common/orca/BUILD
@@ -13,8 +13,11 @@ envoy_cc_library(
     srcs = ["orca_parser.cc"],
     hdrs = ["orca_parser.h"],
     deps = [
+        "//envoy/common:exception_lib",
         "//envoy/http:header_map_interface",
         "//source/common/common:base64_lib",
+        "//source/common/http:header_utility_lib",
+        "//source/common/protobuf:utility_lib_header",
         "@com_github_cncf_xds//xds/data/orca/v3:pkg_cc_proto",
         "@com_github_fmtlib_fmt//:fmtlib",
         "@com_google_absl//absl/status:statusor",

diff --git a/source/common/orca/orca_parser.cc b/source/common/orca/orca_parser.cc
@@ -1,13 +1,27 @@
 #include "source/common/orca/orca_parser.h"
 
+#include <cmath>
+#include <cstddef>
 #include <string>
+#include <utility>
+#include <vector>
 
+#include "envoy/common/exception.h"
 #include "envoy/http/header_map.h"
 
 #include "source/common/common/base64.h"
 #include "source/common/common/fmt.h"
+#include "source/common/http/header_utility.h"
+#include "source/common/protobuf/utility.h"
 
+#include "absl/container/flat_hash_set.h"
+#include "absl/status/status.h"
+#include "absl/strings/match.h"
+#include "absl/strings/numbers.h"
+#include "absl/strings/str_cat.h"
+#include "absl/strings/str_split.h"
 #include "absl/strings/string_view.h"
+#include "absl/strings/strip.h"
 
 using ::Envoy::Http::HeaderMap;
 using xds::data::orca::v3::OrcaLoadReport;
@@ -17,29 +31,147 @@ namespace Orca {
 
 namespace {
 
+const Http::LowerCaseString& endpointLoadMetricsHeader() {
+  CONSTRUCT_ON_FIRST_USE(Http::LowerCaseString, kEndpointLoadMetricsHeader);
+}
+
 const Http::LowerCaseString& endpointLoadMetricsHeaderBin() {
   CONSTRUCT_ON_FIRST_USE(Http::LowerCaseString, kEndpointLoadMetricsHeaderBin);
 }
 
+absl::Status tryCopyNamedMetricToOrcaLoadReport(absl::string_view metric_name, double metric_value,
+                                                OrcaLoadReport& orca_load_report) {
+  if (metric_name.empty()) {
+    return absl::InvalidArgumentError("named metric key is empty.");
+  }
+
+  orca_load_report.mutable_named_metrics()->insert({std::string(metric_name), metric_value});
+  return absl::OkStatus();
+}
+
+std::vector<absl::string_view> parseCommaDelimitedHeader(const absl::string_view entry) {
+  std::vector<absl::string_view> values;
+  std::vector<absl::string_view> tokens =
+      Envoy::Http::HeaderUtility::parseCommaDelimitedHeader(entry);
+  values.insert(values.end(), tokens.begin(), tokens.end());
+  return values;
+}
+
+absl::Status tryCopyMetricToOrcaLoadReport(absl::string_view metric_name,
+                                           absl::string_view metric_value,
+                                           OrcaLoadReport& orca_load_report) {
+  if (metric_name.empty()) {
+    return absl::InvalidArgumentError("metric names cannot be empty strings");
+  }
+
+  if (metric_value.empty()) {
+    return absl::InvalidArgumentError("metric values cannot be empty strings");
+  }
+
+  double value;
+  if (!absl::SimpleAtod(metric_value, &value)) {
+    return absl::InvalidArgumentError(fmt::format(
+        "unable to parse custom backend load metric value({}): {}", metric_name, metric_value));
+  }
+
+  if (std::isnan(value)) {
+    return absl::InvalidArgumentError(
+        fmt::format("custom backend load metric value({}) cannot be NaN.", metric_name));
+  }
+
+  if (std::isinf(value)) {
+    return absl::InvalidArgumentError(
+        fmt::format("custom backend load metric value({}) cannot be infinity.", metric_name));
+  }
+
+  if (absl::StartsWith(metric_name, kNamedMetricsFieldPrefix)) {
+    auto metric_name_without_prefix = absl::StripPrefix(metric_name, kNamedMetricsFieldPrefix);
+    return tryCopyNamedMetricToOrcaLoadReport(metric_name_without_prefix, value, orca_load_report);
+  }
+
+  if (metric_name == kCpuUtilizationField) {
+    orca_load_report.set_cpu_utilization(value);
+  } else if (metric_name == kMemUtilizationField) {
+    orca_load_report.set_mem_utilization(value);
+  } else if (metric_name == kApplicationUtilizationField) {
+    orca_load_report.set_application_utilization(value);
+  } else if (metric_name == kEpsField) {
+    orca_load_report.set_eps(value);
+  } else if (metric_name == kRpsFractionalField) {
+    orca_load_report.set_rps_fractional(value);
+  } else {
+    return absl::InvalidArgumentError(absl::StrCat("unsupported metric name: ", metric_name));
+  }
+  return absl::OkStatus();
+}
+
+absl::Status tryParseNativeHttpEncoded(const absl::string_view header,
+                                       OrcaLoadReport& orca_load_report) {
+  const std::vector<absl::string_view> values = parseCommaDelimitedHeader(header);
+
+  // Check for duplicate metric names here because OrcaLoadReport fields are not
+  // marked as optional and therefore don't differentiate between unset and
+  // default values.
+  absl::flat_hash_set<absl::string_view> metric_names;
+  for (const auto value : values) {
+    std::pair<absl::string_view, absl::string_view> entry =
+        absl::StrSplit(value, absl::MaxSplits(':', 1), absl::SkipWhitespace());
+    if (metric_names.contains(entry.first)) {
+      return absl::AlreadyExistsError(
+          absl::StrCat(kEndpointLoadMetricsHeader, " contains duplicate metric: ", entry.first));
+    }
+    RETURN_IF_NOT_OK(tryCopyMetricToOrcaLoadReport(entry.first, entry.second, orca_load_report));
+    metric_names.insert(entry.first);
+  }
+  return absl::OkStatus();
+}
+
+absl::Status tryParseSerializedBinary(const absl::string_view header,
+                                      OrcaLoadReport& orca_load_report) {
+  if (header.empty()) {
+    return absl::InvalidArgumentError("ORCA binary header value is empty");
+  }
+  const std::string decoded_value = Envoy::Base64::decode(header);
+  if (decoded_value.empty()) {
+    return absl::InvalidArgumentError(
+        fmt::format("unable to decode ORCA binary header value: {}", header));
+  }
+  if (!orca_load_report.ParseFromString(decoded_value)) {
+    return absl::InvalidArgumentError(
+        fmt::format("unable to parse binaryheader to OrcaLoadReport: {}", header));
+  }
+  return absl::OkStatus();
+}
+
 } // namespace
 
 absl::StatusOr<OrcaLoadReport> parseOrcaLoadReportHeaders(const HeaderMap& headers) {
   OrcaLoadReport load_report;
 
-  // Binary protobuf format.
+  // Binary protobuf format. Legacy header from gRPC implementation.
   if (const auto header_bin = headers.get(endpointLoadMetricsHeaderBin()); !header_bin.empty()) {
     const auto header_value = header_bin[0]->value().getStringView();
-    if (header_value.empty()) {
-      return absl::InvalidArgumentError("ORCA binary header value is empty");
-    }
-    const std::string decoded_value = Envoy::Base64::decode(header_value);
-    if (decoded_value.empty()) {
-      return absl::InvalidArgumentError(
-          fmt::format("unable to decode ORCA binary header value: {}", header_value));
-    }
-    if (!load_report.ParseFromString(decoded_value)) {
+    RETURN_IF_NOT_OK(tryParseSerializedBinary(header_value, load_report));
+  } else if (const auto header = headers.get(endpointLoadMetricsHeader()); !header.empty()) {
+    std::pair<absl::string_view, absl::string_view> split_header =
+        absl::StrSplit(header[0]->value().getStringView(), absl::MaxSplits(' ', 1));
+
+    if (split_header.first == kHeaderFormatPrefixBin) { // Binary protobuf format.
+      RETURN_IF_NOT_OK(tryParseSerializedBinary(split_header.second, load_report));
+    } else if (split_header.first == kHeaderFormatPrefixText) { // Native HTTP format.
+      RETURN_IF_NOT_OK(tryParseNativeHttpEncoded(split_header.second, load_report));
+    } else if (split_header.first == kHeaderFormatPrefixJson) { // JSON format.
+#if defined(ENVOY_ENABLE_FULL_PROTOS) && defined(ENVOY_ENABLE_YAML)
+      const std::string json_string = std::string(split_header.second);
+      bool has_unknown_field = false;
+      RETURN_IF_ERROR(
+          Envoy::MessageUtil::loadFromJsonNoThrow(json_string, load_report, has_unknown_field));
+#else
+      IS_ENVOY_BUG("JSON formatted ORCA header support not implemented for this build");
+#endif // !ENVOY_ENABLE_FULL_PROTOS || !ENVOY_ENABLE_YAML
+    } else {
       return absl::InvalidArgumentError(
-          fmt::format("unable to parse binaryheader to OrcaLoadReport: {}", header_value));
+          fmt::format("unsupported ORCA header format: {}", split_header.first));
     }
   } else {
     return absl::NotFoundError("no ORCA data sent from the backend");

diff --git a/source/common/orca/orca_parser.h b/source/common/orca/orca_parser.h
@@ -8,11 +8,24 @@
 namespace Envoy {
 namespace Orca {
 
-// Header used to send ORCA load metrics from the backend.
+// Headers used to send ORCA load metrics from the backend.
+static constexpr absl::string_view kEndpointLoadMetricsHeader = "endpoint-load-metrics";
 static constexpr absl::string_view kEndpointLoadMetricsHeaderBin = "endpoint-load-metrics-bin";
+// Prefix used to determine format expected in kEndpointLoadMetricsHeader.
+static constexpr absl::string_view kHeaderFormatPrefixBin = "BIN";
+static constexpr absl::string_view kHeaderFormatPrefixJson = "JSON";
+static constexpr absl::string_view kHeaderFormatPrefixText = "TEXT";
+// The following fields are the names of the metrics tracked in the ORCA load
+// report proto.
+static constexpr absl::string_view kApplicationUtilizationField = "application_utilization";
+static constexpr absl::string_view kCpuUtilizationField = "cpu_utilization";
+static constexpr absl::string_view kMemUtilizationField = "mem_utilization";
+static constexpr absl::string_view kEpsField = "eps";
+static constexpr absl::string_view kRpsFractionalField = "rps_fractional";
+static constexpr absl::string_view kNamedMetricsFieldPrefix = "named_metrics.";
 
 // Parses ORCA load metrics from a header map into an OrcaLoadReport proto.
-// Supports serialized binary formats.
+// Supports native HTTP, JSON and serialized binary formats.
 absl::StatusOr<xds::data::orca::v3::OrcaLoadReport>
 parseOrcaLoadReportHeaders(const Envoy::Http::HeaderMap& headers);
 } // namespace Orca