Common-accounting-model ABANDONED

Scope

This library contains the definition of the resource accounting record.

Find common-accounting-model on Nexus Repository Browser for an artifact with the following coordinates:

<dependency>
	<groupId>org.gcube.accounting</groupId>
	<artifactId>common-accounting-model</artifactId>
</dependency>

Data-model

The structure of a generic accounting record (Usage Record, UR) is composed of a set of common and mandatory fields for all resource types, in particular:

• id : an unique identifier for the UR
• consumerId : the user (or the Consumer Identity, that in the S2S communication is another service) actually consuming the resource
• createTime : when the UR was created
• startTime, endTime : the time window the UR refers to
• resourceType : the type of resource the UR tracks: i.e. Job, Task, Service, StorageUsage, StorageStatus
• resourceScope : the scope of the resource
• resourceOwner : who owns the resource and/or who creates the UR

Furthermore, for each UR there will be a section to be filled with the specific properties per resource type (key-value pairs).

Resource Types

The resource types we've identified are: Execution, Service, StorageUsage, StorageStatus and Portlet.

Execution

This specialization will be used to take into account information about services running jobs on the infrastructure (Workflow Engine, Execution Engine, Statistical Manager, Aquamaps).

For this resource type, there are two sub-types:

Job

Contains the information about the overall job, that will be partitioned in N Tasks.

Specific Job properties:

• jobId : an unique identifier for the job
• jobQualifier : qualifies the job in terms of algorithm type or job type (e.g. search, data-transformation, etc)
• jobName : name of the job
• jobStart : the instant the job start running
• jobEnd : the instant the job ends its execution
• jobStatus: completed/failed
• vmsUsed : number of the VMs (gHNs) used by the job.
• wallDuration : duration between the instant the job start running and the instant the job ends its execution.

Task

Contains the information about one slice of the overall Job.

Specific Task properties:

• jobId : reference to the Job that generated this Task
• refHost : hostname of the virtual machine (gHN)
• refVM : virtual machine id (gHN)
• domain : domain of the virtual machine (gHN)
• usageStart : the earlier usage time of the Task
• usageEnd: the latest usage time of the Task
• usagePhase: completed/failed
• inputFilesNumber : number of input files to the Task
• inputFilesSize : dimension of input files to the Task
• outputFilesNumber : number of output files from the Task
• outputFilesSize : dimension of output files from the Task
• overallNetworkIn : overhead of the input traffic over the network to the Task
• overallNetworkOut : overhead of the output traffic over the network from the Task
• cores : number of cores per Task.
• processors : number of processors per Task.

Service

This specialization will be used to take into account information about the services invocations.

Specific service attributes

• callerIP : IP address that originated the service call
• callerScope : includes the service scope (for Service specialization the resourceScope field includes the infrastructure scope)
• refHost : hostname of the virtual machine (gHN)
• refVM : virtual machine id (gHN)
• domain : domain of the virtual machine (gHN)
• invocationCount : number of invocations (aggregated information)
• averageInvocationTime : average invocation time (aggregated information)
• serviceClass : name of the service class
• serviceName : name of the service

StorageUsage

This specialization will be used to account the operations performed against different storage backends.

Specific storage usage attributes:

• providerId: the identifier of the provider which is the target of a read/write operation
• objectURI : the identifier of an information within the data source which is the target of a given read/write operation performed
• operationType : the name of the read/write operation performed over a given source, i.e. GET, PUT, UPDATE, DELETE
• qualifier : qualifies the data in terms of data (e.g. mime type for the Storage, domain for a database)
• dataType : type of data accessed, i.e. STORAGE, TREE, GEO, DATABASE
• dataVolume : quantity of data in terms of KB
• dataCount : the number of objects within the data provider which are accessed/written.
• callerIP : IP address that originated the service call (if appropriate)

StorageStatus

Identifies the exploitation (in terms of storage volume) of a storage resource type by an identifiable entity.

Specific storage status attributes:

• providerId: the identifier of the provider which is the target of a read/write operation
• qualifier : qualifies the data in terms of data (e.g. mime type for the Storage, domain for a database)
• dataType : type of data accessed, i.e. STORAGE, TREE, GEO, DATABASE
• dataVolume (Kbytes): quantity of data monitored at the time of the record creation
• dataCount : number of objects

Portlet

In some cases at service-side the information on the user identity is not available. Hence, it is needed to map the operations performed by the portlets. This specialization will be used by the portlets in order to take into account information about the mapping between the portal user and the reference to the operation he/she performed.

Specific portlet attributes:

• user : the user actually performing the operation
• operationId : an unique identifier for the operation