{"id":18825403,"url":"https://github.com/outsystems/outsystems-elastic-integration","last_synced_at":"2025-04-14T01:31:26.448Z","repository":{"id":50740573,"uuid":"424725008","full_name":"OutSystems/outsystems-elastic-integration","owner":"OutSystems","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-10T11:24:17.000Z","size":2696,"stargazers_count":15,"open_issues_count":3,"forks_count":7,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-27T15:52:18.210Z","etag":null,"topics":["engineering","snyk-professional-services"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OutSystems.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-11-04T20:04:08.000Z","updated_at":"2025-03-05T00:49:58.000Z","dependencies_parsed_at":"2024-05-09T17:32:29.371Z","dependency_job_id":"9ea26e6d-2a5e-41cb-b797-13fb6644142b","html_url":"https://github.com/OutSystems/outsystems-elastic-integration","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Foutsystems-elastic-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Foutsystems-elastic-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Foutsystems-elastic-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Foutsystems-elastic-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OutSystems","download_url":"https://codeload.github.com/OutSystems/outsystems-elastic-integration/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248807569,"owners_count":21164709,"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":["engineering","snyk-professional-services"],"created_at":"2024-11-08T00:59:21.258Z","updated_at":"2025-04-14T01:31:25.646Z","avatar_url":"https://github.com/OutSystems.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# outsystems-elastic-integration 🚀\n\n## About 📑\nThis repository contains [Elastic](https://elastic.co/) accelerators to provide better and faster insights on top of [OutSystems](https://www.outsystems.com/) monitoring data.\n\nThese accelerators are:\n- **Elasticsearch definitons**\n    - Help to set up indices and their lifecycle policies.\n    - See it at [data_storing-elasticsearch](data_storing-elasticsearch)\n- **Logstash pipelines**\n    - Simplify the ETL of monitoring data from the OutSystems platform.\n    - Enrich data to allow building more human-readable visualizations.\n    - - See it at [data_storing-elasticsearch](data_storing-elasticsearch)\n- **Kibana dashboards**\n    - Provide an out-of-the-box set of visualizations that help understand OutSystems applications and platform health, based on their performance and errors.\n    - Reduce time to insights (based on OutSystems monitoring data).\n    - Improve troubleshooting capabilities.\n\n\u003cbr\u003e\n\nExample of one of the visualizations available on this repository:\n![OutSystems_Queries_Dashboard](docs/images/OutSystems_Queries_Dashboard.png)\n\n\u003cbr\u003e\n\n:exclamation: To know how to set up and use this repository artifacts you can go directly to the this section [How to use the contents of this repository](#how-to-use-the-contents-of-this-repository)\n\n:exclamation: **Want to support to implement or extend this assets?**\nContact OutSystems Professional Services. You can know more about us at:\nhttps://www.outsystems.com/success-services/professional-services/ \n  \n\u003cbr\u003e\n\n## Goal 🎯\nThe major goal of these accelerators is to provide OutSystems customers with an out-of-the-box solution to:\n- Easily **observe the OutSystems monitoring data on Elastic with more advanced visualizations**, compared to the ones from the built-in tools of the OutSystems platform.\n- Easily search through OutSystems monitoring data, in particular through the OutSystems logs with:\n    - Free text search.\n    - Selection of visible information.\n- **Do more advanced monitoring**, compared to what can be done using the built-in tools of the OutSystems platform. Things like:\n    - Build alerts for an OutSystems environment or OutSystems Factory.\n    - Leverage Elastic analytic capabilities to have deeper insights on performance and behavior of applications, and the platform itself.\n- **Observe OutSystems applications performance and errors through time**.\n    - Quickly pinpoint performance bottlenecks, areas to improve, etc.\n    - Figure out what is affecting performance:\n        - Slow Queries\n        - Slow Integrations\n        - Slow Extensions\n- Provide an example of how to **set up and monitor SLOs**.\n\n\n\u003cbr\u003e\n\n## Outcomes ✅\n- Fast and efficient set up of advanced monitoring and observability solution with a free version. But also with support from Elastic and/or OutSystems Professional Services\n- Fast detection of performance and availability issues (of potential or existing)\n- Lower troubleshooting times\n- Increase the insights to continuously improve your applications and factory through a data drive approach.\n\n\n\u003cbr\u003e \n\n## Examples of metrics can you measure\nHere are some examples of OutSystems metrics that can be monitored using these accelerators:\n- **Request Time Duration** (for each request):\n    - Client Time (load time)\n    - Server Time, which can be decomposed into:\n        - SAT (Session Acquisition Time)\n        - Query Execution Time\n        - Integration Execution Time\n        - Extension Execution Time\n- **Server side performance metrics**\n    - Session size\n    - Viewstate size\n    - Number of slow queries\n    - Number of slow integrations\n    - Number of slow extensions\n- **Errors metrics**\n    - Number of errors\n    - Number of errors by type\n\n\u003e These metrics are the ones that **OutSystems Professional Services Experts** teams consider to be a starting point to understand applications and platform performance.\n\n\u003e As stated, these are just examples of some metrics that can be monitored, based on the platform data.\n\n\u003cbr\u003e\n\n## How to use the contents of this repository\nIf you have low to no experience with the Elastic stack, you can refer to:\n- [How to set up the necessary Elastic stack](docs/Elastic_Stack_Installation/README.md).\n\nIf you are good with setting up the Elastic stack, and you want to know how to use these accelerators, check the following documents (with the following order):\n1. [How to use the Elasticsearch accelerators](data_storing-elasticsearch/README.md).\n2. [How to use the Logstash accelerators](data_extraction/logstash/README.md).\n3. [How to use the Kibana accelerators](data_visualization-kibana/README.md).\n\nIf you want to explore more deeply what you can take out of the OutSystems monitoring data, you can refer to:\n- [How to access OutSystems monitoring data to begin with](docs/Access-Monitoring-Data.md).\n- [Understand OutSystems monitoring data](docs/Monitoring-Data.md).\n- [Baseline metrics that OutSystems recommends to use](https://docs.google.com/spreadsheets/d/1tWQMsnxKUEGjk7-UrdKUu4X5U1koqo_M__wiigtt7g4/edit?usp=sharing)\n  - Some of these metrics are built on top of OutSystems monitoring data (logs, request events, etc)\n\n\u003cbr\u003e\n\n## How to contribute 📝\n**OutSystems Customer Success DevOps team** maintains this repository and is deeply interested in your contribution!\n- Reach us through:\n    - [OutSystems Community](https://www.outsystems.com/community/)\n    - Open an [issue](https://github.com/OutSystems/outsystems-elastic-integration/issues)\n- Make a contribution directly here on GitHub\n    - Learn [how](https://kbroman.org/github_tutorial/pages/fork.html).\n\n\u003cbr\u003e\n\n## License 📃\nOutSystems makes the contents of this repository available under the Apache License with no support, and following the same logic specified on this [notice](https://github.com/OutSystems/outsystems-pipeline/blob/master/NOTICE.md).\n\n\u003cbr\u003e\n\n## Change log\nSee the change log to learn about the latest changes and improvements to this repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutsystems%2Foutsystems-elastic-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutsystems%2Foutsystems-elastic-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutsystems%2Foutsystems-elastic-integration/lists"}