Overview

Namespaces

  • Authorization_Service
  • Logging_Service
  • Member_Authority
  • Overview
  • Project_Authority
  • Service_Registry
  • Slice_Authority

Classes

  • Logging_Service
  • Overview
  • Namespace
  • Class
  • Tree

Class Logging_Service

GENI Clearinghouse Logging Service controller interface

The GENI Clearinginghouse Logging API allows clients to log events with particular tagging (dictionaries of name/value pairs) and query for logged events matching those name/value pairs

There is one write interface:
  • log_event($event_time, $user_id, $attributes, $message)


There are these read interface:
  • [id, event_time, user_id, message]* <= get_log_entries_by_author($user_id, $num_hours=24)
  • [id, event_time, user_id, message]* <= get_log_entries_by_attributes($user_id, $attribute_sets, $num_hours=24)
  • [attribute_name, attribute_value]* <= get_attributes_for_log_entry($entry_id)
Namespace: Logging_Service
Located at logging_controller.php
Methods summary
public integer
# log_event( dict $args_dict )

Log an event and store it in the logging service archive for future query

Log an event and store it in the logging service archive for future query

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" name of this method ("log_event")
  • "event_time" : time of logged event
  • "user_id" : ID of user logging event
  • "attributes" : dictionary of name/value pairs to be associated with event
  • message" : text message of logged event

Returns

integer
ID of logged event or error code
public array
# get_log_entries_by_author( dict $args_dict )

Return list of logged events written by given user

Return list of logged events written by given user

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" name of this method ("get_log_entries_by_author")
  • "earliest_time" : earliest event time to be returned
  • "user_id" : ID of user logging event

Returns

array
List of log events (ID, event_time, user_id, message) written by given user
public array
# get_log_entries_by_attributes( dict $args_dict )

Return list of logged events matching any of a list of attribute sets
(that is, it is an "OR" of "ANDS" of a dictionary of name/value pairs).

Return list of logged events matching any of a list of attribute sets (that is, it is an "OR" of "ANDS" of a dictionary of name/value pairs).

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" name of this method ("get_log_entries_by_attributes")
  • "earliest_time" : earliest event time to be returned
  • "attribute_sets" : List of dictionaries (name/value pairs) for which< if any one is completely matched, the entry is returned.

Returns

array
List of log events (ID, event_time, user_id, message) matching given list of attribute dictionaries
public dictionary
# get_attributes_for_log_entry( dict $args_dict )

Return the set of name/value pair attributes associated with given log entry

Return the set of name/value pair attributes associated with given log entry

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" name of this method ("get_attributes_for-log_entry")
  • "entry_id" : ID of log entry for which to lookup attributes

Returns

dictionary
Dictionary of name/value pairs associated with given log entry
public number
# get_version( dict $args_dict )

Get the version of the API of this particular service provider

Get the version of the API of this particular service provider

Parameters

$args_dict
dict
$args_dict Dictionary containing 'operation'argument

Returns

number
Version of API of this particular service provider
API documentation generated by ApiGen 2.8.0