isabella232 / snap-plugin-collector-openfoam

Collects OpenFOAM performance metrics

DISCONTINUATION OF PROJECT

This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

Snap Collector Plugin - OpenFOAM

1. Getting Started

• System Requirements
• Installation
• Configuration and Usage

2. Documentation

• Collected Metrics
• Examples
• Roadmap

3. Community Support
4. Contributing
5. License
6. Acknowledgements

Getting Started

System Requirements

OpenFOAM instance with log file hosted by http server http://www.openfoam.com/ .

Download the plugin binary:

You can get the pre-built binaries for your OS and architecture from the plugin's GitHub Releases page.

Compile plugin

make

Configuration and Usage

This plugin requires these config values to be set (examples are given):

• webServerIP (ex. "192.168.122.89")
• webServerPort (ex. 8000)
• webServerFilePath (ex. "run.log")
• timeOut (ex. 2)

Documentation

Examples

Example of running snap OpenFOAM collector and writing data to file.

Ensure snap daemon is running:

• initd: sudo service snap-telemetry start
• systemd: sudo systemctl start snap-telemetry
• command line: sudo snapteld -l 1 -t 0 &

Download and load snap plugins:

$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-openfoam/latest/linux/x86_64/snap-plugin-collector-openfoam
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ snaptel plugin load snap-plugin-collector-openfoam
$ snaptel plugin load snap-plugin-publisher-file

See available metrics for your system.

$ snaptel metric list

Create a task JSON file:

{
    "version":1,
    "schedule":{
        "type":"simple",
        "interval":"1s"
    },
    "workflow":{
        "collect":{
            "metrics":{
                "/intel/openfoam/k/initial":{},
                "/intel/openfoam/Ux/final":{},
                "/intel/openfoam/Uy/initial":{}
            },
            "config":{
                "/intel/openfoam":{
                    "webServerIP":"192.168.122.89",
                    "webServerPort":8000,
                    "webServerFilePath":"run.log",
                    "timeOut": 2
                }
            },
            "process":null,
            "publish":[
                {
                    "plugin_name":"file",
                    "config":{
                        "file":"/tmp/published_openfoam"
                    }
                }
            ]
        }
    }
}

Alternatively use provided example manifest: Change ip address and port of openfoam host in task manifest:

vim example/openfoam-file-example.json

Create task:

$ snaptel task create -t example/openfoam-file-example.json
Using task manifest to create task
Task created
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
Name: Task-02dd7ff4-8106-47e9-8b86-70067cd0a850
State: Running

Collected Metrics

This plugin has the ability to gather the following metrics:

Namespace	Data Type
/intel/openfoam/k/initial	float64
/intel/openfoam/k/final	float64
/intel/openfoam/p/initial	float64
/intel/openfoam/p/final	float64
/intel/openfoam/Ux/initial	float64
/intel/openfoam/Ux/final	float64
/intel/openfoam/Uy/initial	float64
/intel/openfoam/Uy/final	float64
/intel/openfoam/Uz/initial	float64
/intel/openfoam/Uz/final	float64
/intel/openfoam/omega/initial	float64
/intel/openfoam/omega/final	float64

Roadmap

As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue.

If you have a feature request, please add it as an issue and/or submit a pull request.

Community Support

This repository is one of many plugins in snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap To reach out to other users, head to the main framework.

Contributing

We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md. And thank you! Your contribution, through code and participation, is incredibly important to us.

License

snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

This is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.

• Author: Marcin Spoczynski

This software has been contributed by MIKELANGELO, a Horizon 2020 project co-funded by the European Union. https://www.mikelangelo-project.eu/