Skip to main content

AuditService

Source and message fields. Error family: audit.

SearchAudit​

Newest first by time, then id.

  • Path: /backplane.console.v1.AuditService/SearchAudit.
  • Input: SearchAuditRequest; output: SearchAuditResponse; mode: unary.
  • Errors: audit + common.
  • Read/validation: safe to retry after a transient failure.
// client: AuditServiceClient; request: SearchAuditRequest; signal: AbortSignal
const response = await client.searchAudit(request, { signal });

AuditHistogram​

Records over time: buckets of equal width across the filter's range (from the first matching record when it has no start).

  • Path: /backplane.console.v1.AuditService/AuditHistogram.
  • Input: AuditHistogramRequest; output: AuditHistogramResponse; mode: unary.
  • Errors: audit + common.
  • Read/validation: safe to retry after a transient failure.
// client: AuditServiceClient; request: AuditHistogramRequest; signal: AbortSignal
const response = await client.auditHistogram(request, { signal });

AuditFields​

Attribute keys of the matching records, most frequent first.

  • Path: /backplane.console.v1.AuditService/AuditFields.
  • Input: AuditFieldsRequest; output: AuditFieldsResponse; mode: unary.
  • Errors: audit + common.
  • Read/validation: safe to retry after a transient failure.
// client: AuditServiceClient; request: AuditFieldsRequest; signal: AbortSignal
const response = await client.auditFields(request, { signal });

AuditFacets​

The most frequent values of fields over the matching records. A field's own conditions are left out of its values, so the other choices show.

  • Path: /backplane.console.v1.AuditService/AuditFacets.
  • Input: AuditFacetsRequest; output: AuditFacetsResponse; mode: unary.
  • Errors: audit + common.
  • Read/validation: safe to retry after a transient failure.
// client: AuditServiceClient; request: AuditFacetsRequest; signal: AbortSignal
const response = await client.auditFacets(request, { signal });