Trace entity

The Trace entity is a JSON object that has the same format as the events returned by the Abiquo API with the Event Media Type.

Changes to this media type will be documented in the API changelog. To go directly to the changelog between versions, enter the from and to versions in the URL as shown in the following example:

https://wiki.abiquo.com/api/changelog/4.7.0_to_5.1.0.html

The format of events in the Abiquo UI is also described in Events View and the events are described in the Events Table, which is updated for major versions of Abiquo.

 Click here to show/hide the Trace entity description

Trace entity attributes table

Attribute

Description

action

The action performed. To obtain a full list of current actions, list event types from the Events Resource in the Abiquo API.

context

The tracer context that the event belongs to. The platform assigns a single context ID to related events

enterpriseName

Name of the current enterprise of the user who performed the action

enterpriseURI

URI of the current enterprise of the user who performed the action

entity

Entity type. To obtain a full list of current entities, list event types from the Events Resource in the Abiquo API.

entityEnterpriseName

Name of the enterprise that the entity belongs to

entityEnterpriseURI

URI of the enterprise that the entity belongs to

entityMediaType

Entity media type. See media types in the API documentation at https://wiki.abiquo.com/api/latest

entityName

Entity name

entityURI

Entity URI

errorCode

If the severity is ERROR or WARNING, then this optionally contains an Abiquo API error code, see API Error Code List

errorMessage

If the severity is ERROR or WARNING, then this optionally contains an Abiquo API error message, see API Error Code List

exception

If the severity is ERROR, then this optionally contains the Java exception

message

The message

severity

The severity

tags

Collection of tags that describes the entity

timestamp

The timestamp of the time when the event took place. Expressed in the number of milliseconds since the epoch of 1970-01-01T00:00:00Z

userName

Name of the user who performed the action

userURIURI of the user who performed the action


The platform streams events as trace entities. 

For example

{
   "action":"CREATE",
   "context":"024c42a6-a9a2-4fd8-906f-cf7df3f02371",
   "enterpriseName":"Abiquo",
   "enterpriseURI":"/api/admin/enterprises/1",
   "entity":"VIRTUAL_DATACENTER",
   "entityEnterpriseName":"Abiquo",
   "entityEnterpriseURI":"/api/admin/enterprises/1",
   "entityMediaType":"application/vnd.abiquo.virtualdatacenter+json",
   "entityName":"vmware_vdc",
   "entityURI":"/api/cloud/virtualdatacenters/4",
   "errorCode":null,
   "errorMessage":null,
   "exception":null,
   "message":"Virtual datacenter 'vmware_vdc' has been created.",
   "severity":"INFO",
   "tags":[
      "virtualdatacenter:4",
      "user:1",
      "enterprise:1"
   ],
   "timestamp":1573130105514,
   "userName":"admin",
   "userURI":"/api/admin/enterprises/1/users/1"
}

Copyright © 2006-2022, Abiquo Holdings SL. All rights reserved