added mcsla core

parent 171353a7
/classes/
*.class
*.lst
# Created by .ignore support plugin (hsz.mobi)
### JetBrains template
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
*.iml
# User-specific stuff:
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/dictionaries
# Sensitive or high-churn files:
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.xml
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
# Gradle:
.idea/**/gradle.xml
.idea/**/libraries
# CMake
cmake-build-debug/
# Mongo Explorer plugin:
.idea/**/mongoSettings.xml
## File-based project format:
*.iws
## Plugin-specific files:
# IntelliJ
out/
# mpeltonen/sbt-idea plugin
.idea_modules/
# JIRA plugin
atlassian-ide-plugin.xml
# Cursive Clojure plugin
.idea/replstate.xml
# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties
### Maven template
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
pom.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
# Avoid ignoring Maven wrapper jar file (.jar files are usually ignored)
!/.mvn/wrapper/maven-wrapper.jar
### Eclipse template
.project
.classpath
.metadata
bin/
tmp/
*.tmp
*.bak
*.swp
*~.nib
local.properties
.settings/
.loadpath
.recommenders
# External tool builders
.externalToolBuilders/
# Locally stored "Eclipse launch configurations"
*.launch
# PyDev specific (Python IDE for Eclipse)
*.pydevproject
# CDT-specific (C/C++ Development Tooling)
.cproject
# Java annotation processor (APT)
.factorypath
# PDT-specific (PHP Development Tools)
.buildpath
# sbteclipse plugin
.target
# Tern plugin
.tern-project
# TeXlipse plugin
.texlipse
# STS (Spring Tool Suite)
.springBeans
# Code Recommenders
.recommenders/
# Scala IDE specific (Scala & Java development for Eclipse)
.cache-main
.scala_dependencies
.worksheet
#Windows specific
*~
image: maven:alpine
variables:
MAVEN_CLI_OPTS: "--batch-mode"
before_script:
- apk update && apk upgrade && apk add git
- git config --global user.email "$GITLAB_USER_EMAIL"
- git config --global user.name "$GITLAB_USER_NAME"
- git checkout -B "$CI_BUILD_REF_NAME"
- git pull origin "$CI_BUILD_REF_NAME"
deploy_snapshot:
stage: deploy
only:
- master
script:
- mvn $MAVEN_CLI_OPTS clean deploy -Dmaven.test.skip=true
deploy_release:
stage: deploy
only:
- release
script:
- mvn $MAVEN_CLI_OPTS -Darguments="-DskipTests" -DscmCommentPrefix="[ci skip] - " release:clean release:prepare -B release:perform
Copyright (C) 2018 Fraunhofer FOKUS.
This program is free software: you can redistribute it and/or modify
it under the terms of the Eclipse Public License version 2.0.
Eclipse Public License - v 2.0
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial content
Distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from
and are Distributed by that particular Contributor. A Contribution
"originates" from a Contributor if it was added to the Program by
such Contributor itself or anyone acting on such Contributor's behalf.
Contributions do not include changes or additions to the Program that
are not Modified Works.
"Contributor" means any person or entity that Distributes the Program.
"Licensed Patents" mean patent claims licensable by a Contributor which
are necessarily infringed by the use or sale of its Contribution alone
or when combined with the Program.
"Program" means the Contributions Distributed in accordance with this
Agreement.
"Recipient" means anyone who receives the Program under this Agreement
or any Secondary License (as applicable), including Contributors.
"Derivative Works" shall mean any work, whether in Source Code or other
form, that is based on (or derived from) the Program and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship.
"Modified Works" shall mean any work in Source Code or other form that
results from an addition to, deletion from, or modification of the
contents of the Program, including, for purposes of clarity any new file
in Source Code form that contains any contents of the Program. Modified
Works shall not include works that contain only declarations,
interfaces, types, classes, structures, or files of the Program solely
in each case in order to link to, bind by name, or subclass the Program
or Modified Works thereof.
"Distribute" means the acts of a) distributing or b) making available
in any manner that enables the transfer of a copy.
"Source Code" means the form of a Program preferred for making
modifications, including but not limited to software source code,
documentation source, and configuration files.
"Secondary License" means either the GNU General Public License,
Version 2.0, or any later versions of that license, including any
exceptions or additional permissions as identified by the initial
Contributor.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby
grants Recipient a non-exclusive, worldwide, royalty-free copyright
license to reproduce, prepare Derivative Works of, publicly display,
publicly perform, Distribute and sublicense the Contribution of such
Contributor, if any, and such Derivative Works.
b) Subject to the terms of this Agreement, each Contributor hereby
grants Recipient a non-exclusive, worldwide, royalty-free patent
license under Licensed Patents to make, use, sell, offer to sell,
import and otherwise transfer the Contribution of such Contributor,
if any, in Source Code or other form. This patent license shall
apply to the combination of the Contribution and the Program if, at
the time the Contribution is added by the Contributor, such addition
of the Contribution causes such combination to be covered by the
Licensed Patents. The patent license shall not apply to any other
combinations which include the Contribution. No hardware per se is
licensed hereunder.
c) Recipient understands that although each Contributor grants the
licenses to its Contributions set forth herein, no assurances are
provided by any Contributor that the Program does not infringe the
patent or other intellectual property rights of any other entity.
Each Contributor disclaims any liability to Recipient for claims
brought by any other entity based on infringement of intellectual
property rights or otherwise. As a condition to exercising the
rights and licenses granted hereunder, each Recipient hereby
assumes sole responsibility to secure any other intellectual
property rights needed, if any. For example, if a third party
patent license is required to allow Recipient to Distribute the
Program, it is Recipient's responsibility to acquire that license
before distributing the Program.
d) Each Contributor represents that to its knowledge it has
sufficient copyright rights in its Contribution, if any, to grant
the copyright license set forth in this Agreement.
e) Notwithstanding the terms of any Secondary License, no
Contributor makes additional grants to any Recipient (other than
those set forth in this Agreement) as a result of such Recipient's
receipt of the Program under the terms of a Secondary License
(if permitted under the terms of Section 3).
3. REQUIREMENTS
3.1 If a Contributor Distributes the Program in any form, then:
a) the Program must also be made available as Source Code, in
accordance with section 3.2, and the Contributor must accompany
the Program with a statement that the Source Code for the Program
is available under this Agreement, and informs Recipients how to
obtain it in a reasonable manner on or through a medium customarily
used for software exchange; and
b) the Contributor may Distribute the Program under a license
different than this Agreement, provided that such license:
i) effectively disclaims on behalf of all other Contributors all
warranties and conditions, express and implied, including
warranties or conditions of title and non-infringement, and
implied warranties or conditions of merchantability and fitness
for a particular purpose;
ii) effectively excludes on behalf of all other Contributors all
liability for damages, including direct, indirect, special,
incidental and consequential damages, such as lost profits;
iii) does not attempt to limit or alter the recipients' rights
in the Source Code under section 3.2; and
iv) requires any subsequent distribution of the Program by any
party to be under a license that satisfies the requirements
of this section 3.
3.2 When the Program is Distributed as Source Code:
a) it must be made available under this Agreement, or if the
Program (i) is combined with other material in a separate file or
files made available under a Secondary License, and (ii) the initial
Contributor attached to the Source Code the notice described in
Exhibit A of this Agreement, then the Program may be made available
under the terms of such Secondary Licenses, and
b) a copy of this Agreement must be included with each copy of
the Program.
3.3 Contributors may not remove or alter any copyright, patent,
trademark, attribution notices, disclaimers of warranty, or limitations
of liability ("notices") contained within the Program from any copy of
the Program which they Distribute, provided that Contributors may add
their own appropriate notices.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities
with respect to end users, business partners and the like. While this
license is intended to facilitate the commercial use of the Program,
the Contributor who includes the Program in a commercial product
offering should do so in a manner which does not create potential
liability for other Contributors. Therefore, if a Contributor includes
the Program in a commercial product offering, such Contributor
("Commercial Contributor") hereby agrees to defend and indemnify every
other Contributor ("Indemnified Contributor") against any losses,
damages and costs (collectively "Losses") arising from claims, lawsuits
and other legal actions brought by a third party against the Indemnified
Contributor to the extent caused by the acts or omissions of such
Commercial Contributor in connection with its distribution of the Program
in a commercial product offering. The obligations in this section do not
apply to any claims or Losses relating to any actual or alleged
intellectual property infringement. In order to qualify, an Indemnified
Contributor must: a) promptly notify the Commercial Contributor in
writing of such claim, and b) allow the Commercial Contributor to control,
and cooperate with the Commercial Contributor in, the defense and any
related settlement negotiations. The Indemnified Contributor may
participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial
product offering, Product X. That Contributor is then a Commercial
Contributor. If that Commercial Contributor then makes performance
claims, or offers warranties related to Product X, those performance
claims and warranties are such Commercial Contributor's responsibility
alone. Under this section, the Commercial Contributor would have to
defend claims against the other Contributors related to those performance
claims and warranties, and if a court requires any other Contributor to
pay any damages as a result, the Commercial Contributor must pay
those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Each Recipient is solely responsible for determining the
appropriateness of using and distributing the Program and assumes all
risks associated with its exercise of rights under this Agreement,
including but not limited to the risks and costs of program errors,
compliance with applicable laws, damage to or loss of data, programs
or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under
applicable law, it shall not affect the validity or enforceability of
the remainder of the terms of this Agreement, and without further
action by the parties hereto, such provision shall be reformed to the
minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity
(including a cross-claim or counterclaim in a lawsuit) alleging that the
Program itself (excluding combinations of the Program with other software
or hardware) infringes such Recipient's patent(s), then such Recipient's
rights granted under Section 2(b) shall terminate as of the date such
litigation is filed.
All Recipient's rights under this Agreement shall terminate if it
fails to comply with any of the material terms or conditions of this
Agreement and does not cure such failure in a reasonable period of
time after becoming aware of such noncompliance. If all Recipient's
rights under this Agreement terminate, Recipient agrees to cease use
and distribution of the Program as soon as reasonably practicable.
However, Recipient's obligations under this Agreement and any licenses
granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement,
but in order to avoid inconsistency the Agreement is copyrighted and
may only be modified in the following manner. The Agreement Steward
reserves the right to publish new versions (including revisions) of
this Agreement from time to time. No one other than the Agreement
Steward has the right to modify this Agreement. The Eclipse Foundation
is the initial Agreement Steward. The Eclipse Foundation may assign the
responsibility to serve as the Agreement Steward to a suitable separate
entity. Each new version of the Agreement will be given a distinguishing
version number. The Program (including Contributions) may always be
Distributed subject to the version of the Agreement under which it was
received. In addition, after a new version of the Agreement is published,
Contributor may elect to Distribute the Program (including its
Contributions) under the new version.
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
receives no rights or licenses to the intellectual property of any
Contributor under this Agreement, whether expressly, by implication,
estoppel or otherwise. All rights in the Program not expressly granted
under this Agreement are reserved. Nothing in this Agreement is intended
to be enforceable by any entity that is not a Contributor or Recipient.
No third-party beneficiary rights are created under this Agreement.
Exhibit A - Form of Secondary Licenses Notice
"This Source Code may also be made available under the following
Secondary Licenses when the conditions for such availability set forth
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
version(s), and exceptions or additional permissions here}."
Simply including a copy of this Agreement, including this Exhibit A
is not sufficient to license the Source Code under Secondary Licenses.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to
look for such a notice.
You may add additional accurate notices of copyright ownership.
\ No newline at end of file
# MCSLA Core Library
The MCSLA Core Library provides
## Table of Contents
1. [Features](#features)
1. [Installation](#installation)
1. [Getting started](#getting-started)
1. [The Interface](#the-interface)
1. [License](#license)
## Features
* Support for different aggregation expressions
* Aggregation of cloud service SLAs
* Evaluation of a single cloud service SLA metric
* Evaluation of aggregated cloud services SLA metrics
## Building from Source
The project is available via Git repository. If you have access, do the following steps:
```shell
$> git clone https://gitlab.fokus.fraunhofer.de/DECIDE/mcsla-core.git
$> cd mcsla-core
```
The project uses Maven as build tool. After build you will find the jar and a fat jar in the target directory. To build use the follwoing command:
```shell
$> mvn clean package
```
## Installation
For non-Maven based projects you can take the build jar file located in the target directory after executing the build command and put it in the classpath of your application. There is also a fat jar provided containing all dependencies if required.
For Maven based projects you need to install it in a Maven repository which your application can access. E.g. to put it in your local maven repository, you can simply call
`$> mvn install`
Finally, your application pom.xml requires the following dependency:
```xml
<dependency>
<groupId>eu.DECIDEh2020</groupId>
<artifactId>mcsla-core</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
```
## Getting started
A small example how to create a metrics context and evaluate a cloud service objective:
```java
// create context
MetricsContext context = MetricsContext.create(appDescription);
// get sla service objective metrics for a apecific cloud service
Map<String, ServiceObjectiveMetrics> metrics = context.getCsMetrics(csId);
// get the service objectove metrics for a specific term name, e.g. "Availability"
ServiceObjeciveMetrics availabilityMetrics = metrics.get("Availability");
// now evaluate against a concrete monitoring result
EvaluationResult<Double> evaluationResult = availabilityMetrics.evaluate(monitoringResult);
if (!evaluationResult.isError()) {
log.info("condition met: {}, result: {}", evaluationResult.isConditionMet(), evaluationResult.getMeasurementResultValue());
} else {
log.error(evaluationResult.getErrorMessage());
}
```
For further examples please take a look at the test cases.
## The Interface
In general there are three main classes:
* [MetricsContext](#metricscontext)
* [ServiceObjectiveMetrics](#serviceobjectivemetrics)
* [EvaluationResult\<T\>](#evaluationresultt)
### MetricsContext
This class provides a static methods for creating context objects. Created context can be used to get service objective metrics of
each SLA as a map. Furthermore, it contains a memory for cloud service evaluation results, so specific aggregation
expressions can be implicitly applied. And finally, it allows the aggregation of service objectives or raw values.
#### Aggregation
The easiest way to use the MetricsContext is to aggregate some raw values:
```
List<Double> values = Arrays.asList(99.9, 99.8, 99.95);
Double value = MetricsContext.aggregate(values, Predefined.AVAILABILITY_AGGREGATION_SUMTYPE);
```
See [Predefined](#predefined-aggregation-expressions) for available aggregation expressions.
To start working with the library in the context of an application description you need to create a MetricsContext object:
```java
AppDescription appDescription = ...
MetricsContext context = MetricsContext.create(appDescription);
```
You can now aggregate all agreement values of all cloud services for a specific term name:
```java
Double value = MetricsContext.aggregate(Predefined.AVAILABILITY_AGGREGATION_SUMTYPE, "Availability");
```
The return type depends on the predefined aggregation expression to be used.
#### Evaluation
The MetricsContext object has two methods for retrieving [ServiceObjectiveMetrics](#serviceobjectivemetrics) which are needed for evaluation:
```java
Map<String, ServiceObjectiveMetrics> appMetrics = context.getAppMetrics();
Map<String, ServiceObjectiveMetrics> cloudserviceMetrics = context.getCsMetrics(csId);
```
The return value is a map of term names and corresponding metrics of either a specific cloud service or the application.
Now you can get the [ServiceObjectiveMetrics](#serviceobjectivemetrics) object for a specific term name:
```java
ServiceObjectiveMetrics objectiveMetrics = appMetrics.get("Availability");
```
### ServiceObjectiveMetrics
You need objects s of this class to evaluate the metrics. The class has the following evaluation functions:
* evaluate()
* evaluate(double[] measuredValues)
* evaluate(int[] measuredValues)
* evaluate(List\<Integer\> measuredValues)
* evaluate(Map\<String, List\<Long\>\> measuredValues)
* evaluate(double measuredValue)
They all return a [EvaluationResult\<T\>](#evaluationresultt) object.
The first one without passing any monitoring results utilizes the memory function of the metrics context. It therefore requires that each monitoring result to be aggregate must be evaluated beforehand.
This makes sense where you have to evaluate first each cloud service metrics and then the aggregated application metric:
```java
Map<String, ServiceObjectiveMetrics> cloudserviceOneMetrics = context.getCsMetrics("1");
ServiceObjectiveMetrics oneMetrics = cloudserviceOneMetrics.get("Availability");
EvaluationResult<Double> resultOne = OneMetrics.evaluate(99.9);
...
Map<String, ServiceObjectiveMetrics> cloudserviceTwoMetrics = context.getCsMetrics("1");
ServiceObjectiveMetrics twoMetrics = cloudserviceTwoMetrics.get("Availability");
EvaluationResult<Double> resultTwo = twoMetrics.evaluate(99.9);
...
Map<String, ServiceObjectiveMetrics> appMetrics = context.getAppMetrics();
ServiceObjectiveMetrics availabilityMetrics = appMetrics.get("Availability");
EvaluationResult<Double> resultApp = availabilityMetrics.evaluate();
```
### EvaluationResult\<T\>
The first thing you should do is to check if the evaluation was successful:
```java
EvaluationResult<Doube> result = ...
if (result.isError()) {
log.error(result.getErrorMesssge());
} else {
...
}
```
A successful evaluation result contains the following information:
* The evaluation date and time
* The underlying term name
* The measurement result value
* The used condition statement
* And finally if the condition is met (see [Statement](#condition-statements))
```java
EvaluationResult<T> result = ...
Date time = result.getMeasurementTime();
String termName = result.getTermName();
T measurementValue = result.getMeasurementResultValue();
Statement conditionStatement ? result.getConditionStatement();
assert result.isConditionMet() : "Condition is not met.";
```
### Predefined Aggregation Expressions
| Expression | |
|----------------------------------|-------------------------------------------------------------------------------------|
| EMPTY | The empty aggregation returns always null. |
| AVAILABILITY_UPTIME_BC | Evaluation of downtimes in seconds to an percentage uptime during a billing cycle. |
| AVAILABILITY_MTBFMTTR | Evaluation based on meantime between failure and meantime between recovery. |
| AVAILABILITY_AGGREGATION_SUMTYPE | An aggregation that summarizes percentage values |
| AGGREGATION_MINTYPE | Returns the min value. |
| AGGREGATION_MAXTYPE | Returns the max value |
| AGGREGATION_SUMTYPE | Returns the sum up of values. |
### Condition Statements
* greater
* greaterOrEqual
* less
* lessOrEqual
* equal
## License
[Eclipse Public License version 2.0.](LICENSE.txt)
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<