FIWARE Short Time Historic (STH) (aka. Comet)
JavaScript Python Gherkin Shell API Blueprint CSS Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin Configurable service, service path, entity and attribute mappings Sep 27, 2016
doc Corrected spelling of performance and broken links Jul 17, 2018
ghpages Adaptation to TID's Node app guidelines and linting Jan 18, 2016
lib add fiware-total-count header May 25, 2018
resources Corrected spelling of performance and broken links Jul 17, 2018
rpm Update sth.spec Jun 22, 2018
test Corrected spelling of performance and broken links Jul 17, 2018
.codeclimate.yml Removing all the references to the develop branch Oct 4, 2016
.csslintrc Add Code Climate configuration to the repository Oct 4, 2016
.eslintignore Add Code Climate configuration to the repository Oct 4, 2016
.eslintrc Add Code Climate configuration to the repository Oct 4, 2016
.gitignore Adding the FIWARE style to the ReadTheDocs documentation Jun 20, 2016
.gjslintrc Migration from the collection per entity to the collection per servic… Apr 19, 2016
.jshintrc Adaptation to TID's Node app guidelines and linting Jan 18, 2016
.travis.yml upgrade node version for docker Oct 4, 2017
CHANGES_NEXT_RELEASE Update CHANGES_NEXT_RELEASE Jun 21, 2018
ContributionPolicy.txt Added Contribution Policy form. May 5, 2015
Dockerfile upgrade node version for docker Oct 4, 2017
Gruntfile.js Adaptation to TID's Node app guidelines and linting Jan 18, 2016
LICENSE Adds the GNU Affero General Public License version 3 file to the project Jun 23, 2016
Makefile File structure refactor Jul 7, 2016
README.md Update README.md Jul 30, 2018
apiary.apib Including Apiary documentation for the STH component Oct 29, 2015
config.js add maxPageSize May 14, 2018
docker-compose.yml Aligning the docker-compose file with the one using by the On-Premise… May 12, 2016
index.js Adaptation to TID's Node app guidelines and linting Jan 18, 2016
mkdocs.yml Inclusion of documentation about the Architecture, Data Models & Schemas Oct 5, 2016
package.json Update package.json Jun 21, 2018
sonar-project.properties Adding the sonar-project.properties file Apr 19, 2016

README.md

FIWARE Short Time Historic (STH) - Comet

License badge Documentation badge Docker badge Support badge Join the chat at https://gitter.im/telefonicaid/fiware-sth-comet

Introduction

This is the code repository for the FIWARE Short Time Historic (STH) - Comet, a component able to manage (storing and retrieving) historical context information as raw and aggregated time series context information.

This project is part of FIWARE.

Any feedback on this documentation is highly welcome, including bugs, typos or things you think should be included but aren't. You can use github issues to provide feedback.

You can find the Users & Developers Manual and the Installation & Administration Manual on readthedocs.org

Top

Overall description

The FIWARE Short Time Historic (STH) - Comet is a component of the FIWARE ecosystem in charge of managing (storing and retrieving) historical raw and aggregated time series context information about the evolution in time of context data (i.e., entity attribute values) registered in an Orion Context Broker instance.

All the communications between the STH and the Orion Context Broker as well as between the STH and any third party (typically for data retrieval) use standardized NGSI9 and NGSI10 interfaces.

If this is your first contact with the STH component, it is highly recommended that you visit the Getting started guide where we introduce some basic concepts upon which the STH component leans on all the functionality it offers.

In case you are curious about why we called this component Comet, you can also visit the Why Comet section of the documentation.

Top

Build and install

Build and Install documentation for the STH component can be found at the Installation section of the documentation.

Top

Running

Detailed information about how to run the STH component can be found at the Running the STH server section of the documentation.

Top

API overview

The STH component exposes a REST API covering 4 main functionalities:

  1. Historical raw and aggregated time series context information storage: The STH component exposes an endpoint where the notifications generated by a Context Broker instance (whenever an entity attribute value changes) can be received, processed and its associated raw and aggregated time series context information stored in an associated MongoDB database instance.
  2. Raw context information retrieval: The STH component allows the query and retrieval of historical raw context information, this is the concrete values an entity attribute took overtime, including the concrete timestamps when the value of the attributes changed.
  3. Aggregated time series context information: The STH component allows the query and retrieval of historical aggregated time series context information, this is information about the evolution of the entity attribute values grouped by time making it straight-forward to get distinct probabilistic measures such as means, standard deviations, maximum and minimum values, as well as the number of occurrences.
  4. Raw and aggregated time series context information removal: The STH component allows the removal of the raw and aggregated time series context information about the desired attributes and entities.

These APIs are detailed in the next section.

Top

API walkthrough

Detailed information about the API to store raw and aggregated time series context information can be found at the Storing historical raw and aggregated time series context information section of the documentation.

Detailed information about the API to retrieve raw context information can be found at the Getting historical raw context information section of the documentation.

Detailed information about the API to retrieve aggregated time series context information can be found at the Getting historical aggregated time series context information section of the documentation.

Detailed information about the API to remove raw and aggregated time series context information can be found at the Removing historical raw and aggregated time series context information section of the documentation.

Top

Testing

The STH component includes unit and performance tests.

Top

Unit tests

Detailed information about the unit tests included with the STH component code can be found at the Unit tests coverage section of the documentation.

Top

Performance tests

Detailed information about the performance tests included with the STH component code can be found at the Performance tests coverage section of the documentation.

Top

Advanced topics

If you are a developer, you may be interested in checking the Additional resources section of the documentation as well as the Contribution guidelines section in case you may be interested in contributing to the project.

Top

Licence

The STH component is licensed under Affero General Public License (GPL) version 3.

Top

Support

Ask your thorough programmming questions using stackoverflow and your general questions on FIWARE Q&A. In both cases please use the tag fiware-sth-comet.

Top

Alarms

Alarms documentation for the STH component can be found at the Alarms section of the documentation.

Top

Contact

Top