Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent OpenSearch, OpenSearch Dashboards, and Amazon OpenSearch Service Usage #637

Conversation

dlvenable
Copy link
Member

@dlvenable dlvenable commented Nov 22, 2021

Description

Updated the documentation to use OpenSearch, OpenSearch Dashboard, and Amazon OpenSearch Service.

Some scripts, Docker compose files, and other automation is still not updated to use OpenSearch. For these scenarios, I left the OpenDistro text in place.

Issues Resolved

Resolves #638

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…e consistently in Data Prepper documentation.

Signed-off-by: David Venable <[email protected]>
@dlvenable dlvenable requested a review from a team as a code owner November 22, 2021 22:11
@dlvenable dlvenable linked an issue Nov 22, 2021 that may be closed by this pull request
@dlvenable dlvenable merged commit 1295242 into opensearch-project:1.2 Nov 23, 2021
Copy link
Member

@sbayer55 sbayer55 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some references to Kibana were replaced with OpenSearch Dashboards but not all. Is replacing Kibana in scope for this PR? If not we should open an issue for it.

user must do in order to solve a problem in production, we will achieve this through a set of Application Performance Management (APM) features.
As the first step, in 2020 we will offer Trace Analytics, which will allow users to store trace information and provide them a holistic view of their
service under observation.

## 2. Approach
The Trace Analytics feature will embrace the Open Telemetry standard and provide the required plugins and adapters to integrate with the ecosystem.
Adoption to the OpenTelemetry ecosystem will benefit users of existing tracing standards like Zipkin and OpenTracing to use the Trace Analytics feature.
To support the trace analytics feature we will build a new service called Data Prepper, which receives trace data from the OpenTelemetry collector, process them to Elasticsearch friendly docs, and stores them in users' elasticsearch cluster. The trace analytics will also provide a Kibana plugin that will provide user-friendly dashboards on the stored trace data.
To support the trace analytics feature we will build a new service called Data Prepper, which receives trace data from the OpenTelemetry collector, process them to OpenSearch friendly docs, and stores them in users' OpenSearch cluster. The trace analytics will also provide an OpenSearch Dashboards plugin that will provide user-friendly dashboards on the stored trace data.

![Kibana Notebooks Architecture](images/HighLevelDesign.jpg)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace Kibana with OpenSearch Dashboards


These two indices mentioned above will be used by the Kibana plugin to provide the following instant dashboards,
These two indices mentioned above will be used by the OpenSearch Dashboards plugin to provide the following instant dashboards,

![Kibana Notebooks Architecture](images/DashboardView.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace Kibana

@@ -83,7 +83,7 @@ These two indices mentioned above will be used by the Kibana plugin to provide t
![Kibana Notebooks Architecture](images/ServiceView.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace Kibana

sbayer55 pushed a commit to sbayer55/data-prepper that referenced this pull request Nov 23, 2021
…e consistently in Data Prepper documentation. (opensearch-project#637)

Signed-off-by: David Venable <[email protected]>
@dlvenable dlvenable mentioned this pull request Nov 24, 2021
1 task
@dlvenable dlvenable deleted the opensearch-consistency-documentation branch November 29, 2021 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Documentation to use OpenSearch
3 participants