無法設定部署錯誤

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

問題

透過 Edge UI 或 Management API 部署 API Proxy 或共用流程修訂版本時,會發生「設定失敗」錯誤。

錯誤訊息

Edge UI 會顯示錯誤訊息,如下所示:

The revision is deployed, but traffic cannot flow.
com.apigee.kernel.exceptions.spi.UncheckedException{ code = application.bootstrap.FailedToConfigure, message = Configuration failed, associated contexts = []}

以下是在 Edge 使用者介面中觀察到的錯誤訊息範例螢幕截圖:

可能原因

API Proxy 部署作業可能會因許多不同原因而失敗,並顯示「設定失敗」錯誤。下表列出導致這項錯誤的幾項常見原因:

原因 說明 適用於以下裝置的疑難排解說明
JavaCallout 政策中缺少 Java 類別 JavaCallout 政策參照的 JAR 檔案缺少 Java 類別。 Edge Private Cloud 使用者
條件流程中的條件使用不正確的運算元 條件中運算子一側或兩側使用的運算元/運算式無效。
訊息記錄政策中的主機名稱無效 MessageLogging 政策中使用的主機名稱無法解析,或可能含有某些不必要的特殊字元。
Invalid KeyValueMap Name API Proxy 的 KeyValueMapOperations 政策中,KeyValueMap 無效或空白。

常見診斷步驟

  1. 使用下列 API,取得您觀察到部署錯誤的特定 API Proxy 修訂版本的部署狀態:

    curl -v <management-server-host>:<port#>/v1/runtime/organizations/<org-name>/environments/<env-name>/apis/<apiproxy-name>/revisions/deployments -u <user>
    
  2. 以下是上述 API 的輸出範例;

    "server" : [ { 
    "error" : "com.apigee.kernel.exceptions.spi.UncheckedException{ code = application.bootstrap.FailedToConfigure, message = Configuration failed, associated contexts = []}", 
    "status" : "error", 
    "type" : [ "message-processor" ], 
    "uUID" : "0a20926c-f4bf-401b-af84-05fd84b9f492" 
    }, { 
    "error" : "com.apigee.kernel.exceptions.spi.UncheckedException{ code = application.bootstrap.FailedToConfigure, message = Configuration failed, associated contexts = []}", 
    "status" : "error", 
    "type" : [ "message-processor" ], 
    "uUID" : "f2ee6ab4-a108-4465-a7ba-b56530d8e3fc" 
    }, { 
    "error" : "com.apigee.kernel.exceptions.spi.UncheckedException{ code = application.bootstrap.FailedToConfigure, message = Configuration failed, associated contexts = []}", 
    "status" : "error", 
    "type" : [ "message-processor" ], 
    "uUID" : "0f41991e-b310-4e77-aac5-5fdb150ef9f6" 
    },
    
  3. 部署狀態輸出內容中,每個訊息處理器都會顯示「設定失敗」錯誤訊息。

  4. 登入其中一個訊息處理器,然後檢查記錄 /opt/apigee/var/log/edge-message-processor/logs/system.log。查看部署 API Proxy 時是否發生任何錯誤。

  5. 根據訊息處理器記錄檔中觀察到的錯誤/例外狀況,您需要按照適當的疑難排解步驟操作,並解決問題。

  6. 以下各節列出最常導致「設定失敗」部署錯誤的例外狀況,並提供疑難排解和解決步驟。

原因:JavaCallout 政策中缺少 Java 類別

診斷

  1. 在訊息處理器記錄中,如果在部署 API Proxy (DeployEvent) 時看到任何例外狀況,且訊息為「Failed to instantiate the JavaCallout Class」(無法例項化 JavaCallout 類別),如下所示,請繼續執行步驟 2。如果不是,請參閱「條件流程中條件使用的運算元不正確」。
  2. 部署 API Proxy 時,訊息處理器會顯示下列例外狀況:

    2017-10-10 05:02:42,330 Apigee-Main-5 ERROR MESSAGING.CONFIGURATION - MessageProcessorServiceImpl.configure() : error configuring config events [DeployEvent{organization='myorg', application='oauth2', applicationRevision='14', deploymentSpec=basepath=/;env=dev;, deploymentID=null}] 
    com.apigee.kernel.exceptions.spi.UncheckedException: Failed to instantiate the JavaCallout Class com.something.apigee.callout.crypto.main.SecretCallout 
    at com.apigee.steps.javacallout.JavaCalloutStepDefinition.newInstance(JavaCalloutStepDefinition.java:89) ~[javacallout-1.0.0.jar:na] 
    at com.apigee.messaging.runtime.StepDefinition.getStepDefinitionExecution(StepDefinition.java:230) ~[message-processor-1.0.0.jar:na] 
    
    <snipped>
    
  3. 上述例外狀況中的錯誤訊息指出,JavaCallout 類別 com.something.apigee.callout.crypto.main.SecretCallout 無法例項化。如果 JavaCallout 政策中指定的 JAR 檔案或任何依附的 JAR 檔案沒有特定類別,通常就會發生這個錯誤。

  4. 檢查包含與套件 com.something.apigee.callout.crypto.main 相關所有類別的 JAR 檔案,並確認缺少特定類別 com.something.apigee.callout.crypto.main.SecretCallout

解析度

  1. 將缺少的類別新增至特定 JAR 檔案,然後上傳該 JAR 檔案。
  2. 重新部署 API Proxy。
  3. 在上述範例中,我們透過下列方式解決問題:
    1. 將缺少的 com.something.apigee.callout.crypto.main.SecretCallout 類別新增至 JAR 檔案。
    2. 上傳更新後的 JAR 檔案,然後重新部署 API Proxy。

原因:在條件流程中,運算子使用的運算元不正確

診斷

  1. 在訊息處理器記錄中,如果看到 com.apigee.expressions.parser.ParseException ,表示您在部署 API Proxy 或共用流程時發生錯誤 (如下方範例訊息所示),請繼續執行步驟 2。如果不是,請前往下一個原因:Message Logging 政策中的主機名稱無效

    錯誤訊息範例

    com.apigee.expressions.parser.ParseException: Both the operands for EQUALS expression should be data expressions
    
    
  2. 讓我們來看一個範例,瞭解如何診斷這個問題。

    範例:<Operator> 運算式的運算元應為資料運算式

  3. 部署共用流程時,訊息處理器會顯示下列例外狀況:

    2017-11-23 09:11:04,498  Apigee-Main-6 ERROR MESSAGING.RUNTIME - AbstractConfigurator.loadXMLConfigurations() : Unable to Load default for path /organizations/myorg/apiproxies/Introspection/revisions/12/sharedflows/default
    2017-11-23 09:11:04,499  Apigee-Main-6 ERROR MESSAGING.RUNTIME - Application.sync() :  sync error for Introspection and revision 12
    2017-11-23 09:11:04,499  Apigee-Main-6 ERROR MESSAGING.RUNTIME - Application.sync() :  Actual Error
    com.apigee.expressions.parser.ParseException: Both the operands for EQUALS expression should be data expressions
        at com.apigee.expressions.parser.ExpressionParser.buildExpressionTree(ExpressionParser.java:337) ~[expressions-1.0.0.jar:na]
        at com.apigee.expressions.parser.ExpressionParser.parse(ExpressionParser.java:24) ~[expressions-1.0.0.jar:na]
        at com.apigee.expressions.parser.ExpressionParser.parseLogicExpression(ExpressionParser.java:28) ~[expressions-1.0.0.jar:na]
        at com.apigee.messaging.runtime.Step.getExpression(Step.java:67) ~[message-processor-1.0.0.jar:na]
        at com.apigee.messaging.runtime.Step.handleAdd(Step.java:58) ~[message-processor-1.0.0.jar:na]
        at com.apigee.messaging.runtime.SharedFlowRuntime.addStep(SharedFlowRuntime.java:81) ~[message-processor-1.0.0.jar:na]  <snipped>
    
  4. ParseException 中的錯誤訊息「Both the operands for EQUALS expression should be data expressions」表示涉及等於 (=)、不等於 (!=) 或 Stats with (=|) 運算子的條件有問題。

  5. 查看所有涉及錯誤訊息中特定運算子的條件流程,確認是否有下列任何問題:

    1. 運算子兩側的運算式類型相同。舉例來說,如果運算子左側有字串變數,右側就必須有另一個字串變數或字串值。
    2. 運算子之間使用有效變數。
    3. 運算子與每個運算式之間都有空格。

  6. 如果不符合上述任一條件,就會收到 ParseException -「Both the operands for EQUALS expression should be data expressions」。

  7. 讓我們看一個例子,瞭解這個問題。以下是可能導致錯誤的條件範例:

    <Condition>
               (fault.name = "invalid_access_token") or(fault.name = "ApiKeyNotApproved")
    </Condition>
    
  8. 在本範例中,您會發現「or」運算子和下一個條件之間沒有空格。因此在剖析第二個條件時,第一個運算式會視為 EQUALS 運算子的 「or(fault.name」。這不是有效的變數名稱,因此系統不會將其視為有效的資料運算式。因此您會收到這項例外狀況:

    com.apigee.expressions.parser.ParseException: Both the operands for EQUALS expression should be data expressions
    
    

解析度

  1. 請確保運算子兩側一律有適當的資料運算式。
  2. 在上述範例中,解決方法是確保「or」運算子後方有空格,如程式碼片段所示:

    <Condition>
               (fault.name = "invalid_access_token") or (fault.name = "ApiKeyNotApproved")
    </Condition>
    
    

MessageLogging 政策中的主機名稱無效

診斷

  1. 在訊息處理器記錄中,如果部署 API Proxy 或共用流程時出現任何例外狀況,且訊息為「Invalid HostName」(無效的主機名稱),如以下所示,請繼續執行步驟 2。如果不是,請前往下一個原因「KeyValueMap 名稱無效」

    com.apigee.rest.framework.ValidationException: Invalid syslog config: Invalid HostName 'splunkprod.myorg.com/' for Syslog handler
    
  2. 請參閱以下兩個範例,瞭解如何排解及解決這個問題。

示例 1:HostName 含有不必要的特殊字元

  1. 部署 API Proxy 時,訊息處理器會顯示下列例外狀況:

      2018-01-20 02:12:13,535 Apigee-Main-3 ERROR MESSAGING.CONFIGURATION - MessageProcessorServiceImpl.configure() : error configuring config events [DeployEvent{organization='myorg', application='providersearch', applicationRevision='4', deploymentSpec=basepath=/;env=prod;, deploymentID=null}] 
      com.apigee.rest.framework.ValidationException: Invalid syslog config: Invalid HostName 'splunkprod.myorg.com/' for Syslog handler 
      at com.apigee.messaging.runtime.destinations.SyslogDestination.<init>(SyslogDestination.java:44) ~[message-processor-1.0.0.jar:na] 
      at com.apigee.messaging.runtime.destinations.SysLoggerFactory.getInstance(SysLoggerFactory.java:39) ~[message-processor-1.0.0.jar:na]
      at com.apigee.messaging.runtime.destinations.DestinationRegistry.newDestination(DestinationRegistry.java:44) ~[message-processor-1.0.0.jar:na] 
      ...<snipped>
    
  2. 上述例外狀況顯示,由於「Invalid HostName '<hostname>' for Syslog handler」,部署作業失敗。這表示「MessageLogging」MessageLogging政策中使用的 HostName 無效。

  3. 仔細檢查訊息處理器記錄中的例外狀況,會發現 HostName 結尾有不必要的特殊字元「/」'splunkprod.myorg.com/'.

  4. 這個不必要的特殊字元是導致部署錯誤的原因。

解析度

  1. 修改 MessageLogging 政策,移除所有不必要的特殊字元,即可解決問題。
  2. 在上述範例中,訊息記錄政策已移除特殊字元「/」。問題已解決。

範例 2:無法解析的主機名稱

  1. 訊息處理器記錄檔有幾行顯示 API Proxy 的部署事件已觸發,隨後在部署 API Proxy 時發生例外狀況:

    2017-12-22 00:13:49,057 Apigee-Main-87446 INFO MESSAGING.CONFIGURATION - MessageProcessorServiceImpl.configure() : configuring [DeployEvent{organization='myorg', application='myapi', applicationRevision='42', deploymentSpec=basepath=/;env=dev;, deploymentID=null}] 
    
    2017-12-22 00:13:49,318 Apigee-Main-87446 ERROR c.a.p.h.d.DNSCachedAddress - DNSCachedAddress.refresh() : Unable to resolve host : input-prd.cloud.splunk.com: Name or service not known 
    
    2017-12-22 00:13:49,323 Apigee-Main-87446 ERROR MESSAGING.RUNTIME - AbstractConfigurator.handleUpdate() : Fatal error deploying proxy: {} 
    com.apigee.rest.framework.ValidationException: Invalid syslog config: Invalid HostName 'input-prd.cloud.splunk.com' for Syslog handler 
    at com.apigee.messaging.runtime.destinations.SyslogDestination.<init>(SyslogDestination.java:44) ~[message-processor-1.0.0.jar:na] 
    at com.apigee.messaging.runtime.destinations.SysLoggerFactory.getInstance(SysLoggerFactory.java:39) ~[message-processor-1.0.0.jar:na] 
    at com.apigee.messaging.runtime.destinations.DestinationRegistry.newDestination(DestinationRegistry.java:44) ~[message-processor-1.0.0.jar:na] 
    at com.apigee.steps.messagelogging.MessageLoggingStepDefinition.populateDestinations(MessageLoggingStepDefinition.java:118) ~[message-logging-1.0.0.jar:na] 
    at com.apigee.steps.messagelogging.MessageLoggingStepDefinition.handleAdd(MessageLoggingStepDefinition.java:99) ~[message-logging-1.0.0.jar:na] 
    
    <snipped> 
    
  2. 上述例外狀況顯示,由於「Invalid HostName '<hostname>' for Syslog handler」,部署作業失敗。

  3. 如果您詳閱例外狀況上方的行,會發現 Message Processor 無法解析 MessageLogging 政策中提供的主機名稱 'input-prd.cloud.splunk.com'

  4. 如要確認,請嘗試對訊息記錄政策中使用的主機名稱和通訊埠號碼執行 Telnet。

    1. 檢查 API Proxy 特定修訂版本中的 MessageLogging 政策,並驗證所用的主機名稱和通訊埠號碼。在上述範例中,API Proxy 名稱為 myapi,修訂版本為 42。

      MessageLogging 政策

        <MessageLogging async="false" continueOnError="false" enabled="true" name="Log-To-Splunk">
            <DisplayName>Log-To-Splunk</DisplayName>
            <Syslog>
                <Message>Message.id = {request.header.id}</Message>
                <Host>input-prd.cloud.splunk.com</Host>
                <Port>2900</Port>
                <Protocol>TCP</Protocol>
                <SSLInfo>
                    <Enabled>true</Enabled>
                </SSLInfo>
            </Syslog>
        </MessageLogging>
      
    2. 使用特定通訊埠 Telnet 至主機。在本例中,我們嘗試使用 Telnet,結果與訊息處理器記錄檔中看到的錯誤相同:

      telnet input-prd.cloud.splunk.com 2900 
      telnet: input-prd.cloud.splunk.com: Name or service not known 
      input-prd.cloud.splunk.com: Host name lookup failure
      
  5. 這清楚證明主機名稱無法解析。

解析度

  1. 修改 MessageLogging 政策,使用有效的主機名稱。

如果問題仍未解決,請參閱「必須收集的診斷資訊」。

原因:KeyValueMap 名稱無效

診斷

  1. 在訊息處理器記錄中,如果看到例外狀況,且訊息為「KeyValueMap name is invalid」(KeyValueMap 名稱無效),表示您在部署 API Proxy 或共用流程時發生問題 (如下所示),請繼續執行步驟 2。如果沒有,請參閱「必須收集診斷資訊」。

    com.apigee.rest.framework.ValidationException: Invalid syslog config: Invalid HostName 'splunkprod.myorg.com/' for Syslog handler
    
  2. 讓我們來看一個範例,瞭解如何排解及解決這個問題。

  3. 範例訊息處理器記錄:顯示例外狀況,訊息為「KeyValueMap name is invalid」,導致 API Proxy 部署期間發生錯誤

    2018-02-27 14:14:50,318  Apigee-Main-6 ERROR MESSAGING.RUNTIME - AbstractConfigurator.handleUpdate() : Fatal error deploying proxy: {}
    com.apigee.keyvaluemap.KeyValueMapApiException: KeyValueMap name  is invalid
            at com.apigee.keyvaluemap.service.legacy.KeyValueMapServiceImpl.validateMapName(KeyValueMapServiceImpl.java:125) ~[keyvaluemap-1.0.0.jar:na]
            at com.apigee.keyvaluemap.service.legacy.KeyValueMapServiceImpl.createOrUpdateKeyValueMap(KeyValueMapServiceImpl.java:185) ~[keyvaluemap-1.0.0.jar:na]
            at com.apigee.steps.keyvaluemapoperations.KeyValueMapOperationsStepDefinition.digest(KeyValueMapOperationsStepDefinition.java:180) ~[keyvaluemap-operations-1.0.0.jar:na]
            at com.apigee.steps.keyvaluemapoperations.KeyValueMapOperationsStepDefinition.handleAdd(KeyValueMapOperationsStepDefinition.java:197) ~[keyvaluemap-operations-1.0.0.jar:na]
            at com.apigee.entities.AbstractConfigurator.handleUpdate(AbstractConfigurator.java:130) [config-entities-1.0.0.jar:na]
            at com.apigee.messaging.runtime.Application.handleUpdate(Application.java:229) [message-processor-1.0.0.jar:na]
    
    2018-02-27 14:14:50,344  Apigee-Main-6 ERROR BOOTSTRAP - RuntimeConfigurationServiceImpl.dispatchToListeners() : RuntimeConfigurationServiceImpl.dispatchToListeners : Error occurred while dispatching the request DeployEvent{organization='myorg', application='CustomerAPI', applicationRevision='1', deploymentSpec=basepath=/;env=test;, deploymentID=null} to com.apigee.application.bootstrap.listeners.MessageProcessorBootstrapListener@5009d06e
    com.apigee.keyvaluemap.KeyValueMapApiException: KeyValueMap name  is invalid
            at com.apigee.keyvaluemap.service.legacy.KeyValueMapServiceImpl.validateMapName(KeyValueMapServiceImpl.java:125) ~[keyvaluemap-1.0.0.jar:na]
            at com.apigee.keyvaluemap.service.legacy.KeyValueMapServiceImpl.createOrUpdateKeyValueMap(KeyValueMapServiceImpl.java:185) ~[keyvaluemap-1.0.0.jar:na]
            at com.apigee.steps.keyvaluemapoperations.KeyValueMapOperationsStepDefinition.digest(KeyValueMapOperationsStepDefinition.java:180) ~[keyvaluemap-operations-1.0.0.jar:na]
            at com.apigee.steps.keyvaluemapoperations.KeyValueMapOperationsStepDefinition.handleAdd(KeyValueMapOperationsStepDefinition.java:197) ~[keyvaluemap-operations-1.0.0.jar:na]
            at com.apigee.entities.AbstractConfigurator.handleUpdate(AbstractConfigurator.java:130) ~[config-entities-1.0.0.jar:na]
            at com.apigee.messaging.runtime.Application.handleUpdate(Application.java:229) ~[message-processor-1.0.0.jar:na]
    
  4. 上述第二個例外狀況表示 API Proxy:CustomerAPI,修訂版本:1 發生部署錯誤。

  5. 檢查堆疊追蹤記錄時,您會發現執行 KeyValuMapOperations 政策時會擲回錯誤。

  6. 查看 API Proxy 套件,您會發現有一項 KeyValuMapOperations 政策,程式碼如下所示:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <KeyValueMapOperations async="false" continueOnError="false" enabled="true" name="Pulling-Keys" mapIdentifier="">
     <DisplayName>Pulling Keys</DisplayName>
     <Properties/>
     <ExclusiveCache>false</ExclusiveCache>
    
    
  7. 如上所示,表示 KeyValueMap 名稱的 mapIdentifier 為空字串。KeyValueMap 名稱不得為空字串。這就是導致部署錯誤的原因。

解析度

  1. 修改 KeyValueMapOperations 政策,為 KeyValueMap 設定適當的有效名稱。
  2. 在上例中,我們將 KeyValueMapOperations 的 KeyValueMap 名稱修改為「MyKeyValueMap」,解決了這個問題,如下所示:

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <KeyValueMapOperations async="false" continueOnError="false" enabled="true" name="Pulling-Keys" mapIdentifier="MyKeyValueMap">
        <DisplayName>Pulling Keys</DisplayName>
        <Properties/>
        <ExclusiveCache>false</ExclusiveCache>
    

必須收集診斷資訊

如果按照上述指示操作後問題仍未解決,請收集下列診斷資訊。請聯絡 Apigee Edge 支援團隊,並提供收集到的資訊。

  1. 指令輸出內容

    curl -v <management-server-host>:<port #>/v1/runtime/organizations/<org-name>/environments/<env-name>/apis/<apiproxy-name>/revisions/deployments -u <user>
    
  2. 訊息處理器記錄

    /opt/apigee/var/log/edge-message-processor/logs/system.log
    
  3. 詳細說明您已嘗試過 Playbook 中的哪些部分,以及任何其他有助於我們加快解決這個問題的洞察資訊。