{"id":13506021,"url":"https://github.com/telefonicaid/fiware-sth-comet","last_synced_at":"2025-04-19T12:11:16.031Z","repository":{"id":27444667,"uuid":"30923102","full_name":"telefonicaid/fiware-sth-comet","owner":"telefonicaid","description":"A component of the FIWARE ecosystem in charge of managing historical and aggregated time series context information","archived":false,"fork":false,"pushed_at":"2024-11-22T08:00:44.000Z","size":2431,"stargazers_count":27,"open_issues_count":46,"forks_count":28,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-11-22T08:27:21.720Z","etag":null,"topics":["fiware","historical-data","sth"],"latest_commit_sha":null,"homepage":"https://fiware-sth-comet.rtfd.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/telefonicaid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES_NEXT_RELEASE","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-02-17T15:29:45.000Z","updated_at":"2024-11-22T08:00:49.000Z","dependencies_parsed_at":"2023-10-20T23:21:45.876Z","dependency_job_id":"e1b990db-4355-453c-ae15-aee0a69c97b2","html_url":"https://github.com/telefonicaid/fiware-sth-comet","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Ffiware-sth-comet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Ffiware-sth-comet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Ffiware-sth-comet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telefonicaid%2Ffiware-sth-comet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telefonicaid","download_url":"https://codeload.github.com/telefonicaid/fiware-sth-comet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235233242,"owners_count":18957066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fiware","historical-data","sth"],"created_at":"2024-08-01T01:00:33.026Z","updated_at":"2025-01-23T06:16:30.793Z","avatar_url":"https://github.com/telefonicaid.png","language":"JavaScript","funding_links":[],"categories":["FIWARE Catalogue"],"sub_categories":["Core Context Management"],"readme":"# \u003ca name=\"top\"\u003e\u003c/a\u003eFIWARE Short Time Historic (STH) - Comet\n\n[![](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/core.svg)](https://www.fiware.org/developers/catalogue/)\n[![License](https://img.shields.io/github/license/telefonicaid/fiware-sth-comet.svg)](https://opensource.org/licenses/AGPL-3.0)\n[![](https://img.shields.io/badge/tag-fiware--sth-comet-orange.svg?logo=stackoverflow)](http://stackoverflow.com/questions/tagged/fiware-sth-comet)\n[![Support badge](https://img.shields.io/badge/support-askbot-yellowgreen.svg)](https://ask.fiware.org/questions/scope%3Aall/tags%3Asth-comet/)\n[![Join the chat at https://gitter.im/telefonicaid/fiware-sth-comet](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/telefonicaid/fiware-sth-comet?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\u003cbr/\u003e\n[![Quay badge](https://img.shields.io/badge/quay.io-fiware%2Fsth--comet-grey?logo=red%20hat\u0026labelColor=EE0000)](https://quay.io/repository/fiware/sth-comet)\n[![Docker badge](https://img.shields.io/badge/docker-telefonicaiot%2Ffiware--sth--comet-blue?logo=docker)](https://registry.hub.docker.com/r/telefonicaiot/fiware-sth-comet)\n\u003cbr/\u003e\n[![Documentation badge](https://readthedocs.org/projects/fiware-sth-comet/badge/?version=latest)](https://fiware-sth-comet.readthedocs.io)\n[![CI](https://github.com/telefonicaid/fiware-sth-comet/workflows/CI/badge.svg)](https://github.com/telefonicaid/fiware-sth-comet/actions?query=workflow%3ACI)\n[![Coverage Status](https://coveralls.io/repos/github/telefonicaid/fiware-sth-comet/badge.svg?branch=master)](https://coveralls.io/github/telefonicaid/fiware-sth-comet?branch=master)\n![Status](https://nexus.lab.fiware.org/static/badges/statuses/cygnus.svg)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4878/badge)](https://bestpractices.coreinfrastructure.org/projects/4878)\n\nThe **FIWARE Short Time Historic (STH) - Comet** is in charge of managing (storing and retrieving) historical raw and\naggregated time series context information about the evolution in time of context data (i.e., entity attribute values)\nregistered in an [Orion Context Broker](https://github.com/telefonicaid/fiware-orion) instance.\n\nAll the communications between the STH and the Orion Context Broker as well as between the STH and any third party\n(typically for data retrieval) use standardized\n[NGSI v1](https://openmobilealliance.org/release/NGSI/V1_0-20120529-A/OMA-TS-NGSI_Context_Management-V1_0-20120529-A.pdf)\ninterfaces.\n\nThis project is part of [FIWARE](https://www.fiware.org/). For more information check the FIWARE Catalogue entry for the\n[Core Context Management](https://github.com/Fiware/catalogue/tree/master/core).\n\n| :books: [Documentation](https://fiware-sth-comet.readthedocs.io) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/core/sth-comet) | \u003cimg style=\"height:1em\" src=\"https://quay.io/static/img/quay_favicon.png\"/\u003e [quay.io](https://quay.io/repository/fiware/sth-comet) | :whale: [Docker Hub](https://registry.hub.docker.com/r/telefonicaiot/fiware-sth-comet) | :dart: [Roadmap](https://github.com/telefonicaid/fiware-sth-comet/blob/master/doc/roadmap.md) |\n| --------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --- |\n\n\n# Contents\n\n-   [Background](#background)\n-   [Install](#install)\n-   [Usage](#usage)\n-   [API overview](#api-overview)\n-   [API walkthrough](#api-walkthrough)\n-   [Testing](#testing)\n    -   [Unit tests](#unit-tests)\n    -   [Performance tests](#performance-tests)\n-   [Advanced topics](#advanced-topics)\n-   [Roadmap](#roadmap)\n-   [Support](#support)\n-   [License](#license)\n\n## Background\n\nThis is the code repository for the **FIWARE Short Time Historic (STH) - Comet**, a component able to manage (storing\nand retrieving) historical context information as raw and aggregated time series context information.\n\nThis project is part of [FIWARE](http://www.fiware.org).\n\nAny feedback on this documentation is highly welcome, including bugs, typos or things you think should be included but\naren't. You can use [GitHub issues](https://github.com/telefonicaid/fiware-sth-comet/issues/new) to provide feedback.\n\nYou can find the Users \u0026 Developers Manual and the Installation \u0026 Administration Manual on\n[readthedocs.org](https://fiware-sth-comet.readthedocs.io)\n\nIf this is your first contact with the STH component, it is highly recommended that you visit the\n[Getting started](doc/manuals/getting-started.md) guide where we introduce some basic concepts upon which the STH\ncomponent leans on all the functionality it offers.\n\nIn case you are curious about why we called this component **Comet**, you can also visit the\n[Why Comet](doc/manuals/why-comet.md) section of the documentation.\n\n[Top](#top)\n\n## Install\n\nBuild and Install documentation for the STH component can be found at the [Installation](doc/manuals/installation.md)\nsection of the documentation.\n\n[Top](#top)\n\n## Usage\n\nDetailed information about how to run the STH component can be found at the\n[Running the STH server](doc/manuals/running.md) section of the documentation.\n\n[Top](#top)\n\n## API overview\n\nThe STH component exposes a REST API covering 4 main functionalities:\n\n1.  **Historical raw and aggregated time series context information storage**: The STH component exposes an endpoint\n    where the notifications generated by a Context Broker instance (whenever an entity attribute value changes) can be\n    received, processed and its associated raw and aggregated time series context information stored in an associated\n    MongoDB database instance.\n2.  **Raw context information retrieval**: The STH component allows the query and retrieval of historical raw context\n    information, this is the concrete values an entity attribute took overtime, including the concrete timestamps when\n    the value of the attributes changed.\n3.  **Aggregated time series context information**: The STH component allows the query and retrieval of historical\n    aggregated time series context information, this is information about the evolution of the entity attribute values\n    grouped by time making it straight-forward to get distinct probabilistic measures such as means, standard\n    deviations, maximum and minimum values, as well as the number of occurrences.\n4.  **Raw and aggregated time series context information removal**: The STH component allows the removal of the raw and\n    aggregated time series context information about the desired attributes and entities.\n\nThese APIs are detailed in the next section.\n\n[Top](#top)\n\n## API walkthrough\n\nDetailed information about the API to store raw and aggregated time series context information can be found at the\n[Storing historical raw and aggregated time series context information](doc/manuals/data-storage.md) section of the\ndocumentation.\n\nDetailed information about the API to retrieve raw context information can be found at the\n[Getting historical raw context information](doc/manuals/raw-data-retrieval.md) section of the documentation.\n\nDetailed information about the API to retrieve aggregated time series context information can be found at the\n[Getting historical aggregated time series context information](doc/manuals/aggregated-data-retrieval.md) section of the\ndocumentation.\n\nDetailed information about the API to remove raw and aggregated time series context information can be found at the\n[Removing historical raw and aggregated time series context information](doc/manuals/aggregated-data-retrieval.md)\nsection of the documentation.\n\n[Top](#top)\n\n## Testing\n\nThe STH component includes unit and performance tests.\n\n[Top](#top)\n\n### Unit tests\n\nDetailed information about the unit tests included with the STH component code can be found at the\n[Unit tests coverage](doc/manuals/unit-test-coverage.md) section of the documentation.\n\n[Top](#top)\n\n### Performance tests\n\nDetailed information about the performance tests included with the STH component code can be found at the\n[Performance tests coverage](doc/manuals/performance-test-coverage.md) section of the documentation.\n\n[Top](#top)\n\n## Advanced topics\n\nIf you are a developer, you may be interested in the following advanced topics:\n\n-   [Additional resources](doc/manuals/additional-resources.md)\n-   [Recommended database indexes](doc/manuals/db_indexes.md)\n-   [Contribution guidelines](doc/manuals/contribution-guidelines.md)\n\n[Top](#top)\n\n## Roadmap\n\nThe roadmap of this FIWARE GE is described [here](doc/roadmap.md).\n\n[Top](#top)\n\n## Support\n\nAsk your thorough programmming questions using [Stack Overflow](http://stackoverflow.com/questions/ask) and your general\nquestions on [FIWARE Q\u0026A](https://ask.fiware.org). In both cases please use the tag `fiware-sth-comet`.\n\n[Top](#top)\n\n## Alarms\n\nAlarms documentation for the STH component can be found at the [Alarms](doc/manuals/alarms.md) section of the\ndocumentation.\n\n[Top](#top)\n\n---\n\n## License\n\nSTH-Comet is licensed under Affero General Public License (GPL) version 3. You can find a\n[copy of this license in the repository](./LICENSE).\n\n© 2022 Telefonica Investigación y Desarrollo, S.A.U\n\n### Are there any legal issues with AGPL 3.0? Is it safe for me to use?\n\nThere is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly\nrelated with the fact that different people assign different interpretations on the meaning of the term “derivate work”\nused in these licenses. Due to this, some people believe that there is a risk in just _using_ software under GPL or AGPL\nlicenses (even without _modifying_ it).\n\nFor the avoidance of doubt, the owners of this software licensed under an AGPL 3.0 license wish to make a clarifying\npublic statement as follows:\n\n\u003e Please note that software derived as a result of modifying the source code of this software in order to fix a bug or\n\u003e incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e.\n\u003e links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it\n\u003e does not need to be released as under the same license, or even released as open source.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelefonicaid%2Ffiware-sth-comet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelefonicaid%2Ffiware-sth-comet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelefonicaid%2Ffiware-sth-comet/lists"}