Xapi Project Docs

Prototype

Class: Observer

Describes an observer which will control observability activity in the Toolstack

Prototyped in:

XAPI 23.14.0 (23.14.0)

Fields

Prototype

(string → string) map attributes [RO/constructor]

Attributes that observer will add to the data they produce

Default value:	{}
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

string set components [RO/constructor]

The list of xenserver components the observer will broadcast. An empty list means all components

Default value:	{}
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

bool enabled [RO/constructor]

This denotes if the observer is enabled. true if it is enabled and false if it is disabled

Default value:	false
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

string set endpoints [RO/constructor]

The list of endpoints where data is exported to. Each endpoint is a URL or the string 'bugtool' refering to the internal logs

Default value:	{}
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

host ref set hosts [RO/constructor]

The list of hosts the observer is active on. An empty list means all hosts

Default value:	{}
Prototyped in:	XAPI 23.14.0 (23.14.0)

string name_description [RW]

a notes field containing human-readable description

Default value:	""
Published in:	XenServer 4.0 (rio)

string name_label [RW]

a human-readable name

Default value:	""
Published in:	XenServer 4.0 (rio)

Prototype

string uuid [RO/runtime]

Unique identifier/object reference

Prototyped in:

XAPI 23.14.0 (23.14.0)

Messages

Prototype

Observer ref create (session ref, Observer record)

Create a new Observer instance, and return its handle. The constructor args are: name_label, name_description, hosts, attributes, endpoints, components, enabled (* = non-optional).

Parameters:	session ref session_id	Reference to a valid session
	Observer record args	All constructor arguments
Minimum role:	pool-admin
Result:	reference to the newly created object
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

void destroy (session ref, Observer ref)

Destroy the specified Observer instance.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	pool-admin
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

Observer ref set get_all (session ref)

Return a list of all the Observers known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

(Observer ref → Observer record) map get_all_records (session ref)

Return a map of Observer references to Observer records for all Observers known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

(string → string) map get_attributes (session ref, Observer ref)

Get the attributes field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

Observer ref set get_by_name_label (session ref, string)

Get all the Observer instances with the given label.

Parameters:	session ref session_id	Reference to a valid session
	string label	label of object to return
Minimum role:	read-only
Result:	references to objects with matching names
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

Observer ref get_by_uuid (session ref, string)

Get a reference to the Observer instance with the specified UUID.

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

string set get_components (session ref, Observer ref)

Get the components field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

bool get_enabled (session ref, Observer ref)

Get the enabled field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

string set get_endpoints (session ref, Observer ref)

Get the endpoints field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

host ref set get_hosts (session ref, Observer ref)

Get the hosts field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 23.14.0 (23.14.0)

string get_name_description (session ref, Observer ref)

Get the name/description field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)

string get_name_label (session ref, Observer ref)

Get the name/label field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)

Prototype

Observer record get_record (session ref, Observer ref)

Get a record containing the current state of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

string get_uuid (session ref, Observer ref)

Get the uuid field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

void set_attributes (session ref, Observer ref, (string → string) map)

Set the attributes of an observer. These are used to emit metadata by the observer

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	The observer
	(string → string) map value	The attributes that the observer emits as part of the data
Minimum role:	pool-admin
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

void set_components (session ref, Observer ref, string set)

Set the components on which the observer will broadcast to. i.e. xapi, xenopsd, networkd, etc.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	The observer
	string set value	The components the observer will broadcast to
Minimum role:	pool-admin
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

void set_enabled (session ref, Observer ref, bool)

Enable / disable this observer which will stop the observer from producing observability information

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	The observer
	bool value	If the observer is to be enabled (true) or disabled (false)
Minimum role:	pool-admin
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

void set_endpoints (session ref, Observer ref, string set)

Set the file/HTTP endpoints the observer sends data to

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	The observer
	string set value	The endpoints that the observer will export data to. A URL or the string 'bugtool'. This can refer to an enpoint to the local file system
Minimum role:	pool-admin
Prototyped in:	XAPI 23.14.0 (23.14.0)

Prototype

void set_hosts (session ref, Observer ref, host ref set)

Sets the hosts that the observer is to be registered on

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	The observer
	host ref set value	Hosts the observer is registered on
Minimum role:	pool-admin
Prototyped in:	XAPI 23.14.0 (23.14.0)

void set_name_description (session ref, Observer ref, string)

Set the name/description field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
	string value	New value to set
Minimum role:	pool-admin
Published in:	XenServer 4.0 (rio)

void set_name_label (session ref, Observer ref, string)

Set the name/label field of the given Observer.

Parameters:	session ref session_id	Reference to a valid session
	Observer ref self	reference to the object
	string value	New value to set
Minimum role:	pool-admin
Published in:	XenServer 4.0 (rio)

Class: Observer

Fields

Messages Hide implicit

Classes

Messages