Adding Logging to API Deployments

Using the Console to Configure and Enable Logs in Oracle Cloud Infrastructure Logging

To configure and enable API deployment logs using the Console to store logs in Oracle Cloud Infrastructure Logging:

1. Create or update an API deployment using the Console, select the From Scratch option, and enter details on the Basic Information page.

   For more information, see Deploying an API on an API Gateway by Creating an API Deployment and Updating an API Gateway or an API Deployment.

2. In the API Logging Policies section of the Basic Information page, specify one of the following options as the Execution Log Level to record information about processing within the API gateway:

   • Information: Record a summary of every processing stage. This is the default option.
   • Warning: Record only transient errors that occur during processing. For example, a connection reset.
   • Error: Record only persistent errors that occur during processing. For example, an internal error, or a call to a function that returns a 404 message.

3. Click Next twice to enter details for individual routes in the API deployment on the Routes page and click Show Route Logging Policies.

4. Specify one of the following options as the Execution Log Level Override that applies to an individual route (to override the execution log level inherited from the API deployment):

   • Information: Record a summary of every processing stage.
   • Warning: Record only transient errors that occur during processing. For example, a connection reset.
   • Error: Record only persistent errors that occur during processing. For example, an internal error, or a call to a function that returns a 404 message.
5. Click Next to review the details you entered for the API deployment.
6. Click Create or Save Changes to create or update the API deployment.

   The API deployment is shown on the API Deployment Details page.

7. Under Resources, click Logs, and then click the Enable Logging slider to create and enable a new API deployment log in the Oracle Cloud Infrastructure Logging service in the Create Log entry panel:
   • Compartment: By default, the current compartment.
   • Log Group: By default, the first log group in the compartment.
   • Log Category: Select either Execution or Access.
   • Log Name: By default, <deployment-name>_execution or <deployment-name>_access, depending on which category you select.

   For more information, see Enabling Logging for a Resource.

8. Click Enable Log to create the new log and enable it.

Editing a JSON File to Set Execution Log Level for Logs Stored in Oracle Cloud Infrastructure Logging

To edit the API deployment specification in a JSON file to set the log level for execution logs stored in Oracle Cloud Infrastructure Logging:

1. Using your preferred JSON editor, edit the existing API deployment specification in which you want to set the log level for execution logs stored in Oracle Cloud Infrastructure Logging, or create a new API deployment specification (see Creating an API Deployment Specification).

   At a minimum, the API deployment specification will include a routes section containing:

   • A path. For example, /hello
   • One or more methods. For example, GET
   • A definition of a back end. For example, a URL, or the OCID of a function in OCI Functions.

   For example, the following basic API deployment specification defines a simple Hello World serverless function in OCI Functions as a single back end:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

2. (Optional) To set the log level for execution logs that applies globally to all routes in the API deployment specification:

   1. Insert a loggingPolicies section before the routes section. For example:

      
      {
        "loggingPolicies": {},
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

   2. Specify the level of detail to record about processing within the API gateway for all routes by including the executionLog policy in the loggingPolicies section, and setting the logLevel property to one of the following:

      • INFO to record a summary of every processing stage.
      • WARN to record only transient errors that occur during processing. For example, a connection reset.
      • ERROR to record only persistent errors that occur during processing. For example, an internal error, or a call to a function that returns a 404 message.

      For example:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

3. (Optional) To set the log level for execution logs for a particular route (overriding the global execution log level inherited from the API deployment):

   1. Insert a loggingPolicies section after the route's backend section. For example:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "loggingPolicies": {}
          }
        ]
      }

   2. Specify the level of detail to record about processing within the API gateway for the route by including the executionLog policy in the loggingPolicies section, and setting the logLevel property to one of the following:

      • INFO to record a summary of every processing stage.
      • WARN to record only transient errors that occur during processing. For example, a connection reset.
      • ERROR to record only persistent errors that occur during processing. For example, an internal error, or a call to a function that returns a 404 message.

      For example:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "loggingPolicies": {
              "executionLog": {
                "logLevel": "ERROR"
              }
            }
          }
        ]
      }

4. Save the JSON file containing the API deployment specification.

5. Use the API deployment specification when you create or update an API deployment in the following ways:

   • by specifying the JSON file in the Console when you select the Upload an existing API option
   • by specifying the JSON file in a request to the API Gateway REST API

   For more information, see Deploying an API on an API Gateway by Creating an API Deployment.

6. Having set the log level for execution logs, follow the instructions in Enabling Logging for a Resource to create and enable a new API deployment log in the Oracle Cloud Infrastructure Logging service.

Viewing Logs in Oracle Cloud Infrastructure Logging

You can view the content of an API deployment log in Oracle Cloud Infrastructure Logging from the API Deployment Details page. Under Resources, click Logs, and then click the name of the log you want to view.

Alternatively, you can view the content of an API deployment log from the Oracle Cloud Infrastructure Logging Log Search page. See Getting a Log's Details.

For more information about the content of access and execution logs, see:

• API Deployment Access Log
• API Deployment Execution Log