Apigee hybrid audit logging information

You are currently viewing version 1.5 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

This document describes the audit logs created by Apigee hybrid as part ofCloud Audit Logs.

Overview

Google Cloud services write audit logs to help you answer the questions, "Whodid what, where, and when?" within your Google Cloud resources.

Your Cloud projects contain only the audit logs for resources that aredirectly within the Cloud project. Other Google Cloud resources,such as folders, organizations, and billing accounts, contain the audit logs forthe entity itself.

For a general overview of Cloud Audit Logs, seeCloud Audit Logs overview. For a deeper understandingof the audit log format, seeUnderstand audit logs.

Available audit logs

The following types of audit logs are available for Apigee hybrid:

  • Admin Activity audit logs

    Includes "admin write" operations that write metadata or configuration information.

    You can't disable Admin Activity audit logs.

  • Data Access audit logs

    Includes "admin read" operations that read metadata or configuration information. Also includes "data read" and "data write" operations that read or write user-provided data.

    You can't disable Data Access audit logs. However, you candisable the_Default sink for Cloud Logging, which prevents these audit logs from being stored.

For fuller descriptions of the audit log types, seeTypes of audit logs.

Audited operations

The following table summarizes which API operations correspond to each audit logtype in Apigee hybrid:

Audit logs categoryApigee hybrid operations
Admin Activity audit logsCREATE
UPDATE
DELETE
Data Access audit logsGET
LIST

Audit log format

Audit log entries include the following objects:

  • The log entry itself, which is an object of typeLogEntry.Useful fields include the following:

    • ThelogName contains the resource ID and audit log type. The resourceis a project, folder, organization, or billing account.
    • Theresource contains the target of the audited operation.
    • ThetimeStamp contains the time of the audited operation.
    • TheprotoPayload contains the audited information.

  • The audit logging data, which is anAuditLog object held intheprotoPayload field of the log entry.

    • The@type field is set to"type.googleapis.com/google.cloud.audit.AuditLog".
    • TheserviceName field identifies the service that wrote theaudit log. The format of this field is service specific.

  • Optional service-specific audit information, which is a service-specificobject. For earlier integrations, this object is held in theserviceDatafield of theAuditLog object; later integrations use themetadata field.

For other fields in these objects, and how to interpret them, reviewUnderstand audit logs.

Log name

Cloud Audit Logs log names include resource identifiers indicating theCloud project or other Google Cloud entity that owns the auditlogs, and whether the log contains Admin Activity, Data Access, Policy Denied,or System Event audit logging data.

The following are the audit log names, including variables for the resourceidentifiers:

   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fdata_access   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fpolicy   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Factivity   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fdata_access   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fsystem_event   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fpolicy   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Factivity   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Fdata_access   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Fpolicy   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Factivity   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fsystem_event   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fpolicy
Note: The part of the log name following/logs/ must be URL-encoded. Theforward-slash character,/, must be written as%2F.

Service name

Apigee hybrid audit logs use the service nameapigee.googleapis.com.

For a list of all the Cloud Logging API service names and their correspondingmonitored resource type, seeMap services to resources.

Resource types

Apigee hybrid audit logs use the resource typeaudited_resource for all audit logs.

For a list of all the Cloud Logging monitored resource types and descriptiveinformation, seeMonitored resource types.

Caller identities

The IP address of the caller is held in theRequestMetadata.caller_ip field oftheAuditLog object. Logging might redact certaincaller identities and IP addresses.

For information about what information is redacted in audit logs, seeCaller identities in audit logs.

Enable audit logging

Admin Activity audit logs are always enabled; you can't disable them.

Data Access audit logs are disabled by default and aren't written unlessexplicitly enabled (the exception is Data Access audit logs forBigQuery, which can't be disabled).

For information about enabling some or all of your Data Access audit logs, seeEnable Data Access audit logs.

Permissions and roles

IAM permissions and roles determine your ability toaccess audit logs data in Google Cloud resources.

When deciding whichLogging-specific permissions and rolesapply to your use case, consider the following:

  • The Logs Viewer role (roles/logging.viewer) gives you read-only access toAdmin Activity, Policy Denied, and System Event audit logs. If you have justthis role, you cannot view Data Access audit logs that are in the_Default bucket.

  • The Private Logs Viewer role(roles/logging.privateLogViewer) includes thepermissions contained inroles/logging.viewer, plus the ability to readData Access audit logs in the_Default bucket.

    Note that if these private logs are stored in user-defined buckets, then anyuser who has permissions to read logs in those buckets can read the privatelogs. For more information about log buckets, seeRouting and storage overview.

For more information about the IAM permissions and roles thatapply to audit logs data, seeAccess control with IAM.

View logs

You can query for all audit logs or you can query for logs by theiraudit log name. The audit log name includes theresource identifierof the Cloud project, folder, billing account, ororganization for which you want to view audit logging information.Your queries can specify indexedLogEntry fields.For more information about querying your logs, seeBuild queries in the Logs Explorer

The Logs Explorer lets you view filter individual log entries. If you wantto use SQL to analyze groups of log entries, then use theLog Analyticspage. For more information, see:

Most audit logs can be viewed in Cloud Logging by using theGoogle Cloud Console, the Google Cloud CLI, or the Logging API.However, for audit logs related to billing, you can only use theGoogle Cloud CLI or the Logging API.

Console

In the Google Cloud Console, you can use the Logs Explorerto retrieve your audit log entries for your Cloud project, folder,or organization:

Note: You can't view audit logs for Cloud Billing accounts in theGoogle Cloud Console. You must use the API or the gcloud CLI.

  1. In the Google Cloud console, go to theLogs Explorer page:

    Go toLogs Explorer

    If you use the search bar to find this page, then select the result whose subheading isLogging.

  2. Select an existing Cloud project, folder, or organization.

  3. To display all audit logs, enter either of the following queriesinto the query-editor field, and then clickRun query:

    logName:"cloudaudit.googleapis.com"
    protoPayload."@type"="type.googleapis.com/google.cloud.audit.AuditLog"

  4. To display the audit logs for a specific resource and audit log type,in theQuery builder pane, do the following:

    • InResource type, select the Google Cloud resource whoseaudit logs you want to see.

    • InLog name, select the audit log type that you want to see:

      • For Admin Activity audit logs, selectactivity.
      • For Data Access audit logs, selectdata_access.
      • For System Event audit logs, selectsystem_event.
      • For Policy Denied audit logs, selectpolicy.

    • ClickRun query.

    If you don't see these options, then there aren't any audit logs ofthat type available in the Cloud project, folder, ororganization.

    If you're experiencing issues when trying to view logs in theLogs Explorer, see thetroubleshootinginformation.

    For more information about querying by using the Logs Explorer, seeBuild queries in the Logs Explorer.

gcloud

The Google Cloud CLI provides a command-line interface to theLogging API. Supply a valid resource identifier in each of the lognames. For example, if your query includes aPROJECT_ID, then theproject identifier you supply must refer to the currently selectedCloud project.

To read your Cloud project-level audit log entries, runthe following command:

gcloud logging read "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com" \    --project=PROJECT_ID

To read your folder-level audit log entries, run the following command:

gcloud logging read "logName : folders/FOLDER_ID/logs/cloudaudit.googleapis.com" \    --folder=FOLDER_ID

To read your organization-level audit log entries, run the followingcommand:

gcloud logging read "logName : organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com" \    --organization=ORGANIZATION_ID

To read your Cloud Billing account-level audit log entries, run the following command:

gcloud logging read "logName : billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com" \    --billing-account=BILLING_ACCOUNT_ID

Add the--freshness flagto your command to read logs that are more than 1 day old.

For more information about using the gcloud CLI, seegcloud logging read.

REST

When building your queries, supply a valid resource identifier in each ofthe log names. For example, if your query includes aPROJECT_ID,then the project identifier you supply must refer to the currently selectedCloud project.

For example, to use the Logging API to view your project-levelaudit log entries, do the following:

  1. Go to theTry this API section in the documentation for theentries.list method.

  2. Put the following into theRequest body part of theTry thisAPI form. Clicking thisprepopulated formautomatically fills the request body, but you need to supply a validPROJECT_ID in each of the log names.

    {  "resourceNames": [    "projects/PROJECT_ID"  ],  "pageSize": 5,  "filter": "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com"}

  3. ClickExecute.

For example, to view all the project-level audit logs forApigee hybrid, use the following query, supplying a valid resourceidentifier in each of the log names:

logName="projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity"OR"projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fdata_access"protoPayload.serviceName="apigee.googleapis.com"

Route audit logs

You canroute audit logs to supporteddestinations in the same way that you can route other kinds of logs. Here aresome reasons you might want to route your audit logs:

  • To keep audit logs for a longer period of time or to use more powerfulsearch capabilities, you can route copies of your audit logs toCloud Storage, BigQuery, or Pub/Sub. UsingPub/Sub, you can route to other applications, otherrepositories, and to third parties.

  • To manage your audit logs across an entire organization, you can createaggregated sinks that canroute logs from any or all Cloud projects in the organization.

  • If your enabled Data Access audit logs are pushing yourCloud projects over your log allotments, you can create sinks thatexclude the Data Access audit logs from Logging.

For instructions about routing logs, seeRoute logs to supported destinations.

Pricing

For more information about pricing, see the Cloud Logging sections in theGoogle Cloud Observability pricing page.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.