Skip to content
Snippets Groups Projects
Commit 09eff97c authored by erbel's avatar erbel
Browse files

Readme update

parent adfeca7e
No related branches found
No related tags found
No related merge requests found
Pipeline #87895 failed
# Monitoring Extension
This component represents the OCCI monitoring extension, we generated using [OCCI-Studio](https://github.com/occiware/OCCI-Studio).
The elements introduced in this extension mainly inherit from elements of the enhanced platform extension of [MoDMaCAO](https://github.com/occiware/MoDMaCAO),
as shown in the Figure below.
# Monitoring Extension Connector Dummy
This component represents the connector dummy for the OCCI monitoring extension. The skeleton for this connector is generated using [OCCI-Studio](https://github.com/occiware/OCCI-Studio).
Hereby, for each element in the monitoring extension a single connector file is present, implementing how to react on different REST requests addressing the corresponding OCCI element.
This dummy is especially useful for testing purposes. Compared to the actual connector, a link to configuration management scripts is not necessary in order to get monitoring data.
As soon as a resultprovider is started monitoring results are simulated are passed to the monitorableproperty element of the sensor containing the resultprovider.
The simulated values are easy to adjust and does not require a recompilation of the connector, as only the resultprovider.properties file within the connector has to be modified.
![alt text](https://gitlab.gwdg.de/rwm/de.ugoe.cs.rwm.mocci/blob/master/de.ugoe.cs.rwm.mocci.model/monExt.png)
## The Sensor Element
The sensor element represents a top level element used to easily manage all monitoring instruments it contains.
The containment relationship to its monitoring instruments is modeled via componentlinks.
As sensor inherits application, it gains access to attributes reflecting its current state, as well as actions to manage its lifecycle.
Thus, the monitoring instruments can be deployed by accessing the sensor directly, but also by addressing each instrument separately.
To specify the object a sensor monitors, it can be connected over a monitorableproperty to the corresponding resource.
The property itself defines two attributes defining the name of the property it monitors, and its results.
## Adjusting the Simulation
To configure the simulation of monitoring results the following steps have to be performed.
1. Navigate to ~/martserver-plugins
2. Open the de.ugoe.cs.rwm.mocci.connecter.dummy.jar with an archive manager.
3. Doubleclick on the resultprovider.properties file
4. Adjust the values to your liking
The adjustment of the file itself is best explained with a small example:
Currently, the file contains the following:
```
CPU = None,Low,Medium,High,Critical,5000
```
* CPU: Represents the monitorable.property to be adjusted.
* 5000: Represents the interval in which monitoring.results are written.
* None-Critical: Represents the simulated monitoring.results.
## The Monitoring Components
Each monitoring component (datagatherer, dataprocessor, resultprovider) inherit from component.
Thus, each monitoring component gains access to actions to deploy, configure, start, stop, and undeploy it.
When not using the dummy connector, the execution of these actions trigger the execution of configuration management scripts linked to the individual monitoring instrument.
The name of the scripts are assigned over user mixins attached to the component, which is located in the roles folder of the MartServer.
To define where each monitoring instrument is deployed placementlinks are used connecting the instrument to the vm it is deployed on.
Thus, each instrument can be hosted by different vm.
\ No newline at end of file
# Monitoring Extension Connector Dummy
This component represents the connector dummy for the OCCI monitoring extension. The skeleton for this connector is generated using [OCCI-Studio](https://github.com/occiware/OCCI-Studio).
Hereby, for each element in the monitoring extension a single connector file is present, implementing how to react on different REST requests addressing the corresponding OCCI element.
This dummy is especially useful for testing purposes. Compared to the actual connector, a link to configuration management scripts is not necessary in order to get monitoring data.
As soon as a resultprovider is started monitoring results are simulated are passed to the monitorableproperty element of the sensor containing the resultprovider.
The simulated values are easy to adjust and does not require a recompilation of the connector, as only the resultprovider.properties file within the connector has to be modified.
As the elements of the monitoring extension mainly inherit from elements of the enhanced platform extension provided by [MoDMaCAO](https://github.com/occiware/MoDMaCAO), the implementation of the lifecycle actions is quite similar. To handle the management of each individual component of a sensor, configuration management scripts have to be attached to them.
## Attaching Configuration Management Scripts
To attach a configuration management script to a component, a user mixin serving as tag has to be created.
Moreover, the component managed over the defined script has to have this mixin attached.
Finally, the script itself is located on the MartServer, typically in a folder called roles, and has the same name
as the mixin tag.
The following figure gives an example of such an attachment.
Here, the blue element is the User Mixin which is attached to the DataGatherer which is managed over lifecycle
actions as described in the configuration management script called glances, located in the roles folder of the MartServer.
## Adjusting the Simulation
To configure the simulation of monitoring results the following steps have to be performed.
1. Navigate to ~/martserver-plugins
2. Open the de.ugoe.cs.rwm.mocci.connecter.dummy.jar with an archive manager.
3. Doubleclick on the resultprovider.properties file
4. Adjust the values to your liking
The adjustment of the file itself is best explained with a small example:
Currently, the file contains the following:
```
CPU = None,Low,Medium,High,Critical,5000
```
* CPU: Represents the monitorable.property to be adjusted.
* 5000: Represents the interval in which monitoring.results are written.
* None-Critical: Represents the simulated monitoring.results.
![Attachment](../example.jpg "Attachment")
de.ugoe.cs.rwm.mocci.connector/example.jpg

349 KiB

de.ugoe.cs.rwm.mocci.connector/example.png

206 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment