This article discusses the auditing capabilities and APIs that are available out of the box in Apigee Edge. Auditing is extremely important like any other component for a software or a platform. As an admin, you would want to know what are the different actions and events performed on the platform. In case of any issues, it is this feature that comes to the rescue or at least helps you track and narrow down the potential cause.
Using auditing, you can check not only the calls made but also check the entitlements for each calling user. It is very important that the admins understand this and use it correctly.
Below are the different aspects of Apigee Edge's out-of-the-box auditing capabilities:
The following information is logged as part of an audit:
Apigee Edge Auditing gives you different levels of auditing as well. Depending on the audit requirements, you can pull the audits appropriately. The different levels of auditing are:
Management API: http://docs.apigee.com/api/audits-0
Apigee Audit Documentation: http://docs.apigee.com/api-services/content/view-api-history
Audit on the Edge UI looks like
Great article, is there a retention period on audit logs?
Where this org history is stored ? Is it cassandra? and is there a retention period ?
Was this written before the official documentation came out? Because to me it looks like everything in this article can be found in the official documentation.
I am interested in finding out the retention period for audit entries, if it can be configured and if what is audited can be configured too.
But this information is missing from the official documentation too.
Audit logs are stored in a dedicated Cassandra DB keyspace "audit" and table called "audits". The audit entries are persisted forever and there is no job periodical activity to purge them by their age.
If needed for compliance, this can be added as a daily purge, using the timestamp field.
Audits schema is below:
audit.audits ( key text PRIMARY KEY, clientip text, id text, operation text, request text, requesturi text, response text, responsecode text, serverhostname text, serverip text, timestamp bigint, type text, user text, "x-forwarded-for" text )
Additionally, audits_ref reference table is below:
audit.audits_ref (
key text,
column1 'org.apache.cassandra.db.marshal.DynamicCompositeType(org.apache.cassandra.db.marshal.UTF8Type, org.apache.cassandra.db.marshal.LongType)',
value blob,
PRIMARY KEY (key, column1) )
how do i integrate this log with a syslog? Any community post? Surely others must have done it.
Hi, Is there a way we can see these History in logs ? I am looking for a way to see these updates getting stored at system level for monitoring ? Appreciate your assistance. Thanks