diff --git a/.github/ISSUE_TEMPLATE/integration_request.md b/.github/ISSUE_TEMPLATE/integration_request.md index a8a632924..7b7222dc1 100644 --- a/.github/ISSUE_TEMPLATE/integration_request.md +++ b/.github/ISSUE_TEMPLATE/integration_request.md @@ -16,7 +16,7 @@ Describe the integration resource log protocol you are interesting in [ [`access **What is the integration target protocol ?** -Describe the target protocol you are interested to ingest [ for example [`logs.mapping`](https://github.com/opensearch-project/opensearch-catalog/blob/main/schema/observability/logs/logs.mapping) , [`http.mapping`](https://github.com/opensearch-project/opensearch-catalog/blob/main/schema/observability/logs/http.mapping) ] +Describe the target protocol you are interested to ingest [ for example [`logs.mapping`](https://github.com/opensearch-project/opensearch-catalog/blob/c40d1e87199528d3853c0c3fa308524c76ac6c2c/schema/observability/logs/logs-1.0.0.mapping) , [`http.mapping`](https://github.com/opensearch-project/opensearch-catalog/blob/c40d1e87199528d3853c0c3fa308524c76ac6c2c/schema/observability/logs/http-1.0.0.mapping) ] **Which agents would you use to ship this data ?** diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 000000000..a8e98eb93 --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,3 @@ +opensearch-dashboards +kubernetes.default.svc.cluster.local +observability.playground.opensearch.org diff --git a/README.md b/README.md index fa98f08fa..a3797d6bd 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Observability is collection of plugins and applications that let you visualize d [cypress-test-badge]: https://img.shields.io/badge/Cypress%20tests-in%20progress-yellow [cypress-test-link]: https://github.com/opensearch-project/opensearch-build/issues/1124 [cypress-code-badge]: https://img.shields.io/badge/Cypress%20code-blue -[cypress-code-link]: https://github.com/opensearch-project/dashboards-observability/blob/main/dashboards-observability/.cypress/CYPRESS_TESTS.md +[cypress-code-link]: https://github.com/opensearch-project/dashboards-observability/blob/main/.cypress/CYPRESS_TESTS.md [opensearch-it-badge]: https://img.shields.io/badge/OpenSearch%20Plugin%20IT%20tests-in%20progress-yellow [opensearch-it-link]: https://github.com/opensearch-project/opensearch-build/issues/1124 [opensearch-it-code-badge]: https://img.shields.io/badge/OpenSearch%20IT%20code-blue diff --git a/public/components/notebooks/docs/dev/Build_Documentation.md b/public/components/notebooks/docs/dev/Build_Documentation.md index 9af178571..87afb3baa 100644 --- a/public/components/notebooks/docs/dev/Build_Documentation.md +++ b/public/components/notebooks/docs/dev/Build_Documentation.md @@ -2,12 +2,8 @@ ## Setup OpenSearch & OpenSearch Dashboards dev environment and use the plugin with Zeppelin -- Please follow [README.md](../../../../../../DEVELOPER_GUIDE.md) for build instructions. +- Please follow [README.md](../../../../../DEVELOPER_GUIDE.md) for build instructions. -- **[Optional] If using Zeppelin Backend Adaptor:** - - Setup Zeppelin as mentioned in [Apache Zeppelin Setup: Zeppelin Backend Adaptor](./Zeppelin_backend_adaptor.md#apache-zeppelin-setup) - - Edit [this line](https://github.com/opensearch-project/dashboards-notebooks/blob/dev/common/index.ts#L19) to `SELECTED_BACKEND = 'ZEPPELIN';` - - Edit [this line](https://github.com/opensearch-project/dashboards-notebooks/blob/dev/common/index.ts#L21) for adding Zeppelin endpoint `zeppelinURL = 'http://localhost:8080';` - Start OpenSearch Dashboards - More on [Usage of Plugin](./Usage_Documentation.md) diff --git a/public/components/notebooks/docs/dev/OpenSearch-Dashboards-Notebooks-Design-Proposal.md b/public/components/notebooks/docs/dev/OpenSearch-Dashboards-Notebooks-Design-Proposal.md index b9bd9050e..e4b5b8b7f 100644 --- a/public/components/notebooks/docs/dev/OpenSearch-Dashboards-Notebooks-Design-Proposal.md +++ b/public/components/notebooks/docs/dev/OpenSearch-Dashboards-Notebooks-Design-Proposal.md @@ -138,7 +138,7 @@ OpenSearch Dashboards Notebooks enable data-driven, interactive data analytics a - Zeppelin Backend will provide one stop shop for interpreters, runtime-environments and storage adaptors - Cons: - Users will not be free to customize Zeppelin Backend runtime-environment/storage adaptors - - Need to develop a new storage adaptor for Zeppelin to store notebooks as OpenSearch indices [POC details](../poc/docs/Zeppelin_OpenSearch_Storage.md) + - Need to develop a new storage adaptor for Zeppelin to store notebooks as OpenSearch indices - Difficult to maintain releases, as we have to sync version currency/patches to Zeppelin code repository **4.4.2 Version 2:** In this architecture, Backends are switchable with two options of Default backend (Markdown, Visualization support) or Apache Zeppelin Backend (25+ interpreter support) @@ -200,7 +200,6 @@ OpenSearch Dashboards Notebooks enable data-driven, interactive data analytics a 3. Once a backend service is connected all the interpreters, environments and data sources provided by the service are automatically extended in notebooks 4. Uses [Hapi Wreck](https://hapi.dev/module/wreck/) to connect a backend service with a HTTP endpoint 5. Example Adaptor: **Zeppelin Backend Server** - ![Zeppelin Server](images/zeppelin_architecture.png) - Open source, provided by [Apache Zeppelin](http://zeppelin.apache.org/) - Provides all communication to and from a notebook & supports 25+ interpreters - Connects via a HTTP endpoint to the Plugin backend @@ -242,9 +241,7 @@ OpenSearch Dashboards Notebooks enable data-driven, interactive data analytics a ### **7.1** POC: [Embeddable API & Usage](../poc/docs/OpenSearch Dashboards_Embeddable_Documentation.md) -### **7.2** POC: [Zeppelin OpenSearch Storage](../poc/docs/Zeppelin_OpenSearch_Storage.md) - -### **7.3** Screenshots: +### **7.2** Screenshots: - **Default Backend** @@ -273,6 +270,4 @@ OpenSearch Dashboards Notebooks enable data-driven, interactive data analytics a ## 8. References -### **8.1** [More Zeppelin and Backend Adaptor](Zeppelin_backend_adaptor.md) - -### **8.2** [Nteract.io](https://nteract.io/) React components: [components.nteract.io](https://components.nteract.io/) +### **8.1** [Nteract.io](https://nteract.io/) React components: [components.nteract.io](https://components.nteract.io/) diff --git a/public/components/notebooks/docs/dev/Usage_Documentation.md b/public/components/notebooks/docs/dev/Usage_Documentation.md index c4fc7a3fa..dc6f25203 100644 --- a/public/components/notebooks/docs/dev/Usage_Documentation.md +++ b/public/components/notebooks/docs/dev/Usage_Documentation.md @@ -36,5 +36,5 @@ NOTE: Please select a paragraph before using these buttons ## Import Example Notebooks -- Import sample notebooks from [example_notebooks folder](https://github.com/opensearch-project/dashboards-notebooks/tree/dev) based on your backend +- Import sample notebooks from [example_notebooks folder](https://github.com/opensearch-project/dashboards-observability/tree/1944d0b7de350de01b31c894868ab05165ad25bc/public/components/notebooks/docs/example_notebooks) based on your backend - A notebook from one backend is incompatible to the other diff --git a/server/adaptors/integrations/__data__/repository/amazon_elb/info/INGESTION.md b/server/adaptors/integrations/__data__/repository/amazon_elb/info/INGESTION.md index 459b2806d..8f67f2c38 100644 --- a/server/adaptors/integrations/__data__/repository/amazon_elb/info/INGESTION.md +++ b/server/adaptors/integrations/__data__/repository/amazon_elb/info/INGESTION.md @@ -10,7 +10,7 @@ This is a brief overview of a sample ingestion pipeline for the AWS ELB integrat ### OpenSearch and FluentBit Setup -1. Look at [docker-compose.yaml](<[docker-compose.yaml](https://github.com/opensearch-project/data-prepper/blob/93d06db5cad280e2e4c53e12dfb47c7cbaa7b364/examples/log-ingestion/docker-compose.yaml)https://github.com/opensearch-project/data-prepper/blob/93d06db5cad280e2e4c53e12dfb47c7cbaa7b364/examples/log-ingestion/docker-compose.yaml>) to create FluentBit and OpenSearch Docker images and run them in the `opensearch-net` Docker network. +1. Look at [docker-compose.yaml](https://github.com/opensearch-project/data-prepper/blob/d2aa114f538da2f05d887b9c1ad4b77486267776/examples/log-ingestion/docker-compose.yaml) to create FluentBit and OpenSearch Docker images and run them in the `opensearch-net` Docker network. 2. Create the FluentBit as follows: ``` diff --git a/server/adaptors/integrations/__data__/repository/amazon_elb/info/README.md b/server/adaptors/integrations/__data__/repository/amazon_elb/info/README.md index b3affc411..ef3505b6b 100644 --- a/server/adaptors/integrations/__data__/repository/amazon_elb/info/README.md +++ b/server/adaptors/integrations/__data__/repository/amazon_elb/info/README.md @@ -28,4 +28,4 @@ AWS ELB access logs integration includes dashboards, visualisations, queries and ### Dashboard -dashboard1 +![ELB Dashboard](../static/dashboard1.png) diff --git a/server/adaptors/integrations/__data__/repository/amazon_rds/assets/README.md b/server/adaptors/integrations/__data__/repository/amazon_rds/assets/README.md index 36fac9aea..ba1094c71 100644 --- a/server/adaptors/integrations/__data__/repository/amazon_rds/assets/README.md +++ b/server/adaptors/integrations/__data__/repository/amazon_rds/assets/README.md @@ -1,6 +1,6 @@ # AWS RDS Integration Assets -API: http://osd:5601/api/saved_objects/_import?overwrite=true +API: http://opensearch-dashboards:5601/api/saved_objects/_import?overwrite=true - [Assets](aws_rds-1.0.0.ndjson) diff --git a/server/adaptors/integrations/__data__/repository/amazon_rds/info/README.md b/server/adaptors/integrations/__data__/repository/amazon_rds/info/README.md index 9c087f6c6..a33a6a5bc 100644 --- a/server/adaptors/integrations/__data__/repository/amazon_rds/info/README.md +++ b/server/adaptors/integrations/__data__/repository/amazon_rds/info/README.md @@ -24,6 +24,6 @@ AWS RDS integration includes dashboards, visualizations, queries, and index mapp The Dashboard uses the index alias `logs-aws-rds` for shortening the index name - be advised. -![](../static/dashboard_rds1.png) +![](../static/dashboard.png) This integration provides you with a comprehensive view of your RDS instances, enabling you to monitor performance and resources effectively, troubleshoot problems quickly, and make data-driven decisions. diff --git a/server/adaptors/integrations/__data__/repository/amazon_s3/info/README.md b/server/adaptors/integrations/__data__/repository/amazon_s3/info/README.md index b91fbf4c2..e0bf6afee 100644 --- a/server/adaptors/integrations/__data__/repository/amazon_s3/info/README.md +++ b/server/adaptors/integrations/__data__/repository/amazon_s3/info/README.md @@ -16,4 +16,4 @@ AWS S3 integration includes dashboards, visualizations, queries, and an index ma The Dashboard uses the index alias `logs-aws-s3` for shortening the index name - be advised. -![AWS S3 Dashboard](../static/dashboard_s3.png) +![AWS S3 Dashboard](../static/dashboard.png) diff --git a/server/adaptors/integrations/__data__/repository/amazon_vpc_flow/assets/README.md b/server/adaptors/integrations/__data__/repository/amazon_vpc_flow/assets/README.md index fb5ff8ce8..52f039965 100644 --- a/server/adaptors/integrations/__data__/repository/amazon_vpc_flow/assets/README.md +++ b/server/adaptors/integrations/__data__/repository/amazon_vpc_flow/assets/README.md @@ -1,6 +1,6 @@ # AWS VPC Flow Logs Integration Assets -API: http://osd:5601/api/saved_objects/_import?overwrite=true +API: http://opensearch-dashboards:5601/api/saved_objects/_import?overwrite=true - [Assets](aws_vpc_flow-1.0.0.ndjson) diff --git a/server/adaptors/integrations/__data__/repository/otel-services/info/DemoLandingPage.md b/server/adaptors/integrations/__data__/repository/otel-services/info/DemoLandingPage.md index 1669e5623..f1c17249e 100644 --- a/server/adaptors/integrations/__data__/repository/otel-services/info/DemoLandingPage.md +++ b/server/adaptors/integrations/__data__/repository/otel-services/info/DemoLandingPage.md @@ -12,23 +12,14 @@ The purpose of this demo is to demonstrate the different capabilities of OpenSea ### Services [OTEL DEMO](https://opentelemetry.io/docs/demo/services/) Describes the list of services that are composing the Astronomy Shop. -The main services that are open to user interactions: +The main service is open to user interactions: - [Dashboards](https://observability.playground.opensearch.org/) -- [Demo Proxy](https://observability.playground.demo-proxy.opensearch.org/) - -- [Demo loader](https://observability.playground.demo-loader.opensearch.org/) - -- [Demo feature-flag](https://observability.playground.demo-feature-flag.opensearch.org/) - ### Screenshots _**The shopping App**_ ![](https://opentelemetry.io/docs/demo/screenshots/frontend-1.png) -_**The feature flag**_ -![](https://opentelemetry.io/docs/demo/screenshots/feature-flag-ui.png) - _**The load generator**_ ![](https://opentelemetry.io/docs/demo/screenshots/load-generator-ui.png)